Click or drag to resize

CatchmentNamData Properties

The CatchmentNamData type exposes the following members.

Properties
  NameDescription
Public propertyAdditional
Additional parameters for the NAM catchment. These parameters are not used for the calculation, but can be used to calculate parameters for the catchment
Public propertyAdditionalFlow
Additional constant flow added to the total runoff Unit: [m3/s] Default: 0
(Inherited from Catchment.)
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 propertyAutocal
Autocalibration
Public propertyBaseTemperature
Variable holding the base temperature defining if the precipitation is snow or rain (T0). Type: temperature Unit: [celcius] Default: 0.0
Public propertyBoundarySourceRainfall
Rainfall boundary source
(Inherited from Catchment.)
Public propertyCapilarFluxParameter
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
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 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 propertyConstDegreeDayCoef
Variable holding the constant degree day coefficient (Csnow). Type: Melting Coefficient Unit: [mm/Celcius/day] Default: 2.0
Public propertyConstGwDepthForZeroBaseFlow
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.

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

Used only when UseCropCoeffsAndLosses is set.

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 propertyExternalChainage
Variable holding the chainage of the external river delivering irrigation water.
Public propertyExternalRiverName
Variable holding the name of the external river delivering irrigation water Type: River Name Default: Blank
Public propertyGwCAreaRatio
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
Public propertyIncludeElevationZones
This flag tells if the catchment should be divided into elevation zones used when ice modelling is included. Default: false
Public propertyIncludeRadiation
This flag determines if a radiation coefficient should be use in the calculation. Default: false
Public propertyIncludeRainfallDegreeDay
This flag decides if a rainfall degree day coefficient should be used. Default: false.
Public propertyIncludeSnow
This flag tells if snow is included in the calculation Default: false
Public propertyInfiltrationRateAtFieldCapacity
Variable holding the infiltartion rate at field capacity (K0inf). Type: Infiltration Unit: [mm/h] Default: 1
Public propertyInitial
Initial conditions for NAM state variables.
Public propertyLossesToEvaporation
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.

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

Used only when UseCropCoeffsAndLosses is set.

Public propertyLossesToOverlandFlow
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.

