CatchmentKinematicWave Methods |
The CatchmentKinematicWave type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ApplyBoundary(ICatchmentSourceBoundary) |
Apply a boundary to this catchment
(Inherited from CatchmentAbstractUrban.) |
| ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply a boundary to this catchment
(Inherited from CatchmentAbstractUrban.) |
 | 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.) |
| ApplySnowModule |
Apply snow module if activated, and update _actRainDepth.
(Inherited from CatchmentAbstractUrban.) |
| 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 on catchment.
TODO: Consider moving this to individual catchments to increase performance (avoid using _stateVariables).
TODO: Consider moving this out of Catchments class and into seperate class, for generic handling of all catchments
(Overrides CatchmentAbstractUrbanCalculateStatistics.) |
| CalculateYearlyStatistics |
Update the yearly statistics.
(Inherited from CatchmentAbstractUrban.)Called at end of every time step. |
| CreateOffersBase |
Create offers, populating _offers and _offerDelegates (Inherited from CatchmentAbstractUrban.) |
| 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
(Inherited from CatchmentAbstractUrban.) |
| GetSurfaceData |
Getter returning data that vary with each surface type.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| 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 CatchmentAbstractUrbanPrepare(RRParameters, IDiagnostics).) |
| PrepareSource |
Prepare boundary source.
(Inherited from Catchment.) |
| PrepareState |
Prepare state, especially 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
The only update in the subcatchment that requires this to be called, is when the [!:CatchmentSurface.Runoff] is updated. |
| TakeTimeStep |
Run the rainfall runoff model for the time step ending at the given time.
(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 CatchmentAbstractUrban.) |
| TimeValueSetter |
Get value setter for the specified data type
(Inherited from Catchment.) |
| ToString | Returns a string that represents the current object. (Inherited from Catchment.) |
| TransferStateToOldBase |
Transfer current state to state N. First thing to do when starting a timestep.
(Inherited from CatchmentAbstractUrban.) |
| 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.) |
| Validate |
Validate that the catchment is set up correctly
(Overrides CatchmentValidate.) |
| ValidateLIDs |
Validate all LIDs in catchment
(Inherited from Catchment.) |
| VolumeInCatchment |
Volume of water stored in catchment after previous TakeTimeStep()
(Overrides CatchmentVolumeInCatchment.) |
| VolumeInCatchmentAtStart |
Volume of water stored in catchment after previous TakeTimeStep()
(Inherited from Catchment.) |
See Also