Click or drag to resize

CatchmentTimeArea Class

Class for Time Area catchment model. See ICatchmentTimeAreaData for parameters availabel when setting up the model.
Inheritance Hierarchy

Namespace:  DHI.Mike1D.RainfallRunoffModule
Assembly:  DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class CatchmentTimeArea : CatchmentAbstractUrban, 
	ICatchmentTimeAreaData, ICatchmentUrbanData, ICatchmentData, IModelStateReadWrite

The CatchmentTimeArea type exposes the following members.

Constructors
  NameDescription
Public methodCatchmentTimeArea
Constructor of CatchmentTimeArea
Top
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 propertyBoundarySourceRainfall
Rainfall boundary source
(Inherited from Catchment.)
Public propertyCatchmentGeometry
Get and set the list of coordinates of the catchment
(Inherited from Catchment.)
Public propertyCatchmentName
A overall data interface for cathcment data, containing data properties that are common for all catchments.

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.

(Inherited from Catchment.)
Public propertyCells
Public propertyCenterPoint
Get and set the central point of the catchment
(Inherited from Catchment.)
Public propertyCheckPoints
A set of check points in time that must be hit by the catchments.
(Inherited from Catchment.)
Public propertyClientName (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.)
Public 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 propertyEffectiveTimeStep
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.)
Public propertyEndTime
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.)
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 propertyInitialLossStorageDepth
Initial loss storage depth.

State variable (not for all derived catchment models)

Unit: [m]

(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 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.)
Public propertyModelId
A overall data interface for cathcment data, containing data properties that are common for all catchments.

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.

