HDBoundaryMinMaxCalculator Class

Boundary value calculator allowing for min, max, and accumulated value across the network where the boundary is applied. Values are calculated when UpdateValues is called.

This class is implemented to allow for boundary statistics to be included in the HTML summary if flag ShowStatisticsPerBoundary is set. Data items are set and updated in the individual boundary connectors and used here for statistics. Class could be extended to allow for more statistics if wished for.

Definition

Namespace: DHI.Mike1D.Engine.AddOns
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class HDBoundaryMinMaxCalculator : HDAbstractMinMaxCalculator
Inheritance
Object    EngineDataItemAllBaseMinMaxValueContainer    EngineDataItemAllArrayMinMaxValueContainer    HDAbstractMinMaxCalculator    HDBoundaryMinMaxCalculator

Constructors

HDBoundaryMinMaxCalculator Boundary value calculator allowing for min, max, and accumulated value across the network where the boundary is applied. Values are calculated when UpdateValues is called.

This class is implemented to allow for boundary statistics to be included in the HTML summary if flag ShowStatisticsPerBoundary is set. Data items are set and updated in the individual boundary connectors and used here for statistics. Class could be extended to allow for more statistics if wished for.

Properties

BoundaryDataItemContainer 
BoundaryID 
DataItem 
DataItemFlow 
EngineNet 
FlowAccumulated Accumulated flow of applied boundary source over the entire network and entire simulation.
FlowMax Maximum value of applied boundary source flow over the entire network during a timestep.
FlowMaxArea Flow area corresponding to FlowMax
FlowMaxTime Time of FlowMax
FlowMin Minimum value of applied boundary source flow over the entire network during a timestep.
FlowMinArea Flow area corresponding to FlowMin
FlowMinTime Time of FlowMin
FlowSum Sum of applied boundary source over the entire network during a timestep.
IsFlowDataItem 
Max Maximum value of applied boundary source over the entire network during a timestep.
Min Minimum value of applied boundary source over the entire network during a timestep.

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)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Init Init MinMaxValueContainer for relevant nodes and reach grid points
(Inherited from HDAbstractMinMaxCalculator)
InitNodes Init MinMaxValueContainer for relevant nodes
(Inherited from HDAbstractMinMaxCalculator)
InitReaches Init MinMaxValueContainer for relevant reaches
(Inherited from HDAbstractMinMaxCalculator)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare data item for simulation, calling Reset.
(Inherited from HDAbstractMinMaxCalculator)
ToStringReturns a string that represents the current object.
(Inherited from Object)
UpdateValues Update values of all pull items
(Overrides EngineDataItemAllBase.UpdateValues)

See Also