public class CatchmentLinearReservoirSurface : CatchmentAbstractUrbanSurface| CatchmentLinearReservoirSurface | Initializes a new instance of the CatchmentLinearReservoirSurface class |
| ApplyEvaporationOnRain |
When raining, if true the evaporation is applied at the beginning of the time step,
correcting the net rain and limited by the rain.
If false, evaporation is applied on non-empty storages in the catchment and can exceed the rain.
In dry periods, this is not used, evaporation is always applied on storages. (Inherited from CatchmentSurface) |
| ApplyInitialLossRecoveryRateWhenRaining |
Flag specifying to apply InitialLossRecoveryRate also when it is raining.
(Inherited from CatchmentSurface) |
| AreaFraction |
Area fraction of the surface
Unit: [-].
(Inherited from CatchmentSurface) |
| Depth |
Depth of water on sub-catchment.
State variable.
Unit: [m]
(Inherited from CatchmentSurface) |
| DepthOld |
Depth of water at the previous time step.
Computational variable.
Unit: [m]
(Inherited from CatchmentSurface) |
| EffectiveAreaFraction |
Effective area fraction, subtracting area covered by LID's.
Default: Same as AreaFraction when no LID's
Unit: [-]
(Inherited from CatchmentSurface) |
| EvaporationActual |
Actual evaporation.
Reporting variable.
Unit: [m/s]
(Inherited from CatchmentSurface) |
| EvaporationActualOld |
Evaporation of last time step.
Reporting variable.
Unit: [m/s]
(Inherited from CatchmentSurface) |
| EvaporationFromTimeSeries |
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 CatchmentSurface) |
| EvaporationPotential |
Potential evaporation.
Reporting variable.
Unit: [m/s]
(Inherited from CatchmentSurface) |
| GlobalDepthDryLimit |
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 CatchmentSurface) |
| Horton |
Horton, defined only for pervious surfaces.
Returns null if Infiltration is not Horton. (Inherited from CatchmentSurface) |
| ID |
The ID of the surface
(Inherited from CatchmentSurface) |
| Infiltration |
Infiltration calculator. This defines whether the surface is pervious.
If null, the surface is impervious. (Inherited from CatchmentSurface) |
| InfiltrationActual |
Actual infiltration.
Reporting variable.
Unit: [m/s]
(Inherited from CatchmentSurface) |
| InfiltrationActualOld |
Infiltration of last time step
Reporting variable.
Unit: [m/s]
(Inherited from CatchmentSurface) |
| InfiltrationAfterRain |
True if infiltration shall occur also after rain has ended.
Default is true .(Inherited from CatchmentSurface) |
| InfiltrationPotential |
Potential infiltration.
Reporting variable.
Unit: [m/s]
(Inherited from CatchmentSurface) |
| InfiltrationPotentialOld |
Potential infiltration of last time step
Reporting variable.
Unit: [m/s]
(Inherited from CatchmentSurface) |
| InfiltrationTime |
Time in seconds where infiltration has taken place. Grows over the entire simulation
State variable for the Dutch model, NL. (Inherited from CatchmentAbstractUrbanSurface) |
| InitialLossRecoveryRate |
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 CatchmentSurface) |
| Loss |
Loss, other than infiltration which goes into InfiltrationActual.
Additionally, the wetting loss and storage loss is not included in this loss, and these are considered a part of catchment water volume, which cannot be routed. Unit: [m/s](Inherited from CatchmentSurface) |
| LossOld |
Loss of last time step
(Inherited from CatchmentSurface) |
| RainRate |
Rain rate, which can be modified by some processes.
For example, rain rate can be modified by snow module. Unit: [m/s](Inherited from CatchmentSurface) |
| RainRateOld |
Rain rate of last time step.
Unit: [m/s]
(Inherited from CatchmentSurface) |
| SkipOffers |
Skip the creation of offers.
(Inherited from CatchmentSurface) |
| SnowModule |
Snow module handling snow storage.
If null, the snow module is not applied. (Inherited from CatchmentSurface) |
| SnowStorage |
Snow storage at time N+1.
Unit: [m]
(Inherited from CatchmentSurface) |
| SnowStorageOld |
Snow storage at previous time N.
Unit: [m]
(Inherited from CatchmentSurface) |
| StorageCapacity |
Storage capacity.
Unit: [m].
Not applicable to ImperviousSteep.
(Inherited from CatchmentSurface) |
| StorageLoss |
Storage loss depth.
State variable.
Unit: [m]
(Inherited from CatchmentSurface) |
| StorageLossOld |
Storage loss depth at the previous time step.
Computational variable.
Unit: [m]
(Inherited from CatchmentSurface) |
| SurfaceIndex |
Index of the surface in the list of surfaces.
(Inherited from CatchmentSurface) |
| Temperature |
Temperature from forcing.
Unit: Degrees Celcius
(Inherited from CatchmentSurface) |
| Type |
Impervious or pervious surface type.
(Inherited from CatchmentSurface) |
| UseReverseDraining |
Revert to old draining order. Set to true to
drain in same order as in MOUSE engine.
Reverse draining drains in order: wetting, storage, depth. Hence, when storages are full, wetting and storage will be drained and not depth, depth will be higher and give more runoff. This is visible in low-flow conditions. (Inherited from CatchmentSurface) |
| WettingCapacity |
Wetting capacity.
Unit: [m].
(Inherited from CatchmentSurface) |
| WettingLoss |
Wetting loss depth.
State variable.
Unit: [m]
(Inherited from CatchmentSurface) |
| WettingLossOld |
Wetting loss depth at the previous time step.
Computational variable.
Unit: [m]
(Inherited from CatchmentSurface) |
| AddToOffers(FuncDouble, IQuantity) |
Adds to offers of catchment surface
(Inherited from CatchmentSurface) |
| AddToOffers(FuncDouble, PredefinedQuantity) |
Adds to offers of catchment surface
(Inherited from CatchmentSurface) |
| AddToOffers(FuncDouble, PredefinedQuantityRR) |
Adds to offers of catchment surface
(Inherited from CatchmentSurface) |
| Clone |
Creates an instance of catchment surface with the reference to the same data
(Inherited from CatchmentSurface) |
| Create | Catchment surface for linear reservoir based on model type. |
| CreateOffers |
Create offers for catchment surface.
(Inherited from CatchmentSurface) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| EvaporateFromStorages |
Evaporates from depth, storage loss, and wetting loss.
(Inherited from CatchmentSurface) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FinalizeTimeStep |
Finalizes catchment surface time step.
(Inherited from CatchmentSurface) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize |
Initialize catchment surface.
(Inherited from CatchmentSurface) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Offers |
List of data types that is offered and can be used in GetValue
(Inherited from CatchmentSurface) |
| PerformTimeStep |
Perform catchment surface time step.
The catchment surface has several processes: * Snow module * Filling of storages * Evaporation * Infiltration (Inherited from CatchmentAbstractUrbanSurface) |
| Prepare |
Prepare catchment surface for simulation.
(Inherited from CatchmentAbstractUrbanSurface) |
| PrepareForTimeStep |
Prepare for catchment surface time step.
(Inherited from CatchmentSurface) |
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
(Overrides CatchmentSurfaceReadState(ModelStateReader)) |
| ResetComputationalVariables |
Resets computational variable values to zero
(Inherited from CatchmentSurface) |
| ResetStateVariables |
Resets state variable values to zero
(Inherited from CatchmentSurface) |
| ResetVariables |
Resets variable values to zero
(Inherited from CatchmentSurface) |
| StateUpdated |
When state has been updated, this method can be called to update derived/computational variables
(Inherited from CatchmentSurface) |
| TimeOffers |
List of data types that is offered and can be used in GetValue
(Inherited from CatchmentSurface) |
| TimeValueGetter |
Get value getter for the specified data quantity
(Inherited from CatchmentSurface) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TransferVariablesToOld |
Transfers previous time step variable values to Old variables.
(Inherited from CatchmentSurface) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from CatchmentSurface) |
| WriteState |
Write current state of module
(Overrides CatchmentSurfaceWriteState(ModelStateWriter)) |