ICatchment Interface |
Interface to Rainfall Runoff catchments. Specific catchments can inherit from the
abstract Catchment class instead of implementing this interface directly.
Namespace: DHI.Mike1D.RainfallRunoffModule
Assembly: DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 16.0.0.0 (11.1.1.1111)
SyntaxC#
public interface ICatchment : IDoubleTimeProxy
The ICatchment type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Area |
Total area of catchment
Unit: [m2]
|
| CatchmentGeometry |
Get and set the list of coordinates of the catchment
|
| CatchmentName |
Catchment name.
The name is not unique, there may be several catchment models for one catchment, however all catchments with the same name should/must share the same catchment geometry. |
| CenterPoint |
Get and set the central point of the catchment
|
| CurrentTime |
Return the time of the current state.
|
| MinTime |
Minimum time to which Time can be set. The catchment must caches values from MinTime to the
max value of Time.
|
| ModelId |
Catchment model ID. Unique id.
|
| Name | Obsolete.
Same as ModelId - for backward compatibility.
|
| ObservedData |
Observed data. Used for creating calibration plots and for auto-calibration reference data.
|
| TimeStep |
Time step op catchment
|
| TSBuffer |
Set the TSBuffer to use in this catchment
|
| YearlyRunoff |
Return dictionary of runoff as a function of year
|
Methods| Name | Description | |
|---|---|---|
 | Initialize |
Initialize Rainfall Runoff model. Sets up static data.
|
| PerformTimeStep |
This procedure forwards the calculation with one time step.
|
| Prepare |
Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.
|
| ResetBoundaries |
Remove boundaries applied in previous runs
|
| TimeAccepts |
List of data types that is accepted and can be used in SetValue
(Inherited from IDoubleTimeProxy.) |
| TimeOffers |
List of data types that is offered and can be used in GetValue
(Inherited from IDoubleTimeProxy.) |
| TimeOfNextUpdate |
Return the time of next update. Used for PostTimeStepEvent event in Catchments.
|
| TimeValueGetter(IQuantity) |
Get value setter for the specified data quantity
(Inherited from IDoubleTimeProxy.) |
| TimeValueGetter(IQuantity, IQuantity) |
Get value setter for the specified data quantity
(Inherited from IDoubleTimeProxy.) |
| TimeValueSetter |
Get value setter for the specified data type
(Inherited from IDoubleTimeProxy.) |
| Type |
Type of model used in catchment
|
| Update |
This procedure forwards the calculation such that the state includes the specified time
|
Events| Name | Description | |
|---|---|---|
 | PostTimeStepEvent |
An event that is called everytime a timestep was successfully performed.
|
See Also