Click or drag to resize

DHI.Mike1D.RainfallRunoffModule Namespace

The RainfallRunoffModule component contains various catchment models for calculating runoff from catchments
Classes
  ClassDescription
Public classAutocal
Data for autocalibration of catchment parameters.
Public classCatchment
Abstract catchment class.
Public classCatchmentAbstractUrban
CatchmentAbstractUrban is an abstract class that inherits from Catchment. All common methods for urban rainfall-runoff models are implemented here.
Public classCatchmentCombined
Class for the Combined type of catchment. A combined catchment is a combination of existing Catchments, named subcatchments. The runoff is calculated by multiplying a contributing area factor to each subcatchments.
Public classCatchmentDischarge
Simple catchment that handles catchment discharge
Public classCatchmentFromTimeSeries
Load a time seris as a catchment
Public classCatchmentKinematicWave
Class for Kinematic Wave catchment model. See ICatchmentKinematicWaveData for parameters availabel when setting up the model.

In Kinematic Wave model the runoff is computed as flow in an open channel, taking the gravitational and frition forces only. The runoff amount is controlled by the various hydrological losses and the size of the actually contributing area.

Public classCatchmentKinematicWaveSurface
SubCatchment class. used for Kinematic waves Rainfall Runoff model. A subCachment can be of five types: SurfaceType.
Public classCatchmentLinearReservoir
Class for Linear Reservoir catchment model. See ICatchmentLinearReservoirData for parameters availabel when setting up the model.

This class implement the linear reservoir rainfal runoff, also called Runoff C in MIKE URBAN Two model types are currently available: the Dutch (C1) and the French model (C2).

Public classCatchmentNam
A lumped, conceptual rainfall-runoff model, simulating the overland-, inter-, and base-flow components as a function of the moisture contents in four storages; snow, surface, root-zone and ground water.
Public classCatchmentNamAdditional
Class containing additional parameters for CatchmentNam. These parameters are not used for the calculation, but are used to calculate parameters for the catchment
Public classCatchmentNamData
A lumped, conceptual rainfall-runoff model, simulating the overland-, inter-, and base-flow components as a function of the moisture contents in four storages; snow, surface, root-zone and ground water.

This class contains data and parameters for setting up a NAM model, and is as such a data class only. Computational variables are not included in this class. It can be used to explore data and parameters required when setting up the NAM model.

Public classCatchmentNamInitial
Default initial conditions for NAM.
Public classCatchmentNamInitialFromHotstart
Public classCatchments
A collection of Rainfall Runoff catchments
Public classCatchmentsSmallestTimeComparer
Class for comparing date time on the smallest time
Public classCatchmentState
Base class for catchments utilizing the StateVariable for maintaining and interpolating in state.
Public classCatchmentsToTimeSeries
Bridge to save catchment output to dfs0 file
Public classCatchmentSurface
Catchment surface class, handling wetting loss, storage loss, infiltration and evaporation

If Infiltration is not defined, the surface is assumed to be impervious, and no infiltration is applied.

Public classCatchmentTimeArea
Class for Time Area catchment model. See ICatchmentTimeAreaData for parameters availabel when setting up the model.
Public classCatchmentUHM
Class for the UHM rainfall runoff model

The UHM catchment is based on a unit hydrograph, defined as e.g. Hydrograph, where the time and flow are both dimensionless. The time is scaled such that the peak of the hydrograph matches the lagtime (see LagTimeType), and the flow is scaled to assure no mass loss.

Public classCatchmentUHMDimensionlessHydrographPoint
Class to describe a dimensionless hydrograph cell, specifying the time for a flow.

Both the time and the flow is dimensionless. Time is scaled such that the peak of the hydrograph matches the lagtime

Public classCatchmentValueBuffer
Class handling buffering and interpolation in time of catchment values.
Public classEmptyCatchmentPlugin
An empty catchment plugin that does not do anything.
Public classGreenAmptInfiltration
Class containing state for a Green Ampt infiltration calculation
Public classGreenAmptInfiltrationCalculator
Class for calculating infiltration using the Green Ampt infiltration method
Public classHorton
Horton class holds the parameters used for calculation infiltration using the Hortons infiltration.
Public classNAMYearlyStat
Public classPredefinedQuantityTableRR
Dictionary from PredefinedQuantityRR to actual Quantity.
Public classRainfallRunoffClassFactory
Factory class for creating custom classes for RainfallRunoff processing

To use a custom class overriding the default implementation, create a new class that extends from the default implementation and overrides its methods, and add a function here that creates an instance of this new class.

Public classRainfallRunoffData
Access to catchment data
Public classRRExtensions
Static class containing extension methods related to DHI.Mike1D.RainfallRunoffModule
Public classRRHotstartCatchmentData
Class interfacing to hotstart data for one catchment.
Public classRRHotstartFiles
Structure to store hot start files in the form of IResultData objects, and a hot start time.
Public classRRParameters
Class containing parameters for all RR models.
Public classRRPredefinedQuantityData
Static class containing the PredefinedQuantityTableRR.
Public classRRQuantities
Provides methods for creating RR quantities.
Public classRRStatFileWriter
Class for writing the "RRStat.txt" file.
Public classRRTotalStat
Class for reporting total (accumulated) statistics.
Public classRRYearlyStat
Yearly statistics for catchments
Public classStateVariable
A class that provides linear interpolation between to values of a state variable.
Structures
  StructureDescription
