Catchment Properties |
The Catchment type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AdditionalFlow |
Additional constant flow added to the total runoff
Unit: [m3/s]
Default: 0
|
| Area |
Total area of catchment
Type: Catchment area
Unit: [m2]
Default: 1e8 (100 km2)
|
 | AreaInSquareKm |
Full area of catchment
Type: Catchment area
Unit: [km2]
Default: 100
|
| 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
|
| ComponentSources |
A Component Source provides info on concentration of various
components.
|
| CurrentTime |
Current time of 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.
|
| EndTime |
End time of catchment data - the latest time for which the catchment can return data
|
| MaximumFlow |
Maximum runoff flow
|
| MinimumFlow |
Minimum runoff flow
|
| 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.
|
| ModelId |
Catchment model ID. Unique id.
|
| Name | Obsolete. |
| ObservedData |
Observed data. Used for creating calibration plots and for auto-calibration reference data.
|
| Persons |
Number of person equivalent in the catchment,
used with catchment discharge source boundary
|
| RuntimeDiagnostics |
Get the Diagnostics instance for a Catchment. Used during runtime.
|
| StartTime |
Start time of catchment data - the earliest time for which the catchment can return data
|
| StormWaterLIDs |
List of Lids
|
| TimeOfMaximumFlow |
Time of minimum runoff flow
|
| TimeOfMinimumFlow |
Time of maximum runoff flow
|
| TimeStep |
Time step used by the catchment model
|
| TotalAdditionalInflowVolume |
Total volume of additional inflow
|
| TotalLossVolume |
Total infiltration into this catchment (integrated over time)
|
| TotalRainfallVolume |
Total rainfall on this catchment (integrated over time)
|
| TotalRunoffVolume |
Total runoff from this catchment (integrated over time)
|
| TSBuffer |
Set the TSBuffer to use in this catchment
|
| UseHotStartFile |
Flag telling if initial conditions is taken from a hotstart file
Default: false
|
| YearlyRunoff |
Return dictionary of runoff as a function of year
|
See Also