Click or drag to resize

CatchmentLinearReservoir Methods

The CatchmentLinearReservoir type exposes the following members.

Methods
  NameDescription
Public methodAccepts (Inherited from Catchment.)
Public methodAddToOffers (Inherited from Catchment.)
Public methodApplyBoundary(ICatchmentSourceBoundary)
Apply a boundary to this catchment
(Inherited from Catchment.)
Public methodApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource)
Apply a boundary to this catchment
(Inherited from CatchmentAbstractUrban.)
Public methodApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)
Apply a boundary to this catchment
(Inherited from CatchmentAbstractUrban.)
Protected methodApplyBoundaryLIDs(GlobalGeoLocatedSource)
Apply boundary to LID's in catchment
(Inherited from Catchment.)
Protected methodApplyBoundaryLIDs(ICatchmentSourceBoundary)
Apply boundary to LID's in catchment
(Inherited from Catchment.)
Protected methodApplyBoundaryLIDs(CatchmentSourceBoundaryTypes, IBoundarySource)
Apply boundary to LID's in catchment
(Inherited from Catchment.)
Protected methodApplyBoundaryLIDs(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)
Apply boundary to LID's in catchment
(Inherited from Catchment.)
Protected methodApplySnowModule
Apply snow module if activated, and update _actRainDepth.
(Inherited from CatchmentAbstractUrban.)
Public methodBoundaryTypeIsAdditive
Return true if boundaries of the specified type are additive; the contributions of two discharge boundaries add up, while two temperature boundaries do not.
(Inherited from Catchment.)
Protected methodCalculateStatistics
Calculate statistics on catchment.
(Inherited from CatchmentAbstractUrban.)
Protected methodCreateOffersBase
Create offers, populating _offers and [!:_offerDelegates]
(Inherited from CatchmentAbstractUrban.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Destructor
(Inherited from Catchment.)
Protected methodFinalizeTimeStep
Finalizes the time step for the catchment.
(Overrides CatchmentFinalizeTimeStep.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetRequiredTypes
Get the type of boundary required by this catchment
(Inherited from CatchmentAbstractUrban.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodGetYearlyStat
Get or create a RRYearlyStat object for the specified year.
(Inherited from Catchment.)
Public methodInitialize
Initialize Rainfall Runoff model. Sets up static data.
(Overrides CatchmentInitialize(IDiagnostics).)
Public methodInitializePlugins
Initializes the cathcment plugins.
(Inherited from Catchment.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOffers
List of data types that is offered and can be used in GetValue
(Inherited from Catchment.)
Public methodPerformTimeStep
This procedure forwards the calculation with one time step.
(Inherited from Catchment.)
Public methodPrepare
Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.
(Overrides CatchmentAbstractUrbanPrepare(DateTime, DateTime, RRParameters, IDiagnostics).)
Protected methodPrepareForTimeStep
Prepares the catchment for the time step.
(Overrides CatchmentPrepareForTimeStep.)
Public methodPreparePlugins
Prepares the cathcment plugins.
(Inherited from Catchment.)
Protected methodPrepareSource
Prepare boundary source.
(Inherited from Catchment.)
Protected methodPrepareState
Prepare state, especially time
(Inherited from Catchment.)
Protected methodReadPluginStates
Write current state of plugins
(Inherited from Catchment.)
Public methodReadState
Read state and apply to module. Returns true if state was successfully read.
Public methodReset
Reset the catchment and set the current time.
(Inherited from Catchment.)
Public methodResetBoundaries
Remove boundaries applied in previous runs
(Inherited from Catchment.)
Public methodSetHortonInfiltration
Set the paraneters for the Horton infiltration
Public methodStateUpdated
If state has been updated from outside, call this method to recalculate state dependent parameters.
(Overrides CatchmentStateUpdated.)
Protected methodTakeTimeStep
This procedure is the one actually calculating the new time step.
(Inherited from Catchment.)
Public methodTimeOffers
List of data types that is offered and can be used in GetValue
(Inherited from Catchment.)
Public methodTimeOfNextUpdate Obsolete.
Return the time of next update. Used for PostTimeStepEvent event in Catchments. If a catchment uses variable timesteps, then this function must be overridden!!
(Inherited from Catchment.)
Public methodTimeValueGetter
Get value getter for the specified data quantity
(Inherited from Catchment.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Catchment.)
Protected methodTransferStateToOldBase
Transfer current state to state N. First thing to do when starting a timestep.
(Inherited from CatchmentAbstractUrban.)
Protected methodTriggerPostTimeStepEvent
Trigger the PostTimeStepEvent, called at end of a time step.
(Inherited from Catchment.)
Public methodType
The type of catchment: NAM, Urban A etc
(Overrides CatchmentType.)
Public methodUpdate
Update internal state of catchment to time Time()
(Inherited from Catchment.)
Protected methodUpdateCheckPointTime
Updates check point time.
(Inherited from Catchment.)
Protected methodUpdateRouting
Updates the routing for the catchment.
(Overrides CatchmentUpdateRouting.)
Protected methodUpdateStorage
Updates the storage for the catchment.
(Overrides CatchmentUpdateStorage.)
Protected methodUpdateTime
Update time, setting _timeNew to _timeOld + _effectiveTimeStep. This method will assue that _timeNew does not go beyond _endTime, by modifying _effectiveTimeStep. Before calling UpdateTime, be sure that _effectiveTimeStep is set.
(Inherited from Catchment.)
Protected methodUpdateTimeStepUsingCheckPoint
Updates the present time if it is greater than the check point time.
(Inherited from Catchment.)
Public methodValidate
Validate that the catchment is set up correctly
(Overrides CatchmentValidate.)
Protected methodValidateLIDs
Validate all LIDs in catchment
(Inherited from Catchment.)
Public methodValueGetter
Get value setter for the specified data quantity
(Inherited from Catchment.)
Public methodValueSetter (Inherited from Catchment.)
Public methodVolumeInCatchment
Volume of water stored in catchment after previous time step.
(Overrides CatchmentVolumeInCatchment.)
Public methodVolumeInCatchmentAtStart
Volume of water stored in catchment after previous time step.
(Inherited from Catchment.)
Protected methodWritePluginStates
Write current state of plugins
(Inherited from Catchment.)
Public methodWriteState
Write current state of module
Top
See Also