DHI.Mike1D.BoundaryModule Namespace

Many common tasks for an IBoundaryItem are handled by the AbstractBoundaryItem. It handles:

• Application interval, UseApplicationInterval
• Soft start properties
• Scaling factor

It is up to the class that extends the AbstractBoundaryItem to make sure to utilize above functionality in the GetValue call as described below. There are some helper functions in this class for example to get the soft start factor for a given date/time.

Class containing common code for locations for a source, which can contain as well a point locations as a node locations. It also handles the individual scalefactor that each location can have.

Many common tasks for an IBoundarySource are handled by the AbstractSourceBoundary. All MIKE 1D boundary sources extent from this. Current subclasses include

• OpenSourceBoundary
• PointSourceBoundary
• DistributedSourceBoundary
• GlobalGeoLocatedSource
• StructureSourceBoundary
• CatchmentSourceBoundary
• CatchmentComponentSourceBoundary

The AbstractSourceBoundary has a list of boundary items, Items

The BoundaryData class is the main entrance to boundary data access. It handles boundary conditions and sources.

Bridge for saving and reading boundary data to/from xml.

This will only store the boundary data component.

Utility class, containing extension methods for classes in the BoundaryModule namespace

Constant boundary item implementation.

A boundary item that retrieves its value through a delegate of the type DDoubleTimeGetter. Inherits AbstractBoundaryItem supporting scalefactor, application interval and soft start.

A boundary item consisting of two boundary items that are multiplied together

This boundary item is used by MIKE 11 load, setup as HD inflow + AD concentration, where the HD inflow is ignored, but the AD is included, effectively modelling a load type of AD boundary.

A boundary item with constant values in each month

QH boundary item. Access to a QH table. Gets the water level via a DDoubleGetter

Rainfall runoff boundary item.

Time series boundary item. Generel access to time series items, defined by a full path name, and an item number.

Time series boundary item. Generel access to one time series item.

This is a base class for other time series classes, handling the time and values of a time series, time interpolation etc.

Boundary source for a component, containing either a concentration type source, a load type source, or a specific quantity.

The component sources are used by other than inflow boundaries, as e.g. a wind having a direction and a velocity component. These special types of component sources may require the components in a special order. They are identified by their Quantity value.

The connection to the AD components is defined by the ComponentId value. If that is null or empty, it is not an AD component.

Class for unit conversion of component boundary values

A special kind of boundary, only used when AD module is enabled, which provides component concentrations for catchment inflows.

For a catchment, specifying which cells of a grid that is inside this catchment, and for each cell specifying the weight for calculating the average cell contribution.

Class implementing a list of ICatchmentSourceBoundary's Required for generic list COM interop

Catchment source boundary. All catchments are identified by a catchment ID, string.

Class implementing a list of IDistributedSourceBoundary's Required for generic list COM interop

A distributed source is a source that is applied on a part of the network. It can be a combination of LocationSpans and Links. TODO: Check whether the links are necessary or whether they are just a simpel version of a LocationSpan.

A global source that has a geographical position associated with it.

A global source can have several geo-located sources, and the closest geo-located source can be used.

Class implementing a list of IGlobalSourceBoundary's Required for generic list COM interop

A global source that contributes to the entire network A GeoPoint can be provided, and more than one source of the same type is then valid. The closest source should then be used.

A gridded source is specifying a 2D grid of source values.

Cell weight, indices and weight value

Class implementing a list of IBoundaryItem's Required for generic list COM interop

Class implementing a list of IOpenSourceBoundary's Required for generic list COM interop

An open source boundary is at the boundary of the network, (compared to a point source boundary which can be situated anywhere in the network)

Class implementing a list of IPointSourceBoundary's Required for generic list COM interop

A source located at a specific point in the network. A PointSourceBoundary is always an inflow (a forcing).

QH relation

Structure source boundary. All catchments are identified by a structure ID which is a string. If StructureSourceBoundaryType is StructureSourceBoundaryTypes.DamBreak, then the boundary contains three components: 1) Breach level, 2) Breach width, and 3) Breach slope

Interface for an AbstractLocationSourceBoundary. Adding interfaces for point and node locations. To be extended.

An advanced boundary item adds functionality for scale factor, soft start (gradual start-up) and application interval to the standard IBoundaryItem

Interface handling adaptive time step evaluation. Implemented by as well boundary items as boundary sources

This is the interface for the BoundaryData class Note: Needed for COM interop only - do not use from .Net

A general BoundaryItem interface. AbstractBoundaryItem provides a general implementation of IBoundaryItem.

Interface for a constant boundary item

Base interface for all BoundarySources

Generic interface for modifying boundary values on the fly.

Interface for a list of ICatchmentSourceBoundary's Required for generic list COM interop

Interface for a CatchmentSourceBoundary. Interfaces for Cathcment ID and scalefactors.

Interface for a list of IDistributedSourceBoundary's Required for generic list COM interop

Interface for a DistributedSourceBoundary

Interface for a list of IGlobalSourceBoundary's Required for generic list COM interop

Interface for a GlobalSourceBoundary.

A global source boundary consist of a number of items that are geographically located, stored in the GeoLocatedSources list. If there is only one global item, it must be the first one, and then the GeoLocatedSources needs not have a geo-point, GeoPoint, and UseGeoLocatedSources must return false. If UseGeoLocatedSources returns false, the first item in the GeoLocatedSources is used.

To get the value at a given location, it is up to the user/engine whether to take the closest geo-located item, to interpolate in them or do something else.

You can define a number of items that overrides the global value at certain areas in the network, these are stored in the DistributedOverrides list, that each are an IDistributedSourceBoundary.

Interface for a list of IBoundaryItem's Required for generic list COM interop

Interface for a list of IOpenSourceBoundary's Required for generic list COM interop

Interface to a OpenSourceBoundary Note: Needed for COM interop only - do not use from .Net

Interface for a list of IPointSourceBoundary's Required for generic list COM interop

Interface to a PointSourceBoundary

Interface for a StructureSourceBoundary. Interfaces for Strucure location.

Enum defining if source is missing data within simulation period, see ValidateItemsInSimTime(IListIBoundaryItems, DateTime, DateTime, DateTime)

Currently supported boundary item types. Each has its own class implementing its functionality.

For Component sources, specifies which type of source it is

Types of Boundary sources

Type of Catchmentsource boundary

Type of distributed source inflow

Type of global source boundaries.

Types of opensource boundaries

Type of inflow. Used to limit the total inflow of a specific type.

Types of softstart

Type of Catchmentsource boundary

Defines how a distributed source distributes its source value.