Public propertyLowerGwRechargeCoef
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
Public propertyMaxGwDepthForZeroBaseFlow
Holds the maximum groundwater depth corresponding to a zero base flow. Used when UseSeasonalGwDepthForZeroBaseFlow. Type: Ground water depth Unit: [meter] Default: 10
Public propertyMaximumFlow
Maximum runoff flow
(Inherited from Catchment.)
Public propertyMinGwDepthForTranferToUpperStorage
Holds the minimum groundwater depth at which the groundwater is transfered to the upper storage (GWLmin). Type: Ground water depth Unit: [meter] Default: 0
Public propertyMinGwDepthForZeroBaseFlow
Holds the minimum groundwater depth corresponding to a zero base flow. Used when UseSeasonalGwDepthForZeroBaseFlow. Type: Ground water depth Unit: [meter] Default: 0
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 propertyNumberOfSnowZones
Variable holding the number of inidividual snow zones. When set, all snow zone parameter arrays are recreated and reset to default values. Default: 1
Public propertyObservedData
Observed data. Used for creating calibration plots and for auto-calibration reference data.
(Inherited from Catchment.)
Public propertyOverLandflowRunoffCoeff
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
Public propertyPercentageFromExternalRiver
Variable telling the percentage of irrigation source that originates from external river. Type: Dimensionless Factor Unit: [] Default: 0
Public propertyPercentageFromLocalGroundWater
Variable telling the percentage of irrigation source that originates from local ground water. Type: Dimensionless Factor Unit: [] Default: 50
Public propertyPercentageFromLocalRiver
Variable telling the percentage of irrigation source that originates from local river. Type: Dimensionless Factor Unit: [] Default: 50
Public propertyPersons
Number of person equivalent in the catchment, used with catchment discharge source boundary
(Inherited from Catchment.)
Public propertyRadiationCoeff
Variable holding the radiation coefficient (Crad); Type: Dimensionless factor Default: 0.0;
Public propertyRainfallDegreeDayCoeff
Variable holding the rainfall degree day coefficient (Crain). Type: Rain Melting Coefficient per degree per time Unit: [/celcius/day] Default: 0.0
Public propertyRootZoneStorageMax
Maximum storage in the root/lower zone (L_max) Type: Storage depth Unit: [mm] Default: 100.00
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 propertySeasonalDegreeDayCoeff
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
Public propertySeasonalDegreeDayCoeffTimeSeries
This flag determines if the seasonal variation of the degree day coefficient is specified in a time series. Default: false
Public propertySeasonalRelativeGwDepth
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
Public propertySpecificYield
Holds the specific yield for the groundwater reservoir (Sy). Type: Dimensionless factor Unit: [] Default: 0.1
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 propertySurfaceStorageMax
Maximum surface/upper storage (Umax) Type: Storage Depth Unit: [mm] Default: 10.00
Public propertyThresholdGroundWaterRecharge
Root zone treshold for recharging groundwater (TG) Type: Dimensionless factor Unit: [] Default: 0
Public propertyThresholdInterFlow
Root zone treshold for inter flow (TIF) Type: Dimensionless factor Unit: [] Default: 0
Public propertyThresholdOverlandFlow
Root zone treshold for overland flow (TOF) Type: Dimensionless factor Unit: [] Default: 0
Public propertyTimeConstantBaseFlow
Time constant for the routing of base flow (CKBF) Type: Flow routing time constant Unit: [hour] Default: 2000
Public propertyTimeConstantFirstReservoir
Time constant for the first linear reservoir routing (CK1), for overland and interflow. Type: Flow routing time constant Unit: [hour] Default: 10
Public propertyTimeConstantInterFlow
Time constant for the first linear reservoir routing of inter flow (CKIF) Type: Flow routing time constant Unit: [hour] Default: 1000
Public propertyTimeConstantLowerBaseFlow
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
Public propertyTimeConstantSecondReservoir
Time constant for the second linear reservoir routing (CK2), for overland flow. Type: Flow routing time constant Unit: [hour] Default: 10
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 rainfall runoff model
(Overrides CatchmentTimeStep.)
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 propertyUseAbstraction
Flag telling if abstraction of ground water should be included. Default: false
Public propertyUseCropCoeffsAndLosses
Flag telling if seasonal crop coefficients and losses should be specified. Default: false
Public propertyUseFullEvaporationOnSnow
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
Public propertyUseHotStartFile
Flag telling if initial conditions is taken from a hotstart file Default: false
(Inherited from Catchment.)
Public propertyUseIrrigationModule
Flag telling if the irrigation module should be applied. Type: bool Default: False
Public propertyUseSeasonalDegreeDayCoeff
This flag determines if a seasonal variation of the degree day coefficient should be used. Default: false
Public propertyUseSeasonalGwDepthForZeroBaseFlow
Flag telling if a seasonal variation of the ground water depth corresponding to zero base flow should be used. Default: false
Public propertyUseTimeConstantSecondReservoir
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

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.)
Public propertyZoneArea
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.
Public propertyZoneDryTemperatureCorrection
Variables holding the dry temperature correction for the different zones. Type: Temperature correction Unit: [celcius] Default: 0
Public propertyZoneElevation
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
Public propertyZoneMaximumStorage
Variables holding the maximum storage at the different zones Type: Storage depth Unit: [mm] Default: 10000, if only one snow zone: 0.
Public propertyZoneMaxWaterInSnow
Variables holding the maximum amount of water contained in the snow. Type: Max Water Unit: [%] Default: 0
Public propertyZoneMinimumStorage
Variables holding the minimum storage for full coverage for each zone Type: Storage depth Unit: [mm] Default: 100, if only one snow zone: 0.
Public propertyZonePrecipitationCorrection
Variables holding the precipitation correction for the different zones. Type: Precipitation correction Unit: [%] Default: 0
Public propertyZoneWetTemperatureCorrection
Variables holding the wet temperature correction for the different zones. Type: Temperature correction Unit: [celcius] Default: 0
Top
See Also