Click or drag to resize

CatchmentTimeArea Properties

The CatchmentTimeArea type exposes the following members.

Properties
  NameDescription
Public propertyAdditionalFlow
Additional constant flow added to the total runoff Unit: [m3/s] Default: 0
(Inherited from Catchment.)
Public propertyAllowTimeStepJump
Parameter that allows or not to advance the time during dry period.
Public propertyArea
Total area of catchment Type: Catchment area Unit: [m2] Default: 1e8 (100 km2)
(Inherited from Catchment.)
Protected propertyAreaInSquareKm
Full area of catchment Type: Catchment area Unit: [km2] Default: 100
(Inherited from Catchment.)
Public propertyBoundarySourceEvaporation
Evaporation boundary
(Inherited from CatchmentAbstractUrban.)
Public propertyCatchmentGeometry
Get and set the list of coordinates of the catchment
(Inherited from Catchment.)
Public propertyCatchmentName
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.

(Inherited from Catchment.)
Public propertyCells
List of CatchmentTimeAreaCell sorted from downstream to upstream. Created during prepare
Public propertyCenterPoint
Get and set the central point of the catchment
(Inherited from Catchment.)
Public propertyComponentSources
A Component Source provides info on concentration of various components.
(Inherited from Catchment.)
Public propertyConcentrationTime
Concentration time used to defined the number of cells of this catchment. Unit: [s]
Public propertyCurrentTime
Current time of catchment
(Inherited from Catchment.)
Protected propertyEffectiveArea
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.)
Public propertyEndTime
End time of catchment data - the latest time for which the catchment can return data
(Inherited from Catchment.)
Public propertyEvaporationFromTimeSeries
True if evaporation is enabled, and an evaporation boundary has been defined.

If set to false the initial recover rate is used during dry periods. Default: False

(Inherited from CatchmentAbstractUrban.)
Public propertyGlobalDryDepthLimit
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.)
Public propertyImperviousArea
The impervious area is a factor which defines the part of the catchment considered to contribute to the runoff. Unit: [-]
Public propertyInfiltrationAfterRain
True if infiltration shall occur also after rain Default: True
(Inherited from CatchmentAbstractUrban.)
Public propertyInitialLossMax
Maximum value of InitialLossStorageDepth Unit: [m]
(Inherited from CatchmentAbstractUrban.)
Public propertyInitialLossRecoveryRate
Recovery rate for initial loss capacity. The initial loss capacity is regenerated in dry periods by a linear recovery rate.

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]

(Inherited from CatchmentAbstractUrban.)
Public propertyIntegratedHorton
True if the Integrated Horton method is used in the calculation for infiltration. Default: False
(Inherited from CatchmentAbstractUrban.)
Public propertyLoadPerInhabitant
Load per inhabitant. Unit: [-]
(Inherited from CatchmentAbstractUrban.)
Public propertyMaximumFlow
Maximum runoff flow
(Inherited from Catchment.)
Public propertyMethod
The Time Area method to be used: TimeAreaCurve corresponds to 1 TimeAreaFunction corresponds to 2
Public propertyMinimumFlow
Minimum runoff flow
(Inherited from Catchment.)
Public propertyMinTime
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.)
Public propertyModelId
Catchment model ID. Unique id.
(Inherited from Catchment.)
Public propertyName Obsolete. (Inherited from Catchment.)
Public propertyObservedData
Observed data. Used for creating calibration plots and for auto-calibration reference data.
(Inherited from Catchment.)
Public propertyPersons
Number of person equivalent in the catchment, used with catchment discharge source boundary
(Inherited from Catchment.)
Public propertyReductionFactor
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.)
Public propertyRunoff
Runoff.

Unit: [m3/s]

This is a computational variable. Setting this has no effect (apart from when writing initial value to result file)

(Inherited from CatchmentAbstractUrban.)
Public propertyRuntimeDiagnostics
Get the Diagnostics instance for a Catchment. Used during runtime.
(Inherited from Catchment.)
Public propertySnowMeltCoefficient
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.)
Public propertySnowStorage
Snow storage

State variable

Only applicable when UseSnowModule is set.

Unit: [m]

(Inherited from CatchmentAbstractUrban.)
Public propertyStartTime
Start time of catchment data - the earliest time for which the catchment can return data
(Inherited from Catchment.)
Public propertyStormWaterLIDs
List of Lids
(Inherited from Catchment.)
Public propertyTimeAreaCoefficient
Time Area curve coefficient, used by TA function
Public propertyTimeAreaCurve
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.

Public propertyTimeAreaCurveType
Time area curve type.

If set to UserDefined, the actual curve must be specified in the TimeAreaCurve table. All other values indicate predefined curves.

Public propertyTimeOfMaximumFlow
Time of minimum runoff flow
(Inherited from Catchment.)
Public propertyTimeOfMinimumFlow
Time of maximum runoff flow
(Inherited from Catchment.)
Public propertyTimeStep
Time step used by the catchment model
(Inherited from Catchment.)
Public propertyTotalAdditionalInflowVolume
Total volume of additional inflow
(Inherited from Catchment.)
Public propertyTotalLossVolume
Total infiltration into this catchment (integrated over time)
(Inherited from Catchment.)
Public propertyTotalRainfallVolume
Total rainfall on this catchment (integrated over time)
(Inherited from Catchment.)
Public propertyTotalRunoffVolume
Total runoff from this catchment (integrated over time)
(Inherited from Catchment.)
Public propertyTSBuffer
Set the TSBuffer to use in this catchment
(Inherited from Catchment.)
Public propertyUseHotStartFile
Flag telling if initial conditions is taken from a hotstart file Default: false
(Inherited from Catchment.)
Public propertyUseSnowModule
True if the snow module is activated. If True, a temperature time series has to be provided for the catchment.
(Inherited from CatchmentAbstractUrban.)
Public propertyYearlyRunoff
Return dictionary of runoff as a function of year
(Inherited from Catchment.)
Top
See Also