CatchmentNam Class

Construct NAM catchment

Construct NAM catchment

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 parameters for the NAM catchment. These parameters are not used for the calculation, but can be used to calculate parameters for the catchment

Additional constant flow added to the total runoff Unit: [m3/s] Default: 0

Total area of catchment Type: Catchment area Unit: [m2] Default: 1e8 (100 km2)

Full area of catchment Type: Catchment area Unit: [km2] Default: 100

Autocalibration

State variable holding the base flow from the lower groundwater reservoir in the latest time step. Type: Discharge Unit: [mm/hour] Default: 0.

Variable holding the base temperature defining if the precipitation is snow or rain (T0). Type: temperature Unit: [celcius] Default: 0.0

Abstraction boundary. The boundary must cover the entire simulation period. Unit: [m/s], for accumulated types (abstraction-depth): [m]

Day cofficient boundary

Evaporation boundary The boundary must cover the entire simulation period. Unit: [m/s], for accumulated types: [m]

Radiation boundary

Rainfall boundary The boundary must cover the entire simulation period. Unit: [m/s], for accumulated types: [m]

Irrigation boundary

Rainfall boundary source

Temperature boundary The boundary must cover the entire simulation period. Unit: [C] celcius.

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.

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

Get and set the list of coordinates of the catchment

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.

Get and set the central point of the catchment

A set of check points in time that must be hit by the catchments.

Variable holding the constant degree day coefficient (Csnow). Type: Melting Coefficient Unit: [mm/Celcius/day] Default: 2.0

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.

Variables holding the seasonal crop coefficientsas read from the file Type: Dimensionless factor Unit: [] Default: 1

Used only when UseCropCoeffsAndLosses is set.

Current time of catchment

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.

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.

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.

Variable holding the chainage of the external river delivering irrigation water.

Variable holding the name of the external river delivering irrigation water Type: River Name Default: Blank

State variable holding the depth of the groundwater below surface. Type: Ground water depth. Unit: [meter] Default: 0

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

This flag tells if the catchment should be divided into elevation zones used when ice modelling is included. Default: false

This flag determines if a radiation coefficient should be use in the calculation. Default: false

This flag decides if a rainfall degree day coefficient should be used. Default: false.

This flag tells if snow is included in the calculation Default: false

Variable holding the infiltartion rate at field capacity (K0inf). Type: Infiltration Unit: [mm/h] Default: 1

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 conditions for NAM state variables.

State variable holding the interflow routed through the first linear reservoir. Unit: [mm/hour]

State variable holding the interflow routed through the second linear reservoir. Unit: [mm/hour]

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.

Variables holding the seasonal losses in percent to groundwater Type: Dimensionless factor Unit: [%] Default: 0

Used only when UseCropCoeffsAndLosses is set.

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.

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

Holds the maximum groundwater depth corresponding to a zero base flow. Used when UseSeasonalGwDepthForZeroBaseFlow. Type: Ground water depth Unit: [meter] Default: 10

Maximum runoff flow

Holds the minimum groundwater depth at which the groundwater is transfered to the upper storage (GWLmin). Type: Ground water depth Unit: [meter] Default: 0

Holds the minimum groundwater depth corresponding to a zero base flow. Used when UseSeasonalGwDepthForZeroBaseFlow. Type: Ground water depth Unit: [meter] Default: 0

Minimum runoff flow

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.

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.

Variable holding the number of inidividual snow zones. When set, all snow zone parameter arrays are recreated and reset to default values. Default: 1

Observed data. Used for creating calibration plots and for auto-calibration reference data.

State variable holding information on the overland flow routed through the first of two linear reservoirs. Unit: [mm/hour]

State variable holding the amount stored in the first reservoir routing the overland flow. Unit: [mm]

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

State variable holding information on the overland flow routed through the second of two linear reservoirs. Unit: [mm/hour]

State variable holding the amount stored in the second reservoir routing the overland flow. Unit: [mm]

Variable telling the percentage of irrigation source that originates from external river. Type: Dimensionless Factor Unit: [] Default: 0

Variable telling the percentage of irrigation source that originates from local ground water. Type: Dimensionless Factor Unit: [] Default: 50