Public structureAutocalObjectiveFunction
Objective Function
Public structureAutocalParameter
Autocalibration Parameter
Public structureCatchmentTimeAreaCell
Cell structure: a cell contains a relative area and a unit volume of water in the cell
Public structureCatchmentUHMCell
Cell structure: a cell contains a relative area and a unit volume of water in the cell
Interfaces
  InterfaceDescription
Public interfaceICatchment
Interface to Rainfall Runoff catchments. Specific catchments can inherit from the abstract Catchment class instead of implementing this interface directly.
Public interfaceICatchmentADComponent
Interface for a catchment that supports AD component and AD related inflow from boundaries.
Public interfaceICatchmentCombined
Catchment that combines several other catchments and need knowlege of other catchments.
Public interfaceICatchmentData
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.

Public interfaceICatchmentInfiltrationCalculator
Common interface for calculating infiltration
Public interfaceICatchmentKinematicWaveData
Kinematic wave data interface.

The Kinematic wave rainfall runoff model is also called "Urban B"

In Kinematic Wave model the runoff is computed as flow in an open channel, taking the gravitational and frition forces only. The runoff amount is controlled by the various hydrological losses and the size of the actually contributing area.

Interface for Kinematic Wave catchment model inherits from ICatchmentUrbanData interface.

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.

Public interfaceICatchmentKinematicWaveSurfaceData
Data interface that covers data in a kinematic wave catchment model which varies with the surface type. Note that not all properties are applicable for all surface types.
Public interfaceICatchmentLinearReservoirData
Linear reservoir data interface.

The linear reservoir rainfal runoff model, also called Runoff C in MIKE URBAN Two model types are currently available: the Dutch (C1) and the French model (C2).

Interface for linear reservoir catchment model inherits from ICatchmentUrbanData interface.

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.

Public interfaceICatchmentNamData

Catchment NAM/RDI data interface

NAM is a lumped, conceptual rainfall-runoff model, simulating the overland-, inter-, and base-flow components as a function of the moisture contents in four storages; snow, surface, root-zone and ground water.

This interface contains data and parameters for setting up a NAM model, and is as such a data class only. Computational variables are not included in this class. It can be used to explore data and parameters required when setting up the NAM model.

Public interfaceICatchmentNamInitial
Initial values that is required by the NAM catchment model.
Public interfaceICatchmentPlugin
A generic catchment plugin. An example of such plugin is SWQ module.
Public interfaceICatchmentRunController
Controlling the time stepping of a standalone rainfall runoff simulation is done by this interface. The interface specifies a list of ICatchment that needs explicit time stepping control. These catchments will be updated synchronously, and each update will raise a post time step event in the Catchments class. Furthermore the post time step event of the Catchments class is raised at all times returned by the TimeOfNextUpdate method. This interface is required in order to support at the same time updating catchments to a specified time, as well as updating them per time step.
Public interfaceICatchments Obsolete.
Interface to Rainfall Runoff Model catchments
Public interfaceICatchmentSTComponent
Interface for a catchment that supports AD component and AD related inflow from boundaries.
Public interfaceICatchmentSurfaceData
Catchment surface data interface, setup data for the CatchmentSurface class.

If Infiltration is not defined, the surface is assumed to be impervious, and no infiltration is applied.

Public interfaceICatchmentSWQ
Interface for classes that wants to support SWQ calculations
Public interfaceICatchmentTimeAreaData
Time Area data interface.

The time area rainfall runoff model is also called "Urban A"

Interface for time area catchment model inherits from ICatchmentUrbanData interface.

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.

Public interfaceICatchmentUHMData
Catchment UHM data interface.

This interface contains data and parameters for setting up a UHM model, CatchmentUHM, and is as such a data interface only. Computational variables are not included in this interface. It can be used to explore data and parameters required when setting up the UHM model.

The UHM catchment is based on a unit hydrograph, defined as e.g. Hydrograph, where the time and flow are both dimensionless. The time is scaled such that the peak of the hydrograph matches the lagtime (see LagTimeType), and the flow is scaled to assure no mass loss.

Public interfaceICatchmentUrbanData
ICatchmentUrban is a common data interface for different urban catchment models.

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.

Public interfaceIStormwaterLID
Interface for a stormwater Low-Impact-Development structure.

A stormwater LID is a small scale hydrologic structure, that can store, detain, infiltrate (and/or similar) water close to where the water origin from.

The stormwater LID is attached to a catchment. It can overtake some of the catchment area (TotalCollectingArea and Area).

Delegates
  DelegateDescription
Public delegateCatchmentsTimeEvent
Delegate that is used when triggering a TimeStepPerfomed event.
Enumerations