HPointCourant Class

Class in charge of executing the time step network analysis based on the courant number, used as target for the analysis.

Definition

Namespace: DHI.Mike1D.Mike1DDataAccess.NetworkAnalysisTool
Assembly: DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class HPointCourant : HPointBase, 
	IHPointAnalysis
Inheritance
Object    HPointBase    HPointCourant
Implements
IHPointAnalysis

Constructors

HPointCourant Constructor of the Hpoint for courant number analysis.

Properties

BottomLevel Bottom level of the Cross Section.
(Inherited from HPointBase)
CourantNbLimit Courant number limit to be used in the courant analysis.
CrossSection Crossection associated to the H-point and that is used for the Network analysis.
(Inherited from HPointBase)
Location location of the H-point.
(Inherited from HPointBase)
WaterDepth WaterDepth for the Hpoint
(Inherited from HPointBase)

Methods

CalculateTimeStepLimit Calculates the local time step, so the target courant number is reached. In principle it functions as an upper limit for the time step to be used.
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)
GetValue Returns the maximum time steps for which the courant number satisfied the given target value. It is computed so the courant number conditions is reached.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
SetFullCrossSectionDepth Sets the WaterDepth to the equivalent of the Full cross section: This means in practice: a) for open cross section, the minimum between marker 1 and marker 3. b) for closed cross sections, the maximum height of the cross section.
(Inherited from HPointBase)
SetLowFlowCrossSectionDepth Sets the WaterDepth to the equivalent of the low flow cross section: This means in practice: a) for open cross section, the minimum between marker 4 and marker 5 if any of these exists. b) If hese do not exist, the water depth will be set as full cross section i.e., method SetFullCrossSectionDepth will be use instead.
(Inherited from HPointBase)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

NeighbourPointsDistance distance between the upstream and downstream immediate nodes.

See Also