BoundaryData Class

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

Definition

Namespace: DHI.Mike1D.BoundaryModule
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class BoundaryData : AbstractDataAccess, 
	IBoundaryData
Inheritance
Object    AbstractDataAccess    BoundaryData
Implements
IBoundaryData

Constructors

BoundaryData Creates an empty BoundaryData component.

Properties

CatchmentComponentSourceBoundaries Catchment component source boundaries are AD component boundaries that are handled by the catchment (by a catchment plugin). The catchment calculates an AD load/concentration which can be outputted and added to the network.

These boundaries will not be applied to runoff from a catchment result file (CatchmentResultFiles). Concentrations for those must be specified in Components, or ComponentResultFiles.

The net-rainfall catchment quantity version is special. This requires also HD, because only at that point in time it is known exactly how much rain that falls on the river surface.

CatchmentResultFiles List of catchment result files, containing rainfall runoff and/or catchment discharge.
CatchmentSourceBoundaries Catchment source boundaries, sources for catchment models, as e.g. rainfall and evaporation. These can be specified for each catchment individually here. If specifying rain etc. globally or based on coordinates, used the GlobalSourceBoundaries.
Connection Holder of read/write information
(Inherited from AbstractDataAccess)
CustomTypes List of custom types stored in the data object and that must be serialized.

A custom type is e.g. a user implemented structure or catchment model. In order to store information on the custom type in the .m1dx file, the system needs to know which custom types are being used, and they must be added to this list.


(Inherited from AbstractDataAccess)
DistributedSourceBoundaries Get a list of all distributed source boundaries
ExtensionData Data from an extended DataContract not recognized here
(Overrides AbstractDataAccessExtensionData)
GlobalSourceBoundaries Get a list of all global source boundaries
OpenSourceBoundaries Get a list of all open source boundaries
PointSourceBoundaries Get a list of all point source boundaries
RuntimeDiagnostics Runtime diagnostics object.

Issues during runtime are reported to this object.

StructureSourceBoundaries Get a list of all catchment source boundaries
TsBuffer A buffer containing all timeseries, so they can be reused as much as possible.

Methods

Append Append data from another file defined by its connection to the current Boundary data object
CreateRuntimeDiagnostics Create runtime diagnostics object
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetDistributedSourceBoundariesForType Engine functionality. Get IDistributedSourceBoundary list for all IDistributedSourceBoundary's of a given DistributedSourceBoundaryTypes
GetGlobalSource(GlobalSourceBoundaryTypes) Gets the GlobalSourceBoundary that handles the globalSourceBoundaryType. Null if not existing in the list.
GetGlobalSource(GlobalSourceBoundaryTypes, GlobalSourceApplicationTypes) Gets the GlobalSourceBoundary that handles the globalSourceBoundaryType. Null if not existing in the list.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetOpenSourceBoundariesForType Engine functionality. Get IOpenSourceBoundary list for all IOpenSourceBoundary's of a given OpenSourceBoundaryTypes.
GetOrCreateGlobalSource(GlobalSourceBoundaryTypes) Gets the GlobalSourceBoundary that handles the globalSourceBoundaryType. Null if not existing in the list.
GetOrCreateGlobalSource(GlobalSourceBoundaryTypes, GlobalSourceApplicationTypes) Gets the GlobalSourceBoundary that handles the globalSourceBoundaryType. Null if not existing in the list.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare the object for a simulation
PrepareComponents Prepare the object for AD/ST integration, setting output unit from boundary system for all components
Save Save the data to the file defined by the Connection File will be overwritten if existing.
ShareTsBuffer Share TS buffer to all time series boundary items that is connected to any boundary source in the boundary data object.

Only boundary sources deriving from AbstractSourceBoundary will be considered, since that contains the only known list of boundary items.

ToStringReturns a string that represents the current object.
(Inherited from Object)
TotalNumberOfInflowBoundaries Returns the total number of inflow boundaries
TotalNumberOfQhBoundaries Returns the total number of inflow and QH boundaries
Validate Validates the object

Fields

_connection Protected holder of read/write info
(Inherited from AbstractDataAccess)

Extension Methods

FindOpenSourceBoundaries Find open source boundaries for the location.
(Defined by BoundaryExtensions)
FindOpenSourceBoundary Find open source boundary for the location. Returns the first one found (i.e. does not check if there is more than one).
(Defined by BoundaryExtensions)
RemoveOpenSourceBoundary Remove boundary at location. If boundary is used in more than one location, only the location is removed from the boundary, otherwise the entire boundary is removed.
(Defined by BoundaryExtensions)

See Also