BoundaryExtensions Class

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

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 static class BoundaryExtensions
Inheritance
Object    BoundaryExtensions

Methods

DistributionType Type of distribution on reaches for the global boundary type
FindOpenSourceBoundaries Find open source boundaries for the location.
FindOpenSourceBoundary Find open source boundary for the location. Returns the first one found (i.e. does not check if there is more than one).
FindTimeNextValue Findes the time where the boundary source has a value that is non-zero. The time interval is within the provided limits.
GetAccumulatedValue(IBoundaryItem, DateTime, DateTime, TimeSpan) Method for IBoundaryItem implementing GetAccumulatedValue(DateTime, DateTime, TimeSpan)
GetAccumulatedValue(IBoundarySource, DateTime, DateTime, TimeSpan) Method for IBoundarySource to support items implementing GetAccumulatedValue(DateTime, DateTime, TimeSpan)
GetAccumulatedValueNoItemOverlap(IListIBoundaryItem, DateTime, DateTime)

Get boundary value accumulated over the specified period, looping over all the items and taking their application interval into account, only allowing for one value at a time, i.e. not summing up if two items are applicable at the same time.

If no item is applicable, a zero value is assumed.

GetAccumulatedValueNoItemOverlap(IListIBoundaryItem, DateTime, DateTime, TimeSpan)

Get boundary value accumulated over the specified period, looping over all the items and taking their application interval into account, only allowing for one value at a time, i.e. not summing up if two items are applicable at the same time.

Accumulation time is computed, indicating periods where values are undefined.

If no item is applicable, a zero value is assumed.

GetBoundaryPreferredTimeStep For a generic boundary, estimate the preferred time step, based in some tolerances for how much the boundary can change within a time step.
HasCatchmentType Check if global boundary type has a matching catchment boundary type.
HasGlobalType Check if catchment boundary type has a matching global boundary type.
HasWeights Returns true if weights are defined for this catchment.
IsCatchmentDischargeType(CatchmentSourceBoundaryTypes) Returns true if the catchment source type is a catchment discharge type
IsCatchmentDischargeType(GlobalSourceBoundaryTypes) Returns true if the catchment source type is a catchment discharge type
IsLoad Check if boundary source component is a load
OutputQuantity(DistributedSourceBoundaryTypes) Get output quantity for distributed source
OutputQuantity(GlobalSourceBoundaryTypes) Get output quantity for global source
OutputQuantity(OpenSourceBoundaryTypes) Get output quantity for open boundary source
OutputQuantity(PointSourceBoundaryInflowTypes) Get output quantity for point source
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.
Rescale Rescale weights for all catchments that has weights defined.
ToCatchmentType Convert a global boundary type to a catchment boundary type.
ToGlobalType Convert a catchment boundary type to a global boundary type. If there is no corresponding global type, an exception is thrown.

See Also