| Accepts | (Inherited from Catchment) |
| AddToOffers | (Inherited from Catchment) |
| ApplyBoundary(ICatchmentSourceBoundary) |
Apply a boundary to this catchment
(Inherited from Catchment) |
| ApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource) |
Apply source boundary to the catchment. The boundary will be set depending on the type.
It will throw an exception if type in not correct or if Discharge type is used.
If a boundoary source is already set, it will be overridden. (Overrides CatchmentApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource)) |
| ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply boundary for Global source boundary type
(Overrides CatchmentApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)) |
| ApplyBoundaryLIDs(GlobalGeoLocatedSource) |
Apply boundary to LID's in catchment
(Inherited from Catchment) |
| ApplyBoundaryLIDs(ICatchmentSourceBoundary) |
Apply boundary to LID's in catchment
(Inherited from Catchment) |
| ApplyBoundaryLIDs(CatchmentSourceBoundaryTypes, IBoundarySource) |
Apply boundary to LID's in catchment
(Inherited from Catchment) |
| ApplyBoundaryLIDs(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply boundary to LID's in catchment
(Inherited from Catchment) |
| BoundaryTypeIsAdditive |
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) |
| CalcInitialGWDepthFromBaseflow | Calculates an initial ground water depth from a base flow |
| CalcInitialOverlandFirstReservoirStorageFromFlow | Calculate initial OverLandFirstReservoirStorage from OverLandFirstReservoirFlow (and OverLandOutflow), i.e. these must be set first. |
| CalcInitialOverlandSecondReservoirStorageFromFlow | Calculate initial OverLandSecondReservoirStorage from OverLandOutflow (and OverLandFirstReservoirFlow), i.e. these must be set first. |
| CalcTimeConstantFirstReservoir | This functione returns the final time constant needed to route overland flow through the first linear reservoir. Unit: [hour] |
| CalcTimeConstantSecondReservoir | This functione returns the final time constant needed to route overland flow through the second linear reservoir. Unit: [hour] |
| CalculateGwDepthForZeroBaseFlow | This routine finds the ground water depth at which there is zero base flow. This depth can be either constant or vary through out the year. |
| CalculateStatistics |
Calculate statistics.
Called at end of each time step, by PerformTimeStep (Overrides CatchmentStateCalculateStatistics) |
| CreatePeriodicStat |
Creates and instance of statistics for a period.
(Overrides CatchmentCreatePeriodicStat) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Destructor
(Inherited from Catchment) |
| FinalizeTimeStep | Finalizes the time step for the catchment. (Overrides CatchmentFinalizeTimeStep) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPeriodicStat |
Get or create a RRYearlyStat object for the specified period.
(Inherited from Catchment) |
| GetRequiredTypes |
Returns a list of CatchmentSourceBoundaryTypes that need to be set.
The list will always contains Rainfall and Evaporation if they have not been set yet.
The list should be empty when this is called for M11, because the
source boundaries have already been set.
(Overrides CatchmentGetRequiredTypes) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize |
Initialize Rainfall Runoff model. Sets up static data.
(Overrides CatchmentInitialize(IDiagnostics)) |
| InitializePlugins |
Initializes the cathcment plugins.
(Inherited from Catchment) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Offers |
List of data types that is offered and can be used in GetValue
(Inherited from Catchment) |
| PerformTimeStep |
This procedure forwards the calculation with one time step.
(Inherited from Catchment) |
| Prepare |
Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.
(Overrides CatchmentPrepare(DateTime, DateTime, RRParameters, IDiagnostics)) |
| PrepareForTimeStep |
This procedure forwards the NAM calculation with one time step.
(Overrides CatchmentPrepareForTimeStep) |
| PreparePlugins |
Prepares the cathcment plugins.
(Inherited from Catchment) |
| PrepareSource |
Prepare boundary source.
(Inherited from Catchment) |
| PrepareState |
Prepare state for new simulation.
(Inherited from CatchmentState) |
| ReadBufferState |
Read current state of catchment value buffer
(Inherited from Catchment) |
| ReadPluginStates |
Read current state of plugins
(Inherited from Catchment) |
| ReadState | Read state and apply to module. Returns true if state was successfully read. |
| Reset |
Reset the catchment and set the current time.
(Inherited from Catchment) |
| ResetBoundaries |
Remove boundaries applied in previous runs
(Inherited from Catchment) |
| StateUpdated |
When state has been updated, this method can be called to update derived/computational variables
(Overrides CatchmentStateStateUpdated) |
| TakeTimeStep |
This procedure is the one actually calculating the new time step.
(Inherited from Catchment) |
| TimeOffers |
List of data types that is offered and can be used in GetValue
(Inherited from Catchment) |
| TimeOfNextUpdate |
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) |
| TimeValueGetter |
Get value getter for the specified data quantity
(Inherited from Catchment) |
| ToString | Returns a string that represents the current object. (Inherited from Catchment) |
| TransferToStateVariableTable |
This routine stores the calculated variables in variables ready for export. The values in these state variable
corresponds to the values written to the result file. All discharge variables are subject to a unit conversion.
During the calculation discharges are calculated using the unit mm/hour and must therefor be converted into m3/s.
(Overrides CatchmentStateTransferToStateVariableTable) |
| TriggerPostTimeStepEvent |
Trigger the PostTimeStepEvent, called at end of a time step.
(Inherited from Catchment) |
| Type |
The type of catchment: NAM, Urban A etc
(Overrides CatchmentType) |
| Update |
Update internal state of catchment to time Time()
(Inherited from Catchment) |
| UpdateCheckPointTime |
Updates check point time.
(Inherited from Catchment) |
| UpdateRouting | Updates the routing for the catchment. (Overrides CatchmentUpdateRouting) |
| UpdateRunoffMinMaxStatistics |
Update time and values of minimum/maximum flow.
(Inherited from Catchment) |
| UpdateStorage | Updates the storage for the catchment. (Overrides CatchmentUpdateStorage) |
| UpdateTime |
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) |
| UpdateTimeStepUsingCheckPoint |
Updates the present time if it is greater than the check point time.
(Inherited from Catchment) |
| Validate |
Validate that the catchment is set up correctly
(Overrides CatchmentValidate) |
| Validate(IDiagnostics, Boolean) | Check that the NAM catchment has been properly initialised To be called at the end of Initialize() using isInitializing true. Validate() is called before Initialize() |
| ValidateLIDs |
Validate all LIDs in catchment
(Inherited from Catchment) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from Catchment) |
| ValueSetter | (Inherited from Catchment) |
| VolumeInCatchment |
Volume of water stored in catchment after previous time step.
(Overrides CatchmentVolumeInCatchment) |
| VolumeInCatchmentAtStart |
Volume of water stored in catchment after previous time step.
(Overrides CatchmentVolumeInCatchmentAtStart) |
| WriteBufferState |
Write current state of catchment value buffer
(Inherited from Catchment) |
| WritePluginStates |
Write current state of plugins
(Inherited from Catchment) |
| WriteState | Write current state of module |