CatchmentUHM Methods

Apply a boundary to this catchment

Apply a boundary to this catchment

Apply a boundary to this catchment

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.

Calculate the lag time for the available types: CatchmentUHMLagTimeTypes

Calculate statistics.

Called at end of each time step, by PerformTimeStep

Convert the dimensionless hydrograph (as returned from GetHydrograph(Double, Double, IDiagnostics)) to contain actual times, based on lagtime etc.

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.

Get/create dimensionless hydrograph.

The actualLagTime is updated when using the SUH hydrograph types.

Get the type of boundary required by this catchment

This procedure initialises the SCS dimensionless hydrograph, scales it and stores unit hydrograph values with the time step

Info on the SCS dimentionless hydrograph to be found in: Soil Conservation Service. U.S. Department of Agriculture. Washington D.C. (1972): SCS National Engineering Handbook, Section 4, Hydrology.

Generates a SCS triangular hydrograph.

Snyder Unit Hydrograph as described in reference: "Applied hydrology" ven Te Chow et al. (McGraw Hill) pp. 224-228

Gets the Type of the current instance.

Get the user defined hydrograph. This method loads data from time series.

Get or create a RRYearlyStat 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.

Prepares the catchment for the 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 the UHM runoff model

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