Variable telling the percentage of irrigation source that originates from local river. Type: Dimensionless Factor Unit: [] Default: 50

Number of person equivalent in the catchment, used with catchment discharge source boundary

Variable holding the radiation coefficient (Crad); Type: Dimensionless factor Default: 0.0;

Variable holding the rainfall degree day coefficient (Crain). Type: Rain Melting Coefficient per degree per time Unit: [/celcius/day] Default: 0.0

State variable holding the amount stored in the root/lower zone. Type: Infiltration Unit: [mm] Default: 0.

Maximum storage in the root/lower zone (L_max) Type: Storage depth Unit: [mm] Default: 100.00

Total runoff from catchment at present time step. Unit: [m^3/s]

Get the Diagnostics instance for a Catchment. Used during runtime.

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

This flag determines if the seasonal variation of the degree day coefficient is specified in a time series. Default: false

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

State variable holding the amount of snow stored. Unit: [mm]

State variable holding the water retention Unit: [%]

Computational variable holding the fraction of the catchment that is covered with snow. Unit: [dimensionless]

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]

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]

Computational variable holding the discharge from each snow zone from melting

Computational variable holding the temperature in the snow zone. Unit: [Celcius]

Holds the specific yield for the groundwater reservoir (Sy). Type: Dimensionless factor Unit: [] Default: 0.1

Start time of catchment data - the earliest time for which the catchment can return data

List of Lids

State variable holding the amount stored in the surface/upper storage Type: Storage depth Unit: [mm] Default: 0

Maximum surface/upper storage (Umax) Type: Storage Depth Unit: [mm] Default: 10.00

Root zone treshold for recharging groundwater (TG) Type: Dimensionless factor Unit: [] Default: 0

Root zone treshold for inter flow (TIF) Type: Dimensionless factor Unit: [] Default: 0

Root zone treshold for overland flow (TOF) Type: Dimensionless factor Unit: [] Default: 0

Time constant for the routing of base flow (CKBF) Type: Flow routing time constant Unit: [hour] Default: 2000

Time constant for the first linear reservoir routing (CK1), for overland and interflow. Type: Flow routing time constant Unit: [hour] Default: 10

Time constant for the first linear reservoir routing of inter flow (CKIF) Type: Flow routing time constant Unit: [hour] Default: 1000

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

Time constant for the second linear reservoir routing (CK2), for overland flow. Type: Flow routing time constant Unit: [hour] Default: 10

Time of minimum runoff flow

Time of maximum runoff flow

Time step used by the rainfall runoff model

Total volume of additional inflow

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.

Total infiltration into this catchment (integrated over time)

Total rainfall on this catchment (integrated over time)

Total runoff from this catchment (integrated over time)

Set the TSBuffer to use in this catchment

Flag telling if abstraction of ground water should be included. Default: false

Flag telling if seasonal crop coefficients and losses should be specified. Default: false

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

Flag telling if initial conditions is taken from a hotstart file Default: false

Flag telling if the irrigation module should be applied. Type: bool Default: False

This flag determines if a seasonal variation of the degree day coefficient should be used. Default: false

Flag telling if a seasonal variation of the ground water depth corresponding to zero base flow should be used. Default: false

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

Volume of water added to catchment after a time step. This water will be eventually routed.

Return dictionary of runoff as a function of year

Dictionary of statistics as a function of year

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.

Variables holding the dry temperature correction for the different zones. Type: Temperature correction Unit: [celcius] Default: 0

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

Variables holding the maximum storage at the different zones Type: Storage depth Unit: [mm] Default: 10000, if only one snow zone: 0.

Variables holding the maximum amount of water contained in the snow. Type: Max Water Unit: [%] Default: 0

Variables holding the minimum storage for full coverage for each zone Type: Storage depth Unit: [mm] Default: 100, if only one snow zone: 0.

Variables holding the precipitation correction for the different zones. Type: Precipitation correction Unit: [%] Default: 0

Variables holding the wet temperature correction for the different zones. Type: Temperature correction Unit: [celcius] Default: 0

Apply a boundary to this catchment

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.

Apply boundary for Global source boundary type

