CatchmentTimeArea Properties |
The CatchmentTimeArea type exposes the following members.
Name | Description | |
---|---|---|
AdditionalFlow |
Additional constant flow added to the total runoff
Unit: [m3/s]
Default: 0
(Inherited from Catchment.) | |
AllowTimeStepJump |
Parameter that allows or not to advance
the time during dry period.
| |
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.) | |
BoundarySourceEvaporation |
Evaporation boundary
(Inherited from CatchmentAbstractUrban.) | |
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. | |
Cells |
List of CatchmentTimeAreaCell sorted from downstream to upstream.
Created during prepare
| |
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.) | |
ConcentrationTime |
Concentration time used to defined the number of cells of this catchment.
Unit: [s]
| |
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.) | |
EvaporationFromTimeSeries |
True if evaporation is enabled, and an evaporation boundary has been defined.
(Inherited from CatchmentAbstractUrban.)If set to false the initial recover rate is used during dry periods. Default: False | |
GlobalDryDepthLimit |
Dry depth used for switching Horton's mode between dry and wet
in Kinematic Wave model when InfiltrationAfterRain == true.
In this case the switching to regeneration of infiltration capacity
is controlled by a low limit of the water depth on the surface.
Unit: [m]
Default: 1e-6
(Inherited from CatchmentAbstractUrban.) | |
ImperviousArea |
The impervious area is a factor which defines the part
of the catchment considered to contribute to the runoff.
Unit: [-]
| |
InfiltrationAfterRain |
True if infiltration shall occur also after rain
Default: True
(Inherited from CatchmentAbstractUrban.) | |
InitialLossMax |
Maximum value of InitialLossStorageDepth
Unit: [m]
(Inherited from CatchmentAbstractUrban.) | |
InitialLossRecoveryRate |
Recovery rate for initial loss capacity.
The initial loss capacity is regenerated in dry periods by a linear recovery rate.
(Inherited from CatchmentAbstractUrban.)Used as constant evaporation, when evaporation is not defined explicitly. If evaporation is defined explicitly (see EvaporationFromTimeSeries), this is neglected. Unit: [m/s] Default: 0.00005 [m/hour] = 1.2 [mm/day] | |
IntegratedHorton |
True if the Integrated Horton method is used in the calculation
for infiltration.
Default: False
(Inherited from CatchmentAbstractUrban.) | |
LoadPerInhabitant |
Load per inhabitant.
Unit: [-]
(Inherited from CatchmentAbstractUrban.) | |
MaximumFlow |
Maximum runoff flow
(Inherited from Catchment.) | |
Method |
The Time Area method to be used:
TimeAreaCurve corresponds to 1
TimeAreaFunction corresponds to 2
| |
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.) | |
ReductionFactor |
Hydrological reduction coeeficient. The runoff reduction factor,
accounts for water losses caused by e.g evapo-transpiration,
imperfect imperviousness, etc. on the contributing area.
Unit: [-]
(Inherited from CatchmentAbstractUrban.) | |
Runoff |
Runoff.
(Inherited from CatchmentAbstractUrban.)Unit: [m3/s] This is a computational variable. Setting this has no effect (apart from when writing initial value to result file) | |
RuntimeDiagnostics |
Get the Diagnostics instance for a Catchment. Used during runtime.
(Inherited from Catchment.) | |
SnowMeltCoefficient |
Snow melt coefficient.
Note: the snow melt coefficient is not in SI unit,
because the temperature is assumed to be in degres Celcius.
Unit: [m/degCelcius/s]
(Inherited from CatchmentAbstractUrban.) | |
SnowStorage | (Inherited from CatchmentAbstractUrban.) | |
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.) | |
TimeAreaCoefficient |
Time Area curve coefficient, used by TA function
| |
TimeAreaCurve |
Time area curve, user defined, must be specified in case TimeAreaCurveType
is UserDefined.
The curve is dimensionless, time (X) values between 0 and 1 and area (Y) values between 0 and 1. | |
TimeAreaCurveType |
Time area curve type.
If set to UserDefined, the actual curve must be specified in the TimeAreaCurve table. All other values indicate predefined curves. | |
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.) | |
UseSnowModule |
True if the snow module is activated.
If True, a temperature time series has to be provided for the catchment.
(Inherited from CatchmentAbstractUrban.) | |
YearlyRunoff |
Return dictionary of runoff as a function of year
(Inherited from Catchment.) |