Click or drag to resize

IGlobalSourceBoundary Interface

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.

Namespace:  DHI.Mike1D.BoundaryModule
Assembly:  DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public interface IGlobalSourceBoundary

The IGlobalSourceBoundary type exposes the following members.

Properties
  NameDescription
Public propertyApplicationType
Flag specifying where this boundary is applied.
Public propertyDistributedOverrides
List of distributed boundaries that overrides the global value
Public propertyGeoLocatedSources
List of Geo Located Items. It is allowed not to set the Geo Point only if the list contains one item. If the list contains more than one item, it is required that all Geo Located Items have a valid Geo Point, otherwise an error message will be thrown.
Public propertyGlobalSourceBoundaryType
Type of Global source boundary.
Public propertyGriddedSources
List of gridded sources.

In case of overlap of grids, the order in the list is determining priority.

Public propertyUseGeoLocatedSources
True if the global boudary has to use the geo located items or not. False by default.
Top
Methods
  NameDescription
Public methodValidate
Validate whether this source is correctly setup
Top
Extension Methods
  NameDescription
Public Extension MethodDistributionType
Type of distribution on reaches for the global boundary type
(Defined by BoundaryExtensions.)
Top
See Also