BoundaryItemQH Class

Q(h) boundary item. Access to a Q(h) table. Gets the water level via a DDoubleGetter

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 class BoundaryItemQH : AbstractBoundaryItem, 
	IAdvancedBoundaryItem, IBoundaryItem, IExtensibleDataObject
Inheritance
Object    AbstractBoundaryItem    BoundaryItemQH
Implements
IAdvancedBoundaryItem, IBoundaryItem, IExtensibleDataObject

Constructors

BoundaryItemQH Create Q-h boundary item with specified size of Q-h table

Properties

ApplicationBegin 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)

(Inherited from AbstractBoundaryItem)
ApplicationEnd End datetime of the application of the item

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


(Inherited from AbstractBoundaryItem)
EumQuantity EUM quantity of boundary item.

Used for validation and in AD also for unit conversion.


(Overrides AbstractBoundaryItemEumQuantity)
ExtensionData Data from an extended DataContract not recognized here
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)

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


(Inherited from AbstractBoundaryItem)
QHTable Q(h) table of values. X is h and Y is Q.
ScaleFactor 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.


(Inherited from AbstractBoundaryItem)
SoftstartDuration Duration of softstart period. Default 0
(Inherited from AbstractBoundaryItem)
SoftstartType 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)

(Inherited from AbstractBoundaryItem)
SoftstartValue Softstart initial value. Default 0.0
(Inherited from AbstractBoundaryItem)
UseApplicationInterval 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.


(Inherited from AbstractBoundaryItem)

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows 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. QH boundaries are used by directly accessing the Qh table
(Overrides AbstractBoundaryItemGetAccumulatedValue(DateTime, DateTime))
GetDeleteValue returns the delete value to this boundary
(Inherited from AbstractBoundaryItem)
GetHashCodeServes 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)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetValue Not implemented. QH boundaries are used by directly accessing the Qh table
(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)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare item for simulation.
(Inherited from AbstractBoundaryItem)
SetValues Set values to Q-h table at specified index
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)
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Validate this Qh table
(Overrides AbstractBoundaryItemValidate)

Fields

Extension Methods

See Also