Click or drag to resize

BoundaryData Class

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

Namespace:  DHI.Mike1D.BoundaryModule
Assembly:  DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class BoundaryData : AbstractDataAccess, 
	IBoundaryData

The BoundaryData type exposes the following members.

Constructors
  NameDescription
Public methodBoundaryData
Creates an empty BoundaryData component.
Top
Properties
  NameDescription
Public propertyCatchmentComponentSourceBoundaries
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.

Public propertyCatchmentResultFiles
List of catchment result files, containing rainfall runoff and/or catchment discharge.
Public propertyCatchmentSourceBoundaries
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.
Public propertyConnection
Holder of read/write information
(Inherited from AbstractDataAccess.)
Public propertyCustomTypes
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.)
Public propertyDistributedSourceBoundaries
Get a list of all distributed source boundaries
Public propertyExtensionData
Data from an extended DataContract not recognized here
(Overrides AbstractDataAccessExtensionData.)
Public propertyGlobalSourceBoundaries
Get a list of all global source boundaries
Public propertyOpenSourceBoundaries
Get a list of all open source boundaries
Public propertyPointSourceBoundaries
Get a list of all point source boundaries
Public propertyRuntimeDiagnostics
Runtime diagnostics object.

Issues during runtime are reported to this object.

Public propertyStructureSourceBoundaries
Get a list of all catchment source boundaries
Public propertyTsBuffer
A buffer containing all timeseries, so they can be reused as much as possible.
Top
Methods
  NameDescription
Public methodAppend
Append data from another file defined by its connection to the current Boundary data object
Public methodCreateRuntimeDiagnostics
Create runtime diagnostics object
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetDistributedSourceBoundariesForType
Engine functionality. Get IDistributedSourceBoundary list for all IDistributedSourceBoundary's of a given DistributedSourceBoundaryTypes
Public methodGetGlobalSource
Gets the GlobalSourceBoundary that handles the globalSourceBoundaryType. Null if not existing in the list.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetOpenSourceBoundariesForType
Engine functionality. Get IOpenSourceBoundary list for all IOpenSourceBoundary's of a given OpenSourceBoundaryTypes.
Public methodGetOrCreateGlobalSource(GlobalSourceBoundaryTypes)
Gets the GlobalSourceBoundary that handles the globalSourceBoundaryType. Null if not existing in the list.
Public methodGetOrCreateGlobalSource(GlobalSourceBoundaryTypes, GlobalSourceApplicationTypes)
Gets the GlobalSourceBoundary that handles the globalSourceBoundaryType. Null if not existing in the list.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare the object for a simulation
Public methodPrepareComponents
Prepare the object for AD/ST integration, setting output unit from boundary system for all components
Public methodSave
Save the data to the file defined by the Connection File will be overwritten if existing.
Public methodShareTsBuffer
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.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTotalNumberOfInflowBoundaries
Returns the total number of inflow and QH boundaries
Public methodValidate
Validates the object
Top
Fields
  NameDescription
Protected field_connection
Protected holder of read/write info
(Inherited from AbstractDataAccess.)
Top
Extension Methods
  NameDescription
Public Extension MethodFindOpenSourceBoundaries
Find open source boundaries for the location.
(Defined by BoundaryExtensions.)
Public Extension MethodFindOpenSourceBoundary
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.)
Public Extension MethodRemoveOpenSourceBoundary
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.)
Top
See Also