HDOptions Class

Options for HD calculations

Definition

Namespace: DHI.Mike1D.HDParameterDataAccess
Assembly: DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class HDOptions
Inheritance
Object    HDOptions

Constructors

HDOptions Default constructor

Properties

ApplyNodeMassCorrection Flag specifying if node mass correction is applied. At end of each time step, the mass error is estimated, and in the next time step the lost/additional mass is added as a source/zink to the node. From v2021u1 an onwards, mass balance is NOT corrected at pressure nodes in order to resemble MOUSE behaviour. Mass balance correction at pressure nodes can be switched on by setting the option ApplyPressureNodeMassCorrection to true.

Default value: False

Historically: M11 default false, MU default true.

ApplyPressureNodeMassCorrection Flag specifying if mass balance correction is also applied at pressure nodes. Default is false, to be backwards compatible with the versions >= 2021u1. This flag ONLY takes effect if the flag ApplyNodeMassCorrection is already set to true (which is default for CS applications).
RoutingUseResistanceElevationMethod Flag specifying if routing reaches without a routing element by default should apply the resistance elevation method.

When used together with MIKE SHE, the common value is true.

Default value: True

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)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

MUMassBalance Use MU approach for mass balance on H grid point

Adding a bottom slope correction in order to get depth interpolated between H and prev/next Q point and use those to average a storage width at the H point

For closed circular and rectangular, adds a storage width derivative to the equations (d(SW)/d(h)), to lessen mass errors. Only applicable if using one iteration per time step.

MUNaturalCriticalDepth Use MU approach for calculating natural and critical depth.
Obsolete
MUStructureLagFactor Value between 0 and 0.5, for lagging a structure discharge calculation, scaling between newly calculated value and value from previous time step. Set to 0 to disable (using fully new value) and set to 0.5 to weight the two equally.

This is not applicable if using more than one iteration per time step.


Obsolete
MUWlBoundaryTime Use MU approach at water level boundaries, using water level at time N+½ for level at time N+1. For backward compatibility, because approach is incorrect.
Obsolete
XSProcessedDerivatives Create processed data arrays for processed data derivatives.

If disabled, processed data derivatives are calculated from original data. When enabled, derivatives are smooth and more accurate.

The processed data derivatives are used to calculate high order friction factor.

M11 approach is to disable this.

See Also