Apply boundary to LID's in catchment

Apply boundary to LID's in catchment

Apply boundary to LID's in catchment

Apply boundary to LID's in catchment

Return true if boundaries of the specified type are additive; the contributions of two discharge boundaries add up, while two temperature boundaries do not.

Calculates an initial ground water depth from a base flow

Calculate initial OverLandFirstReservoirStorage from OverLandFirstReservoirFlow (and OverLandOutflow), i.e. these must be set first.

Calculate initial OverLandSecondReservoirStorage from OverLandOutflow (and OverLandFirstReservoirFlow), i.e. these must be set first.

This functione returns the final time constant needed to route overland flow through the first linear reservoir. Unit: [hour]

This functione returns the final time constant needed to route overland flow through the second linear reservoir. Unit: [hour]

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.

Calculate statistics.

Called at end of each time step, by PerformTimeStep

Determines whether the specified object is equal to the current object.

Destructor

Finalizes the time step for the catchment.

Serves as the default hash function.

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.

Gets the Type of the current instance.

Get or create a NAMYearlyStat object for the specified year.

Initialize Rainfall Runoff model. Sets up static data.

Initializes the cathcment plugins.

Creates a shallow copy of the current Object.

List of data types that is offered and can be used in GetValue

This procedure forwards the calculation with one time step.

Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.

This procedure forwards the NAM calculation with one time step.

Prepares the cathcment plugins.

Prepare boundary source.

Prepare state for new simulation.

Write current state of plugins

Read state and apply to module. Returns true if state was successfully read.

Reset the catchment and set the current time.

Remove boundaries applied in previous runs

When state has been updated, this method can be called to update derived/computational variables

This procedure is the one actually calculating the new time step.

List of data types that is offered and can be used in GetValue

Return the time of next update. Used for PostTimeStepEvent event in Catchments. If a catchment uses variable timesteps, then this function must be overridden!!

Get value getter for the specified data quantity

Returns a string that represents the current object.

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.

Trigger the PostTimeStepEvent, called at end of a time step.

The type of catchment: NAM, Urban A etc

Update internal state of catchment to time Time()

Updates check point time.

Updates the routing for the catchment.

Updates the storage for the catchment.

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.

Updates the present time if it is greater than the check point time.

Validate that the catchment is set up correctly

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()

Validate all LIDs in catchment

Get value setter for the specified data quantity

Volume of water stored in catchment after previous time step.

Volume of water stored in catchment after previous time step.

Write current state of plugins

Write current state of module

Event that is triggered every time the catchment has finished a new time step

Additional constant flow added to the total runoff Unit: [m3/s] Default: 0

Additional constant flow at start of time step

Total area of catchment. Type: Catchment area. Unit: [m2]. Default: 1e8 (100 km2).

Evaporation boundary source

Rainfall boundary source

Temperature boundary source

The most recent check point time.

Variables holding the seasonal crop coefficients Type: Dimensionless factor Unit: [] Default: 1

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.

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.

This flag tells if snow is included in the calculation Default: false

Maximum flow

Minimum flow

Proteced MinTime

List of delegates, matching list of _offers

List of datatypes offered in GetValue

Total runoff from catchment at present time step. Unit: [m^3/s]

Diagnostics instance for a Catchment. Used during runtime.

Protected start time of catchment data - the earliest time for which the catchment can return data

Losses in [m3/s]

Net rainfall in [m/s]

Total infiltration in [m/s]

Total Runoff in [m3/s]. It includes also AdditionalFlow.

List of Lids

Variable holding information on the latest calculated time

Last time the state of this catchment was updated (Update(DateTime) was called)

Time of maximum flow

Time of minimum flow

Variable holding information on the latest calculated time

Time step used in the simulation, or initial time step if the time step can change.

Time step used in the NAM rainfall runoff model Unit: [hours]

Total volume of additional inflow

Total volume of loss

Total volume of rain

Total volume of runoff

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.

Flag telling if initial conditions is taken from a hotstart file Default: false

Volume on ground added after UpdateStorage

Volume on ground after routing

Volume on ground before routing

Dictionary of statistics as a function of year

List of catchment plugins