CatchmentState Properties |
The CatchmentState type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AdditionalFlow |
Additional constant flow added to the total runoff
Unit: [m3/s]
Default: 0
(Inherited from Catchment.) |
| Area |
Total area of catchment
Type: Catchment area
Unit: [m2]
Default: 1e8 (100 km2)
(Inherited from Catchment.) |
 | AreaInSquareKm |
Full area of catchment
Type: Catchment area
Unit: [km2]
Default: 100
(Inherited from Catchment.) |
| CatchmentGeometry |
Get and set the list of coordinates of the catchment
(Inherited from Catchment.) |
| CatchmentName |
Catchment name.
(Inherited from Catchment.)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
(Inherited from Catchment.) |
| ComponentSources |
A Component Source provides info on concentration of various
components.
(Inherited from Catchment.) |
| CurrentTime |
Current time of catchment
(Inherited from Catchment.) |
| EffectiveArea |
Effective area. The effective area is the area that collects water.
Can be smaller than total area, eg for Linear Reservoir or when LIDs are present.
(Inherited from Catchment.) |
| EndTime |
End time of catchment data - the latest time for which the catchment can return data
(Inherited from Catchment.) |
| MaximumFlow |
Maximum runoff flow
(Inherited from Catchment.) |
| MinimumFlow |
Minimum runoff flow
(Inherited from Catchment.) |
| MinTime |
Minimum time the catchment should be able to provide values. The catchment will cache
or recalculate values from MinTime to EndTime. MinTime must be updated ("dragged behind"
time of calculation) from the caller to allow the catchment to discard cached values.
(Inherited from Catchment.) |
| ModelId |
Catchment model ID. Unique id.
(Inherited from Catchment.) |
| Name | Obsolete. (Inherited from Catchment.) |
| ObservedData |
Observed data. Used for creating calibration plots and for auto-calibration reference data.
(Inherited from Catchment.) |
| Persons |
Number of person equivalent in the catchment,
used with catchment discharge source boundary
(Inherited from Catchment.) |
| RuntimeDiagnostics |
Get the Diagnostics instance for a Catchment. Used during runtime.
(Inherited from Catchment.) |
| StartTime |
Start time of catchment data - the earliest time for which the catchment can return data
(Inherited from Catchment.) |
| StormWaterLIDs |
List of Lids
(Inherited from Catchment.) |
| TimeOfMaximumFlow |
Time of minimum runoff flow
(Inherited from Catchment.) |
| TimeOfMinimumFlow |
Time of maximum runoff flow
(Inherited from Catchment.) |
| TimeStep |
Time step used by the catchment model
(Inherited from Catchment.) |
| TotalAdditionalInflowVolume |
Total volume of additional inflow
(Inherited from Catchment.) |
| TotalLossVolume |
Total infiltration into this catchment (integrated over time)
(Inherited from Catchment.) |
| TotalRainfallVolume |
Total rainfall on this catchment (integrated over time)
(Inherited from Catchment.) |
| TotalRunoffVolume |
Total runoff from this catchment (integrated over time)
(Inherited from Catchment.) |
| TSBuffer |
Set the TSBuffer to use in this catchment
(Inherited from Catchment.) |
| UseHotStartFile |
Flag telling if initial conditions is taken from a hotstart file
Default: false
(Inherited from Catchment.) |
| YearlyRunoff |
Return dictionary of runoff as a function of year
(Inherited from Catchment.) |
See Also