Click or drag to resize

HDParameterData Class

HD parameters
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.GenericAbstractDataAccess
    DHI.Mike1D.HDParameterDataAccessHDParameterData

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

The HDParameterData type exposes the following members.

Constructors
  NameDescription
Public methodHDParameterData
Constructor
Top
Properties
  NameDescription
Public propertyAdditionalOutput
Additional outputs, stored in a file matching the HD result file, including "ADDOUT" in the file name
Public propertyAddOns
Add-ons for HD module. With this it is possible to enable specific outputs.
Public propertyBedResistance
Bed resistance
Public propertyCalculateStatistics
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
Public propertyConnection
Holder of read/write information
(Inherited from AbstractDataAccess.)
Public propertyCrossSectionTopSlotWidth
Width of top slot on cross sections
Public propertyCustomTypes
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.)
Public propertyStatic memberDefault
Default HD parameter instance. Do not modify!
Public propertyExtensionData
Holds data from an extended DataContract
(Inherited from AbstractDataAccess.)
Public propertyFloodMap
Flood map specification
Public propertyGroundWaterLeakageFactor
Topographical wind friction factor.

The factor can vary throughout the domain.

Public propertyHDDecoupled
Flag enabling use of HD decoupled result file.
Public propertyHDDecoupledFile
Name of decoupled HD result file.
Public propertyIncludeGroundWaterLeakage
Include ground water leagage.
Public propertyIncludeWind
Include wind in HD calculations
Public propertyInitialConditions
Initial conditions.
Public propertyKinematicViscosity
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

Public propertyMinimumReachLength
Minimum length of reaches Default value: 10m
Public propertyOptions
Options for HD calculations
Public propertyPressureReachAllowManyGridpoints
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
Public propertyPressureReachTopSlotWidth
Width of top slot in pressure reaches. Default value: 0.001
Public propertyShowStatisticsNodeSelection
Nodes to show statistics for
Public propertyShowStatisticsPerGridPointDischarge
If true, then statistics for each discharge grid point is shown in the HD summary. Default value: false
Public propertyShowStatisticsPerGridPointVelocity
If true, then velocity statistics for each discharge grid point is shown in the HD summary. Default value: false
Public propertyShowStatisticsPerGridPointWaterLevel
If true, then statistics for each water level grid point is shown in the HD summary. Default value: false
Public propertyShowStatisticsPerNode
If true, then statistics for each node is shown in the HD summary. Default value: false
Public propertyShowStatisticsPerPump
If true, then statistics for each pump is shown in the HD summary. Default value: false
Public propertyShowStatisticsPerReach
If true, then statistics for each reach is showen in the HD summary. Default value: false
Public propertyShowStatisticsPerReachInput
If true, then statistics for each reach input is shown in the HD summary. Default value: false
Public propertyShowStatisticsPerWeir
If true, then statistics for each weir is shown in the HD summary. Default value: false
Public propertyShowStatisticsReachSelection
Reaches to show statistics for
Public propertySolverSettings
Various parameters and settings for the HD solver
Public propertyUseEnergyLevelSlope
Boolean for calculation of Bed Shear Stress based on an energy level slope. Default off

This parameter should always be false for ST.

Public propertyUserDefinedLevels Obsolete.
Same as UserDefinedNetworkDatas.

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

Public propertyUserDefinedLocations
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.
Public propertyUserDefinedNetworkDatas
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.

Public propertyWaveApproximation
Wave approximation
Public propertyWindFrictionCoefficient
Wind friction factor coefficient

Default value: 0.0025

Public propertyWindFrictionTopoFactor
Topographical wind friction factor.

The factor can vary throughout the domain.

Public propertyWriteSurfaceFloodDuration
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"
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 methodSetMUOptions
Set parameters that are default for MIKE URBAN type applications
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnsetMUOptions
Unset parameters that are default for MIKE URBAN type applications
Public methodValidate
Validates the contents. Files are validated for existance. Large parts of the validations are delegted to the included data access modules.
Top
Fields
  NameDescription
Protected field_connection
Protected holder of read/write info
(Inherited from AbstractDataAccess.)
Public fieldStatic memberBedShearStressBackwardsCompatible
Flag for calculating bed shear stress in old way. Works only for Manning type resistance.
Public fieldLCRV
LCRV
Top
See Also