CatchmentKinematicWave Methods |
The CatchmentKinematicWave type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Accepts | (Inherited from Catchment.) |
| AddToOffers | (Inherited from Catchment.) |
| ApplyBoundary(ICatchmentSourceBoundary) |
Apply a boundary to this catchment
(Inherited from Catchment.) |
| ApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource) |
Apply a boundary to this catchment
(Inherited from CatchmentAbstractUrban.) |
| ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply a boundary to this catchment
(Inherited from CatchmentAbstractUrban.) |
 | 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.) |
| 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.
(Overrides CatchmentAbstractUrbanCalculateStatistics.) |
| 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.) |
| FinalizeTimeStep | Finalizes the time step for the catchment. (Overrides CatchmentFinalizeTimeStep.) |
| GetHashCode | Serves as the default hash function. (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.) |
| GetYearlyStat |
Get or create a RRYearlyStat object for the specified year.
(Inherited from Catchment.) |
| 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 CatchmentAbstractUrbanPrepare(DateTime, DateTime, RRParameters, IDiagnostics).) |
| PrepareForTimeStep | Prepares the catchment for the time step. (Overrides CatchmentPrepareForTimeStep.) |
| PreparePlugins |
Prepares the cathcment plugins.
(Inherited from Catchment.) |
| PrepareSource |
Prepare boundary source.
(Inherited from Catchment.) |
| PrepareState |
Prepare state, especially time
(Inherited from Catchment.) |
| ReadPluginStates |
Write 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 CatchmentStateUpdated.)The only update in the subcatchment that requires this to be called, is when the [!:CatchmentSurface.Runoff] is updated. |
| 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 | 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.) |
| TimeValueGetter |
Get value getter for the specified data quantity
(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.) |
| UpdateCheckPointTime |
Updates check point time.
(Inherited from Catchment.) |
| UpdateRouting | Updates the routing for the catchment. (Overrides CatchmentUpdateRouting.) |
| 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.) |
| 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.
(Inherited from Catchment.) |
| WritePluginStates |
Write current state of plugins
(Inherited from Catchment.) |
| WriteState |
Write current state of module
|
See Also