CatchmentLinearReservoir Properties |
The CatchmentLinearReservoir type exposes the following members.
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.) | |
BoundarySourceEvaporation |
Evaporation boundary
(Inherited from CatchmentAbstractUrban.) | |
BoundarySourceRainfall |
Rainfall boundary source
(Inherited from Catchment.) | |
CatchmentGeometry |
Get and set the list of coordinates of the catchment
(Inherited from Catchment.) | |
CatchmentName |
A overall data interface for cathcment data, containing
data properties that are common for all catchments.
(Inherited from Catchment.)This interface contains data and parameters for setting up a catchment model, and represents as such only setup data. Computational variables and methods are not included in this interface. It can be used to explore data and parameters required when setting up the catchment model. | |
CenterPoint |
Get and set the central point of the catchment
(Inherited from Catchment.) | |
CheckPoints |
A set of check points in time that must be hit by the catchments.
(Inherited from Catchment.) | |
ClientName | (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.
(Overrides CatchmentEffectiveArea.) | |
EffectiveAreaFraction |
Effective area (fraction of full area) of the catchement used by the Dutch model
Unit: [-]
| |
EffectiveTimeStep |
Time step used in the simulation, it may change. It is set initially in Prepare
to TimeStep, and can be updated by individual catchment models when required,
i.e. it may differ from TimeStep.
(Inherited from Catchment.) | |
EndTime |
Return the end time of the catchment simulation.
This is set during prepare, and the catchment must
make sure not to run beyond this time.
(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 | |
FirstReservoirOutflow |
Runoff/outflow from first reservoir.
Only active when the double linear reservoir is active, i.e. the french rural catchment.
State variable | |
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 |
Impervious area for the French model.
For an urban catchment it is also used as a factor which defines the part of the catchment considered to contribute to the runoff. Unit: [-] | |
Infiltration |
True if the infiltration process is inlcuded.
Default: False
| |
InfiltrationAfterRain |
True if infiltration shall occur also after rain
Default: True
(Inherited from CatchmentAbstractUrban.) | |
InfiltrationTime |
Time in seconds where infiltration has taken place. Grows over the entire simulation
State variable for the Dutch model, NL. | |
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] | |
InitialLossStorageDepth |
Initial loss storage depth.
(Inherited from CatchmentAbstractUrban.)State variable (not for all derived catchment models) Unit: [m] | |
LagTime |
Lag time is the reciprocal equivalent of the
linear reservoir time constant
used in model FR.
If set to 0, the linear reservoir time constant is calculated automatically.
Unit: [s]
default: 300
| |
Length |
Length of the catchment used in the Lag time calculation
if Lagtime is not given by the user.
Unit: [m]
Default: 10
| |
LoadPerInhabitant |
Load per inhabitant.
Unit: [-]
(Inherited from CatchmentAbstractUrban.) | |
MaximumFlow | Maximum runoff flow (Inherited from Catchment.) | |
MinimumFlow | Minimum runoff flow (Inherited from Catchment.) | |
MinTime | Obsolete.
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.) | |
Model |
Model type
NL model corresponds to C1
FR model corresponds to C2
| |
ModelId |
A overall data interface for cathcment data, containing
data properties that are common for all catchments.
(Inherited from Catchment.)This interface contains data and parameters for setting up a catchment model, and represents as such only setup data. Computational variables and methods are not included in this interface. It can be used to explore data and parameters required when setting up the catchment model. | |
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 |
Total runoff from catchment at present time step.
Unit: [m^3/s]
(Inherited from Catchment.) | |
RuntimeDiagnostics |
Get the Diagnostics instance for a Catchment. Used during runtime.
(Inherited from Catchment.) | |
Slope |
Slope of the catchment used in the Lag time calculation
if Lagtime is not given by the user.
Unit: [-]
Default: 0.001
| |
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 | Obsolete.
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.) | |
TimeConstant |
The linear reservoir Time constant
used in model NL
Unit: [1/s]
Default: 3e-3
| |
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.) | |
UrbanCatchment |
Flag defining if the catchment is an urban or a rural catchment.
If value is undefined, it is automatically determined.
When automatically determined, a catchment is urban when it is French (FR) and has an ImperviousArea factor larger than or equal to 0.2 | |
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.) | |
VolumeOnGroundAdded |
Volume of water added to catchment after a time step.
This water will be eventually routed.
(Inherited from Catchment.) | |
YearlyRunoff |
Return dictionary of runoff as a function of year
(Inherited from Catchment.) | |
YearlyStatistics | Dictionary of statistics as a function of year (Inherited from Catchment.) |