Prado EFO PVA
Public Member Functions | Public Attributes | Private Member Functions | List of all members
junction.ReservoirJunction Class Reference
Inheritance diagram for junction.ReservoirJunction:
Inheritance graph
[legend]
Collaboration diagram for junction.ReservoirJunction:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, name, time, qIn, storInit, constants, *hypso=None, ruleStack=[], evapObj=None, seepageObj=None, outletCtrl=None, outletUnctrl=None, ruleEmgc=None, storMax=None)
 
def create_ctrl_outlet (self, name, elev, qOutlet)
 
def create_unctrl_outlet (self, name, elev, qOutlet)
 
def set_ctrl_outlet (self, outletCtrl)
 
def set_unctrl_outlet (self, outletUnctrl)
 
def set_evap (self, evapObj)
 
def set_seepage (self, seepageObj)
 
def set_rule_emgc (self, ruleEmgc)
 
def set_stor_init (self, storInit)
 
def set_ruleStack (self, ruleStack)
 
def append_rule (self, rule)
 
def calc_delta (self, *ruleType=RuleComplianceBase.MAX, tsOffset=0)
 
def calc_qout (self)
 
def calc_release_ctrl (self, rlsPrev, rlsUnCtrl, storPrev, storCur, qIn)
 
- Public Member Functions inherited from junction.JunctionRegulated
def __init__ (self, name, time, qIn, ruleMinQ=None, ruleMaxQ=None, ruleDiversion=[])
 
def set_rule_minq (self, ruleMinQ)
 
def set_rule_maxq (self, ruleMaxQ)
 
- Public Member Functions inherited from junction.JunctionBase
def __init__ (self, name, time, qIn=[])
 
def append_qin (self, qIn)
 
def get_qout (self, *tsOffset=0)
 
def set_qout (self, qOutSpecified, *tsOffset=0)
 
def __subclasshook__ (cls, C)
 

Public Attributes

 ruleStack
 
 ruleEmgc
 
 storMax
 
 constants
 
 hypso
 
 stor
 
 outletCtrl
 
 rlsCtrl
 
 rlsMin
 
 rlsMax
 
 outletUnCtrl
 
 rlsUnCtrl
 
 evapObj
 
 lossEvap
 
 seepageObj
 
 lossSeep
 
- Public Attributes inherited from junction.JunctionRegulated
 ruleMinQ
 
 ruleMaxQ
 
 ruleDiversion
 
 qDiv
 
 continuity
 
- Public Attributes inherited from junction.JunctionBase
 name
 
 qIn
 
 T
 
 qOut
 
 qInTot
 

Private Member Functions

def _calc_storage (self, storPrev, qInNet, qOut)
 
def _calc_evap (self, stor, qIn)
 
def _calc_seepage (self, stor, qIn)
 
def _calc_diversions (self, stor, qIn)
 

Detailed Description

Definition at line 146 of file junction.py.

Constructor & Destructor Documentation

◆ __init__()

def junction.ReservoirJunction.__init__ (   self,
  name,
  time,
  qIn,
  storInit,
  constants,
hypso = None,
  ruleStack = [],
  evapObj = None,
  seepageObj = None,
  outletCtrl = None,
  outletUnctrl = None,
  ruleEmgc = None,
  storMax = None 
)

Definition at line 147 of file junction.py.

Member Function Documentation

◆ _calc_diversions()

def junction.ReservoirJunction._calc_diversions (   self,
  stor,
  qIn 
)
private

Definition at line 268 of file junction.py.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ _calc_evap()

def junction.ReservoirJunction._calc_evap (   self,
  stor,
  qIn 
)
private

Definition at line 250 of file junction.py.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ _calc_seepage()

def junction.ReservoirJunction._calc_seepage (   self,
  stor,
  qIn 
)
private

Definition at line 259 of file junction.py.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ _calc_storage()

def junction.ReservoirJunction._calc_storage (   self,
  storPrev,
  qInNet,
  qOut 
)
private

Definition at line 242 of file junction.py.

Here is the caller graph for this function:

◆ append_rule()

def junction.ReservoirJunction.append_rule (   self,
  rule 
)

Definition at line 219 of file junction.py.

