public class CatchmentNam : CatchmentNamData,
IModelStateReadWrite| CatchmentNam(String) | Construct NAM catchment |
| CatchmentNam(String, String) | Construct NAM catchment |
| ActualEvaporation |
Variable holding the actual evaporation.
Type: Evaporation
Unit: [m/s]
Computational variable; setting has no effect on the computations, it affects only the value/output in the first time step. |
| Additional |
Additional parameters for the NAM catchment.
These parameters are not used for the calculation, but can be used to
calculate parameters for the catchment
(Inherited from CatchmentNamData) |
| 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) |
| Autocal |
Autocalibration
(Inherited from CatchmentNamData) |
| BaseFlowLower | State variable holding the base flow from the lower groundwater reservoir in the latest time step. Type: Discharge Unit: [mm/hour] Default: 0. |
| BaseTemperature |
Variable holding the base temperature defining if
the precipitation is snow or rain (T0).
Type: temperature
Unit: [celcius]
Default: 0.0
(Inherited from CatchmentNamData) |
| BoundaryAbstraction | Abstraction boundary. The boundary must cover the entire simulation period. Unit: [m/s], for accumulated types (abstraction-depth): [m] |
| BoundaryDayCoeff | Day cofficient boundary |
| BoundaryEvaporation | Evaporation boundary The boundary must cover the entire simulation period. Unit: [m/s], for accumulated types: [m] |
| BoundaryRadiation | Radiation boundary |
| BoundaryRainfall | Rainfall boundary The boundary must cover the entire simulation period. Unit: [m/s], for accumulated types: [m] |
| BoundarySourceIrrigation | Irrigation boundary |
| BoundarySourceRainfall |
Rainfall boundary source
(Inherited from Catchment) |
| BoundaryTemperature | Temperature boundary The boundary must cover the entire simulation period. Unit: [C] celcius. |
| CapilarFlux |
Variable holding the total amount of water undergoing capillar movement.
Unit: [m/s]
Computational variable; setting has no effect on the computations, it affects only the value/output in the first time step. |
| CapilarFluxParameter |
Variable expressing at which ground water depth the capilar
flux is 1 mm/day when the lower zone is completely dry (GWLfl1).
Type: Ground water depth
Unit: [meter]
Default: 0.0
(Inherited from CatchmentNamData) |
| CatchmentGeometry |
Get and set the list of coordinates of the catchment
The sequence of coordinates can represent one or more polygons. It is interpreted as follows:
(Inherited from Catchment) |
| CatchmentName |
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) |
| 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) |
| ConstDegreeDayCoef |
Variable holding the constant degree day coefficient (Csnow).
Type: Melting Coefficient
Unit: [mm/Celcius/day]
Default: 2.0
(Inherited from CatchmentNamData) |
| ConstGwDepthForZeroBaseFlow |
The ground water depth at which the base flow equals zero (GWLBF0). Constant value, used when
UseSeasonalGwDepthForZeroBaseFlow is false
Type: Ground water depth. Unit: [meter]. Default: 10. (Inherited from CatchmentNamData) |
| CropCoeffs |
Variables holding the seasonal crop coefficientsas read from the file
Type: Dimensionless factor
Unit: []
Default: 1
Used only when UseCropCoeffsAndLosses is set. (Inherited from CatchmentNamData) |
| 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) |
| 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) |
| ExternalChainage |
Variable holding the chainage of the external river delivering irrigation water.
(Inherited from CatchmentNamData) |
| ExternalRiverName |
Variable holding the name of the external river delivering irrigation water
Type: River Name
Default: Blank
(Inherited from CatchmentNamData) |
| GroundWaterDepth | State variable holding the depth of the groundwater below surface. Type: Ground water depth. Unit: [meter] Default: 0 |
| GwCAreaRatio |
This variable holds the ratio between ground water reservoir and the catchment area (Carea).
It is multiplied with the baseflow after updating the groundwater depth with infiltration.
Type: Dimensionless factor
Unit: []
Default: 1
(Inherited from CatchmentNamData) |
| IncludeElevationZones |
This flag tells if the catchment should be divided into
elevation zones used when ice modelling is included.
Default: false
(Inherited from CatchmentNamData) |
| IncludeRadiation |
This flag determines if a radiation coefficient should be use in the calculation.
Default: false
(Inherited from CatchmentNamData) |
| IncludeRainfallDegreeDay |
This flag decides if a rainfall degree day coefficient should be used.
Default: false.
(Inherited from CatchmentNamData) |
| IncludeSnow |
This flag tells if snow is included in the calculation
Default: false
(Inherited from CatchmentNamData) |
| InfiltrationRateAtFieldCapacity |
Variable holding the infiltartion rate at field capacity (K0inf).
Type: Infiltration
Unit: [mm/h]
Default: 1
(Inherited from CatchmentNamData) |
| InfiltrationToGroundWater |
Variable holding the amount of water that infiltrates to the ground water.
Unit: [m/s]
Computational variable; setting has no effect on the computations, it affects only the value/output in the first time step. |
| Initial |
Initial conditions for NAM state variables.
(Inherited from CatchmentNamData) |
| InterFlowFirstReservoir | State variable holding the interflow routed through the first linear reservoir. Unit: [mm/hour] |
| InterFlowOutflow | State variable holding the interflow routed through the second linear reservoir. Unit: [mm/hour] |
| LossesToEvaporation |
Variables holding the seasonal losses in percent due to evaporation as read from the file
Type: Dimensionless factor
Unit: [%]
Default: 0
Used only when UseCropCoeffsAndLosses is set. (Inherited from CatchmentNamData) |
| LossesToGroundwater |
Variables holding the seasonal losses in percent to groundwater
Type: Dimensionless factor
Unit: [%]
Default: 0
Used only when UseCropCoeffsAndLosses is set. (Inherited from CatchmentNamData) |
| LossesToOverlandFlow |
Variables holding the seasonal losses in percent to over land flow as read from the file
Type: Dimensionless factor
Unit: [%]
Default: 0
Used only when UseCropCoeffsAndLosses is set. (Inherited from CatchmentNamData) |
| LowerGwRechargeCoef |
Variable holding the fraction of the infiltration to the ground water
that enters the lower ground water storage (CQlow). If set to zero,
the lower ground water storage is not enabled.
Type: Lower baseflow
Unit: [percent]
Default: 0.0
(Inherited from CatchmentNamData) |
| MaxGwDepthForZeroBaseFlow |
Holds the maximum groundwater depth corresponding to a zero base flow.
Used when UseSeasonalGwDepthForZeroBaseFlow.
Type: Ground water depth
Unit: [meter]
Default: 10
(Inherited from CatchmentNamData) |
| MaximumFlow | Maximum runoff flow (Inherited from Catchment) |
| MinGwDepthForTranferToUpperStorage |
Holds the minimum groundwater depth at which the groundwater is transfered to the upper storage (GWLmin).
Type: Ground water depth
Unit: [meter]
Default: 0
(Inherited from CatchmentNamData) |
| MinGwDepthForZeroBaseFlow |
Holds the minimum groundwater depth corresponding to a zero base flow.
Used when UseSeasonalGwDepthForZeroBaseFlow.
Type: Ground water depth
Unit: [meter]
Default: 0
(Inherited from CatchmentNamData) |
| 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) |
| MonthlyStatistics | Dictionary of statistics as a function of year and month (Inherited from Catchment) |
| Name | (Inherited from Catchment) |
| NumberOfSnowZones |
Variable holding the number of inidividual snow zones.
When set, all snow zone parameter arrays are recreated and reset to default values.
Default: 1
(Inherited from CatchmentNamData) |
| ObservedData |
Observed data. Used for creating calibration plots and for auto-calibration reference data.
(Inherited from Catchment) |
| OverLandFirstReservoirFlow | State variable holding information on the overland flow routed through the first of two linear reservoirs. Unit: [mm/hour] |
| OverLandFirstReservoirStorage | State variable holding the amount stored in the first reservoir routing the overland flow. Unit: [mm] |
| OverLandflowRunoffCoeff |
Coefficient for overland flow runoff (CQOF). It expresses the part
of the net rainfall that run off as over land flow.
Type: Dimensionless
Unit: []
Default: 0.5
(Inherited from CatchmentNamData) |
| OverLandOutflow | State variable holding information on the overland flow routed through the second of two linear reservoirs. Unit: [mm/hour] |
| OverLandSecondReservoirStorage | State variable holding the amount stored in the second reservoir routing the overland flow. Unit: [mm] |
| PercentageFromExternalRiver |
Variable telling the percentage of irrigation source that originates from external river.
Type: Dimensionless Factor
Unit: []
Default: 0
(Inherited from CatchmentNamData) |
| PercentageFromLocalGroundWater |
Variable telling the percentage of irrigation source that originates from local ground water.
Type: Dimensionless Factor
Unit: []
Default: 50
(Inherited from CatchmentNamData) |
| PercentageFromLocalRiver |
Variable telling the percentage of irrigation source that originates from local river.
Type: Dimensionless Factor
Unit: []
Default: 50
(Inherited from CatchmentNamData) |
| PeriodicStatistics |
Class for catchment periodic statistics
(Inherited from Catchment) |
| Persons |
Number of person equivalent in the catchment,
used with catchment discharge source boundary
(Inherited from Catchment) |
| RadiationCoeff |
Variable holding the radiation coefficient (Crad);
Type: Dimensionless factor
Default: 0.0;
(Inherited from CatchmentNamData) |
| RainfallDegreeDayCoeff |
Variable holding the rainfall degree day coefficient (Crain).
Type: Rain Melting Coefficient per degree per time
Unit: [/celcius/day]
Default: 0.0
(Inherited from CatchmentNamData) |
| RootZoneStorage | State variable holding the amount stored in the root/lower zone. Type: Infiltration Unit: [mm] Default: 0. |
| RootZoneStorageMax |
Maximum storage in the root/lower zone (L_max)
Type: Storage depth
Unit: [mm]
Default: 100.00
(Inherited from CatchmentNamData) |
| 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) |
| SeasonalDegreeDayCoeff |
This array holds the seasonal variation of the degree day coefficient (Csnow).
Type: melting Coefficient
Unit: [mm/celcius/day]
Default: 1, 1.5, 2, 3, 4, 4.5, 4.5, 4, 3, 2, 1.5, 1
(Inherited from CatchmentNamData) |
| SeasonalDegreeDayCoeffTimeSeries |
This flag determines if the seasonal variation of the degree day
coefficient is specified in a time series.
Default: false
(Inherited from CatchmentNamData) |
| SeasonalRelativeGwDepth |
Holds the relative seasonal depth used to calculated
the groundwater depth corresponding to a zero base flow.
Used when UseSeasonalGwDepthForZeroBaseFlow.
Type: Dimensionless factor
Unit: []
Default: 1
(Inherited from CatchmentNamData) |
| SnowStorage | State variable holding the amount of snow stored. Unit: [mm] |
| SnowWaterRetention | State variable holding the water retention Unit: [%] |
| SnowZoneAreaCoverage | Computational variable holding the fraction of the catchment that is covered with snow. Unit: [dimensionless] |
| SnowZoneCombinedDegreeDayCoeff | Computational variable holding the combined degree day coefficient, i.e. the degree day coefficient and the rain degree day coeffient multiplied with the precipitation. Unit: [mm/Celcius/day] |
| SnowZonePrecipitation | Computational variable holding the amount of precipitation falling in each zone. It is determined as rainfall from forcing multiplied with the zone correction. Unit: [mm/hour] |
| SnowZoneQMelt | Computational variable holding the discharge from each snow zone from melting |
| SnowZoneTemperature | Computational variable holding the temperature in the snow zone. Unit: [Celcius] |
| SpecificYield |
Holds the specific yield for the groundwater reservoir (Sy).
Type: Dimensionless factor
Unit: []
Default: 0.1
(Inherited from CatchmentNamData) |
| StartTime |
Start time of catchment data - the earliest time for which the catchment can return data
(Inherited from Catchment) |
| StatisticsPreviousTimeStepWeight |
Weight of the previous time step when calculating statistics.
(Inherited from Catchment) |
| StatisticsPreviousTimeStepWeightRunoff |
Weight of the previous time step when calculating statistics
for Runoff and AdditionalFlow.
(Inherited from Catchment) |
| StatisticsType |
Periodic statistics type for catchments
(Inherited from Catchment) |
| StormWaterLIDs |
List of Lids
(Inherited from Catchment) |
| SurfaceStorage | State variable holding the amount stored in the surface/upper storage Type: Storage depth Unit: [mm] Default: 0 |
| SurfaceStorageMax |
Maximum surface/upper storage (Umax)
Type: Storage Depth
Unit: [mm]
Default: 10.00
(Inherited from CatchmentNamData) |
| ThresholdGroundWaterRecharge |
Root zone treshold for recharging groundwater (TG)
Type: Dimensionless factor
Unit: []
Default: 0
(Inherited from CatchmentNamData) |
| ThresholdInterFlow |
Root zone treshold for inter flow (TIF)
Type: Dimensionless factor
Unit: []
Default: 0
(Inherited from CatchmentNamData) |
| ThresholdOverlandFlow |
Root zone treshold for overland flow (TOF)
Type: Dimensionless factor
Unit: []
Default: 0
(Inherited from CatchmentNamData) |
| TimeConstantBaseFlow |
Time constant for the routing of base flow (CKBF)
Type: Flow routing time constant
Unit: [hour]
Default: 2000
(Inherited from CatchmentNamData) |
| TimeConstantFirstReservoir |
Time constant for the first linear reservoir routing (CK1), for overland and interflow.
Type: Flow routing time constant
Unit: [hour]
Default: 10
(Inherited from CatchmentNamData) |
| TimeConstantInterFlow |
Time constant for inter flow (CKIF).
It is used for calculation of interflow (QIF), which is proportional with SurfaceStorage and varies linearly with the relative moisture content of the lower zone storage, RootZoneStorage / RootZoneStorageMax. Type: Flow routing time constant Unit: [hour] Default: 1000(Inherited from CatchmentNamData) |
| TimeConstantLowerBaseFlow |
Variable holding the time constant for routing ground water in the lower ground water reservoir (CKlow).
Type: Flow routing time constant
Unit: [hour]
Default: 10000
(Inherited from CatchmentNamData) |
| TimeConstantSecondReservoir |
Time constant for the second linear reservoir routing (CK2), for overland flow.
Type: Flow routing time constant
Unit: [hour]
Default: 10
(Inherited from CatchmentNamData) |
| TimeOfMaximumFlow | Time of minimum runoff flow (Inherited from Catchment) |
| TimeOfMinimumFlow | Time of maximum runoff flow (Inherited from Catchment) |
| TimeStep |
Time step used by the rainfall runoff model
(Inherited from CatchmentNamData) |
| TotalAdditionalInflowVolume | Total volume of additional inflow (Inherited from Catchment) |
| TotalInfiltration |
Variable holding the total amount of water that infiltrates.
Unit: [m/s]
Computational variable; setting has no effect on the computations, it affects only the value/output in the first time step. |
| 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) |
| UseAbstraction |
Flag telling if abstraction of ground water should be included.
Default: false
(Inherited from CatchmentNamData) |
| UseCropCoeffsAndLosses |
Flag telling if seasonal crop coefficients and losses should be specified.
Default: false
(Inherited from CatchmentNamData) |
| UseFullEvaporationOnSnow |
Flag telling if the evaporation has to be reduced by the snow cover.
If False (default MIKE 11) the evaporation will be reduced by the snow cover,
if True (default MIKE URBAN), full evaporation occurs even on the ground where there is snow
Type: bool
Default: False
(Inherited from CatchmentNamData) |
| UseHotStartFile |
Flag telling if initial conditions is taken from a hotstart file
Default: false
(Inherited from Catchment) |
| UseIrrigationModule |
Flag telling if the irrigation module should be applied.
Type: bool
Default: False
(Inherited from CatchmentNamData) |
| UseLegacyLIDs |
Flag specifying whether to use legacy LID implementation.
(Inherited from Catchment) |
| UseSeasonalDegreeDayCoeff |
This flag determines if a seasonal variation of the degree day coefficient should be used.
Default: false
(Inherited from CatchmentNamData) |
| UseSeasonalGwDepthForZeroBaseFlow |
Flag telling if a seasonal variation of the ground water
depth corresponding to zero base flow should be used.
Default: false
(Inherited from CatchmentNamData) |
| UseTimeConstantSecondReservoir |
Flag specifying if to use an independent time constant for the
second linear reservoir routing (CK2), for overland flow.
If set to false, the time constant for the first and the second
linear reservoir will be the same, i.e. using only TimeConstantFirstReservoir Default: true (Inherited from CatchmentNamData) |
| VolumeOnGroundAdded |
Volume of water added to catchment after a time step.
This water will be eventually routed.
(Inherited from Catchment) |
| YearlyStatistics | Dictionary of statistics as a function of year (Inherited from Catchment) |
| ZoneArea |
Variables holding the areas of the different zones.
Type: Catchment area
Unit: [km2]
Default: 0, not used in case of only one snow zone, the total catchment area is used instead.
(Inherited from CatchmentNamData) |
| ZoneDryTemperatureCorrection |
Variables holding the dry temperature correction for the different zones.
Type: Temperature correction
Unit: [celcius]
Default: 0
(Inherited from CatchmentNamData) |
| ZoneElevation |
Variables holding the elevations for the different zones.
These values are not used during the calculation, but used
elsewhere to calculate parameters in different snow zones.
Type: Elevation
Unit: [meter]
Default: 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000
(Inherited from CatchmentNamData) |
| ZoneMaximumStorage |
Variables holding the maximum storage at the different zones
Type: Storage depth
Unit: [mm]
Default: 10000, if only one snow zone: 0.
(Inherited from CatchmentNamData) |
| ZoneMaxWaterInSnow |
Variables holding the maximum amount of water contained in the snow.
Type: Max Water
Unit: [%]
Default: 0
(Inherited from CatchmentNamData) |
| ZoneMinimumStorage |
Variables holding the minimum storage for full coverage for each zone
Type: Storage depth
Unit: [mm]
Default: 100, if only one snow zone: 0.
(Inherited from CatchmentNamData) |
| ZonePrecipitationCorrection |
Variables holding the precipitation correction for the different zones.
Type: Precipitation correction
Unit: [%]
Default: 0
(Inherited from CatchmentNamData) |
| ZoneWetTemperatureCorrection |
Variables holding the wet temperature correction for the different zones.
Type: Temperature correction
Unit: [celcius]
Default: 0
(Inherited from CatchmentNamData) |
| Accepts | (Inherited from Catchment) |
| AddToOffers | (Inherited from Catchment) |
| ApplyBoundary(ICatchmentSourceBoundary) |
Apply a boundary to this catchment
(Inherited from Catchment) |
| ApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource) |
Apply source boundary to the catchment. The boundary will be set depending on the type.
It will throw an exception if type in not correct or if Discharge type is used.
If a boundoary source is already set, it will be overridden. (Overrides CatchmentApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource)) |
| ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply boundary for Global source boundary type
(Overrides CatchmentApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)) |
| ApplyBoundaryLIDs(GlobalGeoLocatedSource) |
Apply boundary to LID's in catchment
(Inherited from Catchment) |
| ApplyBoundaryLIDs(ICatchmentSourceBoundary) |
Apply boundary to LID's in catchment
(Inherited from Catchment) |
| ApplyBoundaryLIDs(CatchmentSourceBoundaryTypes, IBoundarySource) |
Apply boundary to LID's in catchment
(Inherited from Catchment) |
| ApplyBoundaryLIDs(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply boundary to LID's in catchment
(Inherited from Catchment) |
| BoundaryTypeIsAdditive |
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) |
| CalcInitialGWDepthFromBaseflow | Calculates an initial ground water depth from a base flow |
| CalcInitialOverlandFirstReservoirStorageFromFlow | Calculate initial OverLandFirstReservoirStorage from OverLandFirstReservoirFlow (and OverLandOutflow), i.e. these must be set first. |
| CalcInitialOverlandSecondReservoirStorageFromFlow | Calculate initial OverLandSecondReservoirStorage from OverLandOutflow (and OverLandFirstReservoirFlow), i.e. these must be set first. |
| CalcTimeConstantFirstReservoir | This functione returns the final time constant needed to route overland flow through the first linear reservoir. Unit: [hour] |
| CalcTimeConstantSecondReservoir | This functione returns the final time constant needed to route overland flow through the second linear reservoir. Unit: [hour] |
| CalculateGwDepthForZeroBaseFlow | This routine finds the ground water depth at which there is zero base flow. This depth can be either constant or vary through out the year. |
| CalculateStatistics |
Calculate statistics.
Called at end of each time step, by PerformTimeStep (Overrides CatchmentStateCalculateStatistics) |
| CreatePeriodicStat |
Creates and instance of statistics for a period.
(Overrides CatchmentCreatePeriodicStat) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Destructor
(Inherited from Catchment) |
| FinalizeTimeStep | Finalizes the time step for the catchment. (Overrides CatchmentFinalizeTimeStep) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPeriodicStat |
Get or create a RRYearlyStat object for the specified period.
(Inherited from Catchment) |
| GetRequiredTypes |
Returns a list of CatchmentSourceBoundaryTypes that need to be set.
The list will always contains Rainfall and Evaporation if they have not been set yet.
The list should be empty when this is called for M11, because the
source boundaries have already been set.
(Overrides CatchmentGetRequiredTypes) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize |
Initialize Rainfall Runoff model. Sets up static data.
(Overrides CatchmentInitialize(IDiagnostics)) |
| InitializePlugins |
Initializes the cathcment plugins.
(Inherited from Catchment) |
| 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 Catchment) |
| PerformTimeStep |
This procedure forwards the calculation with one time step.
(Inherited from Catchment) |
| Prepare |
Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.
(Overrides CatchmentPrepare(DateTime, DateTime, RRParameters, IDiagnostics)) |
| PrepareForTimeStep |
This procedure forwards the NAM calculation with one time step.
(Overrides CatchmentPrepareForTimeStep) |
| PreparePlugins |
Prepares the cathcment plugins.
(Inherited from Catchment) |
| PrepareSource |
Prepare boundary source.
(Inherited from Catchment) |
| PrepareState |
Prepare state for new simulation.
(Inherited from CatchmentState) |
| ReadBufferState |
Read current state of catchment value buffer
(Inherited from Catchment) |
| ReadPluginStates |
Read current state of plugins
(Inherited from Catchment) |
| ReadState | Read state and apply to module. Returns true if state was successfully read. |
| Reset |
Reset the catchment and set the current time.
(Inherited from Catchment) |
| ResetBoundaries |
Remove boundaries applied in previous runs
(Inherited from Catchment) |
| StateUpdated |
When state has been updated, this method can be called to update derived/computational variables
(Overrides CatchmentStateStateUpdated) |
| TakeTimeStep |
This procedure is the one actually calculating the new time step.
(Inherited from Catchment) |
| TimeOffers |
List of data types that is offered and can be used in GetValue
(Inherited from Catchment) |
| TimeOfNextUpdate |
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) |
| TimeValueGetter |
Get value getter for the specified data quantity
(Inherited from Catchment) |
| ToString | Returns a string that represents the current object. (Inherited from Catchment) |
| TransferToStateVariableTable |
This routine stores the calculated variables in variables ready for export. The values in these state variable
corresponds to the values written to the result file. All discharge variables are subject to a unit conversion.
During the calculation discharges are calculated using the unit mm/hour and must therefor be converted into m3/s.
(Overrides CatchmentStateTransferToStateVariableTable) |
| TriggerPostTimeStepEvent |
Trigger the PostTimeStepEvent, called at end of a time step.
(Inherited from Catchment) |
| Type |
The type of catchment: NAM, Urban A etc
(Overrides CatchmentType) |
| Update |
Update internal state of catchment to time Time()
(Inherited from Catchment) |
| UpdateCheckPointTime |
Updates check point time.
(Inherited from Catchment) |
| UpdateRouting | Updates the routing for the catchment. (Overrides CatchmentUpdateRouting) |
| UpdateRunoffMinMaxStatistics |
Update time and values of minimum/maximum flow.
(Inherited from Catchment) |
| UpdateStorage | Updates the storage for the catchment. (Overrides CatchmentUpdateStorage) |
| UpdateTime |
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) |
| UpdateTimeStepUsingCheckPoint |
Updates the present time if it is greater than the check point time.
(Inherited from Catchment) |
| Validate |
Validate that the catchment is set up correctly
(Overrides CatchmentValidate) |
| Validate(IDiagnostics, Boolean) | Check that the NAM catchment has been properly initialised To be called at the end of Initialize() using isInitializing true. Validate() is called before Initialize() |
| ValidateLIDs |
Validate all LIDs in catchment
(Inherited from Catchment) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from Catchment) |
| ValueSetter | (Inherited from Catchment) |
| VolumeInCatchment |
Volume of water stored in catchment after previous time step.
(Overrides CatchmentVolumeInCatchment) |
| VolumeInCatchmentAtStart |
Volume of water stored in catchment after previous time step.
(Overrides CatchmentVolumeInCatchmentAtStart) |
| WriteBufferState |
Write current state of catchment value buffer
(Inherited from Catchment) |
| WritePluginStates |
Write current state of plugins
(Inherited from Catchment) |
| WriteState | Write current state of module |
| PostTimeStepEvent |
Event that is triggered every time the catchment has finished
a new time step
(Inherited from Catchment) |
| _additionalFlow |
Additional constant flow added to the total runoff
Unit: [m3/s]
Default: 0
(Inherited from Catchment) |
| _additionalFlowOld |
Additional constant flow at start of time step
(Inherited from Catchment) |
| _area |
Total area of catchment.
Type: Catchment area.
Unit: [m2].
Default: 1e8 (100 km2).
(Inherited from Catchment) |
| _boundarySourceEvaporation |
Evaporation boundary source
(Inherited from Catchment) |
| _boundarySourceRainfall |
Rainfall boundary source
(Inherited from Catchment) |
| _boundarySourceTemperature |
Temperature boundary source
(Inherited from Catchment) |
| _checkPointTime |
The most recent check point time.
(Inherited from Catchment) |
| _cropCoeffs |
Variables holding the seasonal crop coefficients
Type: Dimensionless factor
Unit: []
Default: 1
(Inherited from CatchmentNamData) |
| _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) |
| _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) |
| _includeSnow |
This flag tells if snow is included in the calculation
Default: false
(Inherited from CatchmentNamData) |
| _maximumFlow | Maximum flow (Inherited from Catchment) |
| _minimumFlow | Minimum flow (Inherited from Catchment) |
| _minTime |
Proteced MinTime
(Inherited from Catchment) |
| _offerDelegates | List of delegates, matching list of _offers (Inherited from Catchment) |
| _offers | List of datatypes offered in GetValue (Inherited from Catchment) |
| _runoff | Total runoff from catchment at present time step. Unit: [m^3/s] (Inherited from Catchment) |
| _runtimeDiagnostics |
Diagnostics instance for a Catchment. Used during runtime.
(Inherited from Catchment) |
| _startTime |
Protected start time of catchment data - the earliest time for which the catchment can return data
(Inherited from Catchment) |
| _stateVariableLoss | Losses in [m3/s] (Inherited from CatchmentState) |
| _stateVariableNetRainfall | Net rainfall in [m/s] (Inherited from CatchmentState) |
| _stateVariableTotalEvaporation | Total infiltration in [m/s] (Inherited from CatchmentState) |
| _stateVariableTotalInfiltration | Total infiltration in [m/s] (Inherited from CatchmentState) |
| _stateVariableTotalRunOff | Total Runoff in [m3/s]. It includes also AdditionalFlow. (Inherited from CatchmentState) |
| _stormwaterLIDs |
List of Lids
(Inherited from Catchment) |
| _timeNew |
Variable holding information on the latest calculated time
(Inherited from Catchment) |
| _timeOfLastUpdate |
Last time the state of this catchment was updated (Update(DateTime) was called)
(Inherited from Catchment) |
| _timeOfMaximumFlow | Time of maximum flow (Inherited from Catchment) |
| _timeOfMinimumFlow | Time of minimum flow (Inherited from Catchment) |
| _timeOld |
Variable holding information on the latest calculated time
(Inherited from Catchment) |
| _timeStep |
Time step used in the simulation, or initial time step if the time step can change.
(Inherited from Catchment) |
| _timeStepInHours |
Time step used in the NAM rainfall runoff model
Unit: [hours]
(Inherited from CatchmentNamData) |
| _totalAdditionalInflowVolume | Total volume of additional inflow (Inherited from Catchment) |
| _totalLossVolume | Total volume of loss (Inherited from Catchment) |
| _totalRainfallVolume | Total volume of rain (Inherited from Catchment) |
| _totalRunoffVolume | Total volume of runoff (Inherited from Catchment) |
| _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) |
| _useHotStartFile |
Flag telling if initial conditions is taken from a hotstart file
Default: false
(Inherited from Catchment) |
| _volumeOnGroundAdded | Volume on ground added after UpdateStorage (Inherited from Catchment) |
| _volumeOnGroundAfterRouting | Volume on ground after routing (Inherited from Catchment) |
| _volumeOnGroundBeforeRouting | Volume on ground before routing (Inherited from Catchment) |
| CatchmentPlugins |
List of catchment plugins
(Inherited from Catchment) |
| ValueBuffer | (Inherited from Catchment) |