DHI.Mike1D.Engine.AddOns Namespace

Engine add-ons, for calculating various derived data.

Classes

ADDecayAccumulatedCalculator Engine data item that calculcates the accumuated decay in mass units, usually [kg]. Data item is updated every time step
ADMassErrorAccumulatedCalculator Data Item for calculating the accumulated mass error or mass balance checksum.

The data item can either accumulate with sign, or accumulate the absolute values of the error/checksum.

HDAbstractMinMaxCalculator Base class for some of the MinMaxCalculator implementations.

Override the UpdateValues and update all the MinMaxValueContainer's.

Also check out the StatisticsItem, which does something similar, but is based on value-getters and the proxy system, i.e. fully configurable. This class allows for implementing direct access to values, without depending on getters and the proxy system.

HDBedShearStressCalculator Calculator class to calculate bed shear stress
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.

HDDischargeOfFullPipeCalculator Pull version of calculating discharge of a full pipe on q-grid points Data is calculated when GetValues is called. For reaches that do not run full (open channel that are not pipes) null is returned.
HDDischargeStepAveraged A calculator that calculates the mass error for the latest time step.
HDFloodedArea Helper class for calculating total flooded area in network

Flooded area is surface area of open parts of the network.

HDInOutFlowCalculator Helper class providing the inflow to the network.

This is a lazy/pull driven version, only retrieving values when required. If the same values are retrieved more than once, they are recalculated from scratch.

HDMassErrorAccumulatedCalculator A calculator that sums up the mass error for all time steps.

The calculator is based on an HDMassErrorCalculator, which must be created first, and it must also be updated before this calculator, in order to get the correct mass error numbers. Hence, this must be added AFTER the HDMassErrorCalculator to the list of data items in the DataModule

HDMassErrorAccumulatedChecksumCalculator A calculator that calculates a mass error check sum accumulated since start of simulation
HDMassErrorCalculator A calculator that calculates the mass error for the latest time step.
HDMassErrorChecksumCalculator A calculator that calculates a mass error check sum for the latest time step.
HDTotalInOutflowCalculator Helper class to calculate the total inflow/outflow to/from the entire network, for many different categories.
HDVelocityCalculator Pull version of calculating velocity on grid points Data is calculated when GetValues are called
HDWaterFlowRateAboveGroundCalculator Engine data item that can provide the water volume in nodes above ground.

This version only calculates values on request, using buffering in case values are requested more than once.

HDWaterMaxVolumeCalculator Engine data item that can provide the maximum volume in the network. The maximum volume is only calculated once (ie the network is assumed to be static)

Pull version only calculates values on request.

HDWaterVolumeCalculator Engine data item that can provide the volume in the network.

Handles the total volume, and only volume in reaches and nodes in case M11Compatibility is set.

HDWaterVolumeChangeCalculator Helper class to calculate the change of volume of water in a timestep in the network
HDWaterVolumeInNodesAboveGroundCalculator Engine data item that can provide the water volume in nodes above ground.

This version only calculates values on request, using buffering in case values are requested more than once.

HDWaterVolumeRetainedInMaxInflowToNodesCalculator Engine data item that can provide the water volume that is retained in nodes with a restriction in inflow capacity. This will always be zero unless the inflow to a node is restricted.

This version only calculates values on request, using buffering in case values are requested more than once.

SummedQuantityCalculator Calculator giving summed value of quantity from a given part of the network.
SummedQuantityCalculatorData Global engine data storing summed value of quantity from a given part of the network.
SummedQuantityItem Engine data item providing summed values for quantity from a given part of the network.

Enumerations

HDInOutFlowType Enum for different types of in and out flow.
HDTotalInOutflowCalculatorFlowCategory Types of inflow or outflow to return.