Click or drag to resize

AbstractBoundaryItem Class

Many common tasks for an IBoundaryItem are handled by the AbstractBoundaryItem. It handles: 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.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.BoundaryModuleAbstractBoundaryItem
    More...

Namespace:  DHI.Mike1D.BoundaryModule
Assembly:  DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
Copy
public abstract class AbstractBoundaryItem : IAdvancedBoundaryItem, 
	IBoundaryItem

The AbstractBoundaryItem type exposes the following members.

Constructors
  NameDescription
Protected methodAbstractBoundaryItem
Initializes a new instance of the AbstractBoundaryItem class
Top
Properties
  NameDescription
Public propertyApplicationBegin
Start datetime of the application of the item.

If user specified values are set, remember also to set the UseApplicationInterval

Remarks
If UseApplicationInterval is false, this is set automatically during prepare phase to either
  • Globally: Simulation start time
  • Locally: Item source start time (typically timeseries file start)
Public propertyApplicationEnd
End datetime of the application of the item

If user specified values are set, remember also to set the UseApplicationInterval

Public propertyEumQuantity
EUM quantity of boundary item.

Used for validation and in AD also for unit conversion.

Public propertyIsDryWeatherFlow
Boundary items can be marked as "dry weather flow" (used in MIKE URBAN). This is used in Long Term Simulation to exclude dry weather flow from the total inflow when evaluating how to start a new LTS job (if selecting a new hot start file)

This flag has no effect on the simulation, only on LTS job evaluations.

Public propertyScaleFactor
A factor by which values are scaled. Default 1.0.

Only valid for certain item types, e.g., load/inflow types, not for types like waterlevel.

Public propertySoftstartDuration
Duration of softstart period. Default 0
Public propertySoftstartType
Type of softstart. Default none

Softstart does not make sense for all boundary types, typically only for those that otherwise can be disabled/left out of the simulation.

Softstart starttime is ApplicationBegin which if not set explicitly is either
  • Globally: Simulation start time
  • Locally: Item source start time (typically timeseries file start)
Public propertySoftstartValue
Softstart initial value. Default 0.0
Public propertyUseApplicationInterval
Boolean specifying whether the application of the item is limited in time

Set this flag if user specified values of ApplicationBegin and ApplicationEnd is to be used. If this flag is not set the application begin and end time will be overwritten/controlled by the Boundary Data, set in Prepare(DateTime, DateTime, IDiagnostics) or by the individual boundary item.

Top
Methods
  NameDescription
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 methodGetAccumulatedValue

Get boundary value accumulated over the specified period.

It is the callers responsibility to check if the item is applicable at the given datetime before calling GetAccumulatedValue.

If the item is only applicable over a part of the interval, it must return the accumulated value for that part of the interval.

Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNextTransitionTime
Default implementation of GetNextTransitionTime(DateTime) returning the incoming datetime as the next transition time
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue

Get boundary value at specified date/time.

It is the callers responsibility to check if the item is applicable at the given datetime before calling GetValue.

Public methodIsApplicable(DateTime)
Checks whether the item is applicable at the given datetime.
Public methodIsApplicable(DateTime, DateTime)
Checks whether the item is applicable at the given time interval. It returns true also if the item covers only a part of the start-end interval
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare item for simulation.
Protected methodSoftstartAccumulatedWeighting
Weights the accumulatedValue with the hot-start value.
Protected methodSoftstartFactor
Calculate the strength factor of the softstart. Uses _applicationBegin as the startup Usage: a = SoftStartFactor(t); Value = (1-a)*_softstartValue + (a)*Value;
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
Validate this
Top
Fields
See Also
Inheritance Hierarchy