HDParameterData Class

HD parameters

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 HDParameterData : AbstractDataAccess
Inheritance
Object    AbstractDataAccess    HDParameterData

Constructors

HDParameterData Constructor

Properties

AdditionalOutput Additional outputs, stored in a file matching the HD result file, including "ADDOUT" in the file name
AddOns Add-ons for HD module. With this it is possible to enable specific outputs.
BedResistance Bed resistance
CalculateStatistics If true, then statistics from the HD module are calculated during runtime. If simulations are run through DHI.Mike1D.SimLauncher, then the statistics are saved in html format after the simulation is done. Default value: false
Connection Holder of read/write information
(Inherited from AbstractDataAccess)
CrossSectionTopSlotWidth Width of top slot on cross sections
CustomTypes List of custom types stored in the data object and that must be serialized.

A custom type is e.g. a user implemented structure or catchment model. In order to store information on the custom type in the .m1dx file, the system needs to know which custom types are being used, and they must be added to this list.


(Inherited from AbstractDataAccess)
Default Default HD parameter instance. Do not modify!
ExtensionData Holds data from an extended DataContract
(Inherited from AbstractDataAccess)
FloodMap Flood map specification
GroundWaterLeakageFactor Topographical wind friction factor.

The factor can vary throughout the domain.

HDDecoupled Flag enabling use of HD decoupled result file.
HDDecoupledFile Name of decoupled HD result file.
IncludeGroundWaterLeakage Include ground water leakage.
IncludeWind Include wind in HD calculations
InitialConditions Initial conditions.
KinematicViscosity Kinematic viscosity of water [m2/s]. The default value is pure water at 10 degrees Celsius = 0.00000131

The kinematic viscosity depends on the temperature and the quality of the water. Values for pure water for different temperatures:

  • 0 C – 1.785
  • 5 C – 1.519
  • 10 C – 1.306
  • 15 C – 1.139
  • 20 C – 1.003

LocalSolverSettings Various parameters and settings for the HD solver
MinimumReachLength Minimum length of reaches Default value: 10m
Obsolete
Options Options for HD calculations
PressureReachAllowManyGridpoints If false, then pressure reaches have only three grid points (H-Q-H). If true, then grid points are assigned with the same algorithm as used for normal reaches. Default value: false
PressureReachTopSlotWidth Width of top slot in pressure reaches. Default value: 0.001
ShowStatisticsNodeSelection Nodes to show statistics for
ShowStatisticsPerBoundary If true, then statistics for each boundary is shown in the HD summary. Default value: false
ShowStatisticsPerGridPointDischarge If true, then statistics for each discharge grid point is shown in the HD summary. Default value: false
ShowStatisticsPerGridPointVelocity If true, then velocity statistics for each discharge grid point is shown in the HD summary. Default value: false
ShowStatisticsPerGridPointWaterLevel If true, then statistics for each water level grid point is shown in the HD summary. Default value: false
ShowStatisticsPerNode If true, then statistics for each node is shown in the HD summary. Default value: false
ShowStatisticsPerPump If true, then statistics for each pump is shown in the HD summary. Default value: false
ShowStatisticsPerReach If true, then statistics for each reach is showen in the HD summary. Default value: false
ShowStatisticsPerReachInput If true, then statistics for each reach input is shown in the HD summary. Default value: false
ShowStatisticsPerWeir If true, then statistics for each weir is shown in the HD summary. Default value: false
ShowStatisticsReachSelection Reaches to show statistics for
SolverSettings Various parameters and settings for the HD solver
UseEnergyLevelSlope Boolean for calculation of Bed Shear Stress based on an energy level slope. Default off

This parameter should always be false for ST.

UserDefinedLevels Same as UserDefinedNetworkDatas.

This is the old name, but since more than levels can be stored here, it has been renamed.


Obsolete
UserDefinedLocations User defined locations, locations that the user wants to keep track of.

Different types of locations are identified by a string, being the id in the dictionary. For each string, a list of locations are stored.

Node locations can be specified with a chainage value of MinValue.

A Z value can be specified together with the locations.
UserDefinedNetworkDatas User defined data in the network.

Each type of data is identified by a string, being the id of the data type.

UserDefinedMarkers from MIKE 11 is added here.

WaveApproximation Wave approximation
WindFrictionCoefficient Wind friction factor coefficient

Default value: 0.0025

WindFrictionTopoFactor Topographical wind friction factor.

The factor can vary throughout the domain.

WriteSurfaceFloodDuration If this is active, then the HD module will output 1) The "Nodes" table in the HTML summary file is extended with a "Flooding Duration" column 2) The additional output file will contain result items for "Flood Flowrate" and "Flood Volume"

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)
GetSolverSettings(ILocation) Return local solver settings for a location.
GetSolverSettings(String) Return local solver settings for a node id.
GetSolverSettings(String, ILocation) Return local solver settings for a node id and node location.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
SetMUOptions Set parameters that are default for MIKE URBAN type applications
ToStringReturns a string that represents the current object.
(Inherited from Object)
UnsetMUOptions Unset parameters that are default for MIKE URBAN type applications
Validate Validates the contents. Files are validated for existance. Large parts of the validations are delegted to the included data access modules.

Fields

_connection Protected holder of read/write info
(Inherited from AbstractDataAccess)
BedShearStressBackwardsCompatible Flag for calculating bed shear stress in old way. Works only for Manning type resistance.
LCRV LCRV

See Also