Click or drag to resize

HDOptions Class

Options for HD calculations
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.HDParameterDataAccessHDOptions

Namespace:  DHI.Mike1D.HDParameterDataAccess
Assembly:  DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class HDOptions

The HDOptions type exposes the following members.

Constructors
  NameDescription
Public methodHDOptions
Default constructor
Top
Properties
  NameDescription
Public propertyApplyNodeMassCorrection
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.

Default value: False

Historically: M11 default false, MU default true.

Public propertyRoutingUseResistanceElevationMethod
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

Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldMUMassBalance
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.

Public fieldMUNaturalCriticalDepth
Use MU approach for calculating natural and critical depth.
Public fieldMUStructureLagFactor
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.

Public fieldMUWlBoundaryTime
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.
Public fieldXSProcessedDerivatives
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.

Top
See Also