(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
Total runoff from catchment at present time step. Unit: [m^3/s]
(Inherited from Catchment.)
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 Obsolete.
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 propertyVolumeOnGroundAdded
Volume of water added to catchment after a time step. This water will be eventually routed.
(Inherited from Catchment.)
Public propertyYearlyRunoff
Return dictionary of runoff as a function of year
(Inherited from Catchment.)
Public propertyYearlyStatistics
Dictionary of statistics as a function of year
(Inherited from Catchment.)
Top
Methods
  NameDescription
Public methodAccepts (Inherited from Catchment.)
Public methodAddToOffers (Inherited from Catchment.)
Public methodApplyBoundary(ICatchmentSourceBoundary)
Apply a boundary to this catchment
(Inherited from Catchment.)
Public methodApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource)
Apply a boundary to this catchment
(Inherited from CatchmentAbstractUrban.)
Public methodApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)
Apply a boundary to this catchment
(Inherited from CatchmentAbstractUrban.)
Protected methodApplyBoundaryLIDs(GlobalGeoLocatedSource)
Apply boundary to LID's in catchment
(Inherited from Catchment.)
Protected methodApplyBoundaryLIDs(ICatchmentSourceBoundary)
Apply boundary to LID's in catchment
(Inherited from Catchment.)
Protected methodApplyBoundaryLIDs(CatchmentSourceBoundaryTypes, IBoundarySource)
Apply boundary to LID's in catchment
(Inherited from Catchment.)
Protected methodApplyBoundaryLIDs(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)
Apply boundary to LID's in catchment
(Inherited from Catchment.)
Protected methodApplySnowModule
Apply snow module if activated, and update _actRainDepth.
(Inherited from CatchmentAbstractUrban.)
Public methodBoundaryTypeIsAdditive
Return true if boundaries of the specified type are additive; the contributions of two discharge boundaries add up, while two temperature boundaries do not.
(Inherited from Catchment.)
Protected methodCalculateStatistics
Calculate statistics on catchment.
(Overrides CatchmentAbstractUrbanCalculateStatistics.)
Protected methodCreateOffersBase
Create offers, populating _offers and [!:_offerDelegates]
(Inherited from CatchmentAbstractUrban.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Destructor
(Inherited from Catchment.)
Protected methodFinalizeTimeStep
Finalizes the time step for the catchment.
(Overrides CatchmentFinalizeTimeStep.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetRequiredTypes
Get the type of boundary required by this catchment
(Inherited from CatchmentAbstractUrban.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodGetYearlyStat
Get or create a RRYearlyStat object for the specified year.
(Inherited from Catchment.)
Public methodInitialize
Initialize Rainfall Runoff model. Sets up static data.
(Overrides CatchmentInitialize(IDiagnostics).)
Public methodInitializePlugins
Initializes the cathcment plugins.
(Inherited from Catchment.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOffers
List of data types that is offered and can be used in GetValue
(Inherited from Catchment.)
Public methodPerformTimeStep
This procedure forwards the calculation with one time step.
(Inherited from Catchment.)
Public methodPrepare
Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.
(Overrides CatchmentAbstractUrbanPrepare(DateTime, DateTime, RRParameters, IDiagnostics).)
Protected methodPrepareForTimeStep
Prepares the catchment for the time step.
(Overrides CatchmentPrepareForTimeStep.)
Public methodPreparePlugins
Prepares the cathcment plugins.
(Inherited from Catchment.)
Protected methodPrepareSource
Prepare boundary source.
(Inherited from Catchment.)
Protected methodPrepareState
Prepare state, especially time
(Inherited from Catchment.)
Protected methodReadPluginStates
Write current state of plugins
(Inherited from Catchment.)
Public methodReadState
Read state and apply to module. Returns true if state was successfully read.
Public methodReset
Reset the catchment and set the current time.
(Inherited from Catchment.)
Public methodResetBoundaries
Remove boundaries applied in previous runs
(Inherited from Catchment.)
Public methodStateUpdated
When state has been updated, this method can be called to update derived/computational variables
(Overrides CatchmentStateUpdated.)
Protected methodTakeTimeStep
This procedure is the one actually calculating the new time step.
(Inherited from Catchment.)
Public methodTimeOffers
List of data types that is offered and can be used in GetValue
(Inherited from Catchment.)
Public methodTimeOfNextUpdate Obsolete.
Return the time of next update. Used for PostTimeStepEvent event in Catchments. If a catchment uses variable timesteps, then this function must be overridden!!
(Inherited from Catchment.)
Public methodTimeValueGetter
Get value getter for the specified data quantity
(Inherited from Catchment.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Catchment.)
Protected methodTransferStateToOldBase
Transfer current state to state N. First thing to do when starting a timestep.
(Inherited from CatchmentAbstractUrban.)
Protected methodTriggerPostTimeStepEvent
Trigger the PostTimeStepEvent, called at end of a time step.
(Inherited from Catchment.)
Public methodType
The type of catchment: NAM, Urban A etc
(Overrides CatchmentType.)
Public methodUpdate
Update internal state of catchment to time Time()
(Inherited from Catchment.)
Protected methodUpdateCheckPointTime
Updates check point time.
(Inherited from Catchment.)
Protected methodUpdateRouting
Updates the routing for the catchment.
(Overrides CatchmentUpdateRouting.)
Protected methodUpdateStorage
Updates the storage for the catchment.
(Overrides CatchmentUpdateStorage.)
Protected methodUpdateTime
Update time, setting _timeNew to _timeOld + _effectiveTimeStep. This method will assue that _timeNew does not go beyond _endTime, by modifying _effectiveTimeStep. Before calling UpdateTime, be sure that _effectiveTimeStep is set.
(Inherited from Catchment.)
Protected methodUpdateTimeStepUsingCheckPoint
Updates the present time if it is greater than the check point time.
(Inherited from Catchment.)
Public methodValidate
Validate that the catchment is set up correctly
(Inherited from Catchment.)
Protected methodValidateLIDs
Validate all LIDs in catchment
(Inherited from Catchment.)
Public methodValueGetter
Get value setter for the specified data quantity
(Inherited from Catchment.)
Public methodValueSetter (Inherited from Catchment.)
Public methodVolumeInCatchment
Volume of water stored in catchment after previous time step.
(Overrides CatchmentVolumeInCatchment.)
Public methodVolumeInCatchmentAtStart
Volume of water stored in catchment after previous time step.
(Inherited from Catchment.)
Protected methodWritePluginStates
Write current state of plugins
(Inherited from Catchment.)
Public methodWriteState
Write current state of module
Top
Events
  NameDescription
Public eventPostTimeStepEvent
Event that is triggered every time the catchment has finished a new time step
(Inherited from Catchment.)
Top
Fields
  NameDescription
Protected field_actEvaporation
Actual evaporation Unit: [m/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_actEvaporationOld
Actual evaporation at time N, Unit: [m/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_actInfiltration
Actual infiltration, loss. Unit: [m/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_actInfiltrationOld
Infiltration at time N. Unit: [m/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_actRainDepth
Actual rain depth. Unit: [m]
(Inherited from CatchmentAbstractUrban.)
Protected field_actRainIntensity
Actual rain intensity. Unit: [m/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_additionalFlow
Additional constant flow added to the total runoff Unit: [m3/s] Default: 0
(Inherited from Catchment.)
Protected field_additionalFlowOld
Additional constant flow at start of time step
(Inherited from Catchment.)
Protected field_area
Total area of catchment. Type: Catchment area. Unit: [m2]. Default: 1e8 (100 km2).
(Inherited from Catchment.)
Protected field_bInfiltrationAfterRain
True if infiltration shall occur also after rain, used in Horton infiltration depth calculation from INI file Default: True
(Inherited from CatchmentAbstractUrban.)
Protected field_boundarySourceEvaporation
Evaporation boundary source
(Inherited from Catchment.)
Protected field_boundarySourceRainfall
Rainfall boundary source
(Inherited from Catchment.)
Protected field_boundarySourceTemperature
Temperature boundary source
(Inherited from Catchment.)
Protected field_bSnowModule
True if the snow module is activated.
(Inherited from CatchmentAbstractUrban.)
Protected field_checkPointTime
The most recent check point time.
(Inherited from Catchment.)
Protected field_effectiveTimeStep
Time step used in the simulation, it may change. It is set in Prepare to _timeStep, and can be updated by individual catchment models when required, i.e. it may differ from _timeStep.
(Inherited from Catchment.)
Protected field_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.)
Protected field_evaporationFromForcing
Evaporation that must be applied during the calculation time step. unit: [m/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_evaporationFromTS
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.)
Protected field_globalDepthDryLimit
Global dry depth limit from INI file in Kinematic wave: used when InfiltrationAfterRain == true Default: 1e-6 Unit: [m]
(Inherited from CatchmentAbstractUrban.)
Protected field_imperviousArea
Impervious area is a factor which defines the part of the catchment considered to contribute to the runoff. Unit: [-]
Protected field_initialLossMax
Maximum value of InitialLossStorageDepth Unit: [m] Default:
(Inherited from CatchmentAbstractUrban.)
Protected field_initialLossRecoverRate
Initial loss recover rate Unit: [m/s] Default: 5e-5 m/h = 1.2 mm/day
(Inherited from CatchmentAbstractUrban.)
Protected field_initialLossStorageDepth
Initial loss storage depth. Unit: [m]
(Inherited from CatchmentAbstractUrban.)
Protected field_initialLossStorageDepthOld
Initial loss storage depth at time N. Unit: [m]
(Inherited from CatchmentAbstractUrban.)
Protected field_loss
Loss, other than infiltration which goes into _actInfiltration (in another unit). Unit [m3/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_lossOld
Loss at time N. Unit: [m3/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_maximumFlow
Maximum flow
(Inherited from Catchment.)
Protected field_minimumFlow
Minimum flow
(Inherited from Catchment.)
Protected field_minTime
Proteced MinTime
(Inherited from Catchment.)
Protected field_offerDelegates
List of delegates, matching list of _offers
(Inherited from Catchment.)
Protected field_offers
List of datatypes offered in GetValue
(Inherited from Catchment.)
Protected field_potentialEvaporation
Potential evaporation Unit: [m/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_rainfallFromForcing
Rainfall that must be applied during the calculation time step measured in m/s. unit: [m/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_rainfallFromForcingOld
Rainfall that must be applied during the calculation time step measured in m/s, at time N. unit: [m/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_redCoeff
Hydrological reduction is the runoff reduction factor, accounts for water losses caused by e.g evapo-transpiration, imperfect imperviousness, etc. on the contributing area. Unit: [-] Default: 0.90
(Inherited from CatchmentAbstractUrban.)
Protected field_runoff
Total runoff from catchment at present time step. Unit: [m^3/s]
(Inherited from Catchment.)
Protected field_runoffOld
Runoff at time N. Unit: [m3/s]
(Inherited from CatchmentAbstractUrban.)
Protected field_runtimeDiagnostics
Diagnostics instance for a Catchment. Used during runtime.
(Inherited from Catchment.)
Protected field_snowStorage
Snow storage Unit: [m]
(Inherited from CatchmentAbstractUrban.)
Protected field_snowStorageOld
Snow storage at time N. Unit: [m]
(Inherited from CatchmentAbstractUrban.)
Protected field_startTime
Protected start time of catchment data - the earliest time for which the catchment can return data
(Inherited from Catchment.)
Protected field_stormwaterLIDs
List of Lids
(Inherited from Catchment.)
Protected field_temperatureFromForcing
Temperature that must be applied during the calculation time step. Note: the temperature is given in degrees Celsius, which is not SI unit! unit: [degCelcius]
(Inherited from CatchmentAbstractUrban.)
Protected field_timeNew
Variable holding information on the latest calculated time
(Inherited from Catchment.)
Protected field_timeOfLastUpdate
Last time the state of this catchment was updated (Update(DateTime) was called)
(Inherited from Catchment.)
Protected field_timeOfMaximumFlow
Time of maximum flow
(Inherited from Catchment.)
Protected field_timeOfMinimumFlow
Time of minimum flow
(Inherited from Catchment.)
Protected field_timeOld
Variable holding information on the latest calculated time
(Inherited from Catchment.)
Protected field_timeStep
Time step used in the simulation, or initial time step if the time step can change.
(Inherited from Catchment.)
Protected field_totalAdditionalInflowVolume
Total volume of additional inflow
(Inherited from Catchment.)
Protected field_totalLossVolume
Total volume of loss
(Inherited from Catchment.)
Protected field_totalRainfallVolume
Total volume of rain
(Inherited from Catchment.)
Protected field_totalRunoffVolume
Total volume of runoff
(Inherited from Catchment.)
Protected field_tsBuffer
TSBuffer to use when accessing time series objects Set in Catchments.Add(). If not set, then the inheritors must create a TSBuffer before using it.
(Inherited from Catchment.)
Protected field_useHotStartFile
Flag telling if initial conditions is taken from a hotstart file Default: false
(Inherited from Catchment.)
Protected field_volumeOnGroundAdded
Volume on ground added after UpdateStorage
(Inherited from Catchment.)
Protected field_volumeOnGroundAfterRouting
Volume on ground after routing
(Inherited from Catchment.)
Protected field_volumeOnGroundBeforeRouting
Volume on ground before routing
(Inherited from Catchment.)
Protected field_yearlyStatistics
Dictionary of statistics as a function of year
(Inherited from Catchment.)
Public fieldCatchmentPlugins
List of catchment plugins
(Inherited from Catchment.)
Public fieldValueBuffer (Inherited from Catchment.)
Top
See Also