CatchmentNam Methods

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

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

Calculate and update yearly statistics, YearlyRunoff.

Called at end of each time step, in PerformTimeStep

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

Destructor

Serves as a hash function for a particular type.

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.

This procedure initializes all the state variables declared for the catchment.

Initialize Rainfall Runoff model. Sets up static data.

Creates a shallow copy of the current Object.

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.

Prepare boundary source.

Prepare state for new simulation.

Remove boundaries applied in previous runs

This procedure forwards the NAM calculation with one time step.

List of data types that is accepted and can be used in SetValue

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 setter for the specified data quantity

Get value setter for the specified data quantity

Get value setter for the specified data quantity

Get value setter for the specified data type

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

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

Volume of water stored in catchment after previous TakeTimeStep()

Volume of water stored in catchment after previous TakeTimeStep()