◆ calc_delta()

def junction.ReservoirJunction.calc_delta (   self,
ruleType = RuleComplianceBase.MAX,
  tsOffset = 0 
)

Reimplemented from junction.JunctionRegulated.

Definition at line 228 of file junction.py.

Here is the call graph for this function:

◆ calc_qout()

def junction.ReservoirJunction.calc_qout (   self)

Reimplemented from junction.JunctionRegulated.

Definition at line 281 of file junction.py.

Here is the call graph for this function:

◆ calc_release_ctrl()

def junction.ReservoirJunction.calc_release_ctrl (   self,
  rlsPrev,
  rlsUnCtrl,
  storPrev,
  storCur,
  qIn 
)

Definition at line 335 of file junction.py.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ create_ctrl_outlet()

def junction.ReservoirJunction.create_ctrl_outlet (   self,
  name,
  elev,
  qOutlet 
)

Definition at line 173 of file junction.py.

Here is the call graph for this function:

◆ create_unctrl_outlet()

def junction.ReservoirJunction.create_unctrl_outlet (   self,
  name,
  elev,
  qOutlet 
)

Definition at line 178 of file junction.py.

Here is the call graph for this function:

◆ set_ctrl_outlet()

def junction.ReservoirJunction.set_ctrl_outlet (   self,
  outletCtrl 
)

Definition at line 183 of file junction.py.

Here is the caller graph for this function:

◆ set_evap()

def junction.ReservoirJunction.set_evap (   self,
  evapObj 
)

Definition at line 197 of file junction.py.

◆ set_rule_emgc()

def junction.ReservoirJunction.set_rule_emgc (   self,
  ruleEmgc 
)

Definition at line 207 of file junction.py.

◆ set_ruleStack()

def junction.ReservoirJunction.set_ruleStack (   self,
  ruleStack 
)

Definition at line 214 of file junction.py.

◆ set_seepage()

def junction.ReservoirJunction.set_seepage (   self,
  seepageObj 
)

Definition at line 202 of file junction.py.

◆ set_stor_init()

def junction.ReservoirJunction.set_stor_init (   self,
  storInit 
)

Definition at line 211 of file junction.py.

◆ set_unctrl_outlet()

def junction.ReservoirJunction.set_unctrl_outlet (   self,
  outletUnctrl 
)

Definition at line 192 of file junction.py.

Here is the caller graph for this function:

Member Data Documentation

◆ constants

junction.ReservoirJunction.constants

Definition at line 161 of file junction.py.

◆ evapObj

junction.ReservoirJunction.evapObj

Definition at line 199 of file junction.py.

◆ hypso

junction.ReservoirJunction.hypso

Definition at line 163 of file junction.py.

◆ lossEvap

junction.ReservoirJunction.lossEvap

Definition at line 200 of file junction.py.

◆ lossSeep

junction.ReservoirJunction.lossSeep

Definition at line 205 of file junction.py.

◆ outletCtrl

junction.ReservoirJunction.outletCtrl

Definition at line 185 of file junction.py.

◆ outletUnCtrl

junction.ReservoirJunction.outletUnCtrl

Definition at line 194 of file junction.py.

◆ rlsCtrl

junction.ReservoirJunction.rlsCtrl

Definition at line 187 of file junction.py.

◆ rlsMax

junction.ReservoirJunction.rlsMax

Definition at line 190 of file junction.py.

◆ rlsMin

junction.ReservoirJunction.rlsMin

Definition at line 189 of file junction.py.

◆ rlsUnCtrl

junction.ReservoirJunction.rlsUnCtrl

Definition at line 195 of file junction.py.

◆ ruleEmgc

junction.ReservoirJunction.ruleEmgc

Definition at line 156 of file junction.py.

◆ ruleStack

junction.ReservoirJunction.ruleStack

Definition at line 153 of file junction.py.

◆ seepageObj

junction.ReservoirJunction.seepageObj

Definition at line 204 of file junction.py.

◆ stor

junction.ReservoirJunction.stor

Definition at line 165 of file junction.py.

◆ storMax

junction.ReservoirJunction.storMax

Definition at line 158 of file junction.py.


The documentation for this class was generated from the following file: