CatchmentUHM Methods |
The CatchmentUHM type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ApplyBoundary(ICatchmentSourceBoundary) |
Apply a boundary to this catchment
(Overrides CatchmentApplyBoundary(ICatchmentSourceBoundary).) |
| ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply a boundary to this catchment
(Overrides CatchmentApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource).) |
 | ApplyBoundaryLIDs(ICatchmentSourceBoundary) |
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.) |
| CalculateStatistics |
Calculate statistics.
(Inherited from CatchmentState.)Called at end of each time step, by PerformTimeStep |
| CalculateYearlyStatistics |
Calculate and update yearly statistics, YearlyRunoff.
(Inherited from CatchmentState.)Called at end of each time step, in PerformTimeStep |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Destructor
(Inherited from Catchment.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetRequiredTypes |
Get the type of boundary required by this catchment
(Overrides CatchmentGetRequiredTypes.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitialiseStateVariableTable |
This procedure initializes all the state variables declared for the catchment.
(Inherited from CatchmentState.) |
| Initialize |
Initialize Rainfall Runoff model. Sets up static data.
(Overrides CatchmentInitialize(IDiagnostics).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| 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(RRParameters, IDiagnostics).) |
| PrepareSource |
Prepare boundary source.
(Inherited from Catchment.) |
| PrepareState |
Prepare state for new simulation.
(Inherited from CatchmentState.) |
| 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
|
| TakeTimeStep |
Take an UHM rainfall runoff time step
(Overrides CatchmentTakeTimeStep.) |
| TimeAccepts |
List of data types that is accepted and can be used in SetValue
(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(IQuantity) |
Get value setter for the specified data quantity
(Inherited from Catchment.) |
| TimeValueGetter(IQuantity, IQuantity) |
Get value setter for the specified data quantity
(Inherited from Catchment.) |
| TimeValueGetterRR |
Get value setter for the specified data quantity
(Inherited from CatchmentState.) |
| TimeValueSetter |
Get value setter for the specified data type
(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 CatchmentState.) |
| Validate |
Validate the UHM runoff model
(Overrides CatchmentValidate.) |
| ValidateLIDs |
Validate all LIDs in catchment
(Inherited from Catchment.) |
| VolumeInCatchment |
Volume of water stored in catchment after previous TakeTimeStep()
(Inherited from Catchment.) |
| VolumeInCatchmentAtStart |
Volume of water stored in catchment after previous TakeTimeStep()
(Inherited from Catchment.) |
See Also