FloodMapItemCalculatorVelocity Class

Item calculator to calculate current speed / flow velocity.

It can also be used for other types of Discharge-to-velocity outputs, like AD Transport to AD flux. This is achieved by setting the DataQuantity to the engine quantity to load and/or setting the OutputQuantity to the "velocity" quantity matching the DataQuantity.

If used for mapping dynamic velocity: Keep default options

If used for mapping dynamic AD component flux: Set the DataQuantity to the AD component transport quantity.

If used for mapping maximum velocity: The water level and discharge is stored on H points at the time of maximum velocity. Set both: WaterLevelQuantity and DataQuantity (discharge quantity), and QonH must be set to true.

Definition

Namespace: DHI.Mike1D.FloodMap
Assembly: DHI.Mike1D.FloodMap (in DHI.Mike1D.FloodMap.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class FloodMapItemCalculatorVelocity : IFloodMapItemCalculator
Inheritance
Object    FloodMapItemCalculatorVelocity
Implements
IFloodMapItemCalculator

Constructors

Properties

QonH Bool indicating that Q values are taken from H point. This is the case for maximum velocity mapping.
VelocityDepthQuantity Default velocity-depth quantity
VelocityMethod Method for calculating velocity. Zero is the default
VelocityQuantity Default velocity quantity

Methods

CalculateValues(Single) Calculate values and store them in values
CalculateValues(Single) Calculate values within flood map area
CreateMaxVelocityCalculator Create calculator for maximum velocity
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 Initialize item calculator. This usually involves registering which source quantities to process RegisterHQuantity(IQuantity)RegisterQQuantity(IQuantity) and registering the outputs this calculator produces RegisterOutputQuantity(IQuantity)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

DataQuantity Q-type Quantity to load from engine/data. Can be discharge or AD component flux.

If not set, it takes the default Discharge quantity

OutputQuantity Quantity of output item
WaterLevelQuantity Quantity to load water level from. If not set, it takes the default water level, which is the case for dynamic/timestepping results.

If set, it can be used to extract e.g. a water level at time of maximum velocity.

See Also