BoundaryItemDDoubleGetter Class |
Namespace: DHI.Mike1D.BoundaryModule
The BoundaryItemDDoubleGetter type exposes the following members.
Name | Description | |
---|---|---|
BoundaryItemDDoubleGetter |
Default constructor (for COM interop)
| |
BoundaryItemDDoubleGetter(FuncDateTime, Double) |
Constructor initialized with the delegate.
|
Name | Description | |
---|---|---|
ApplicationBegin |
Start datetime of the application of the item.
(Inherited from AbstractBoundaryItem.)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
| |
ApplicationEnd |
End datetime of the application of the item
(Inherited from AbstractBoundaryItem.)If user specified values are set, remember also to set the UseApplicationInterval | |
EumQuantity |
EUM quantity of boundary item.
(Overrides AbstractBoundaryItemEumQuantity.)Used for validation and in AD also for unit conversion. | |
Getter |
The delegate used to extract the value for the item
| |
IsDryWeatherFlow |
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)
(Inherited from AbstractBoundaryItem.)This flag has no effect on the simulation, only on LTS job evaluations. | |
ScaleFactor |
A factor by which values are scaled. Default 1.0.
(Inherited from AbstractBoundaryItem.)Only valid for certain item types, e.g., load/inflow types, not for types like waterlevel. | |
SoftstartDuration |
Duration of softstart period. Default 0
(Inherited from AbstractBoundaryItem.) | |
SoftstartType |
Type of softstart. Default none
(Inherited from AbstractBoundaryItem.)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
| |
SoftstartValue |
Softstart initial value. Default 0.0
(Inherited from AbstractBoundaryItem.) | |
UseApplicationInterval |
Boolean specifying whether the application of the item is limited in time
(Inherited from AbstractBoundaryItem.)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. |
Name | Description | |
---|---|---|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetAccumulatedValue |
Not implemented
(Overrides AbstractBoundaryItemGetAccumulatedValue(DateTime, DateTime).) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetNextTransitionTime |
Default implementation of GetNextTransitionTime(DateTime)
returning the incoming datetime as the next transition time
(Inherited from AbstractBoundaryItem.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValue |
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.
(Overrides AbstractBoundaryItemGetValue(DateTime).) | |
IsApplicable(DateTime) |
Checks whether the item is applicable at the given datetime.
(Inherited from AbstractBoundaryItem.) | |
IsApplicable(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
(Inherited from AbstractBoundaryItem.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Prepare |
Prepare item for simulation.
(Inherited from AbstractBoundaryItem.) | |
SoftstartAccumulatedWeighting |
Weights the accumulatedValue with the hot-start value.
(Inherited from AbstractBoundaryItem.) | |
SoftstartFactor |
Calculate the strength factor of the softstart.
Uses _applicationBegin as the startup
Usage:
a = SoftStartFactor(t);
Value = (1-a)*_softstartValue + (a)*Value;
(Inherited from AbstractBoundaryItem.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
Validate |
Not implemented
(Overrides AbstractBoundaryItemValidate.) |
Name | Description | |
---|---|---|
_applicationBegin | See ApplicationBegin (Inherited from AbstractBoundaryItem.) | |
_applicationEnd | See ApplicationEnd (Inherited from AbstractBoundaryItem.) | |
_scaleFactor | See ScaleFactor (Inherited from AbstractBoundaryItem.) | |
_softstartDuration | (Inherited from AbstractBoundaryItem.) | |
_softstartType | See SoftstartType (Inherited from AbstractBoundaryItem.) | |
_softstartValue | See SoftstartValue (Inherited from AbstractBoundaryItem.) | |
_useApplicationInterval | (Inherited from AbstractBoundaryItem.) |