HSurfaceAreaAnalysisTool Class

Classs in charge of executing a surface analysis of a 1-D water flow network.

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 HSurfaceAreaAnalysisTool : NetworkAnalysisTool, 
	INetworkAnalysisTool
Inheritance
Object    NetworkAnalysisTool    HSurfaceAreaAnalysisTool
Implements
INetworkAnalysisTool

Constructors

HSurfaceAreaAnalysisTool Constructor for the network analysis tool.

Properties

FixedWaterDepth Waterdepth used along the newtwork to perform the network analysis.
(Inherited from NetworkAnalysisTool)
NbOfReportingPoints It specifies the maximum number of report points the log report should include.
(Inherited from NetworkAnalysisTool)
TargetCourantNb Target courant number to be used when executing the network analysis. The analysis finds the time step that will match the given target courant number.
(Inherited from NetworkAnalysisTool)
WaterDepthCondition Waterdepth condition to be used in the analysis. It can be one of the following: 1) Fixed value, 2) Initial conditions, 3) Full cross sections, 4) Low flow conditions.
(Inherited from NetworkAnalysisTool)

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)
GetSortedHPointList Returns the sorted Hpoints according to the analysis criterion.
(Inherited from NetworkAnalysisTool)
GetTypeGets the Type of the current instance.
(Inherited from Object)
ImplementFullCrossectionDepths Implements the full cross section water depth to be used in the network analysis.
(Inherited from NetworkAnalysisTool)
ImplementInitialConditions Implements the model's initial conditions to be used for the numerical stability analuysis.
(Inherited from NetworkAnalysisTool)
ImplementLowFlowConditions Implements low flow conditions to be used for the analysis.
(Inherited from NetworkAnalysisTool)
MakeParametersList Creates the parameter list to be included in the report.
(Overrides NetworkAnalysisToolMakeParametersList)
MakeReport Creates the log report of the network stability analysis.
(Inherited from NetworkAnalysisTool)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
RunAnalysis Main method for starting the application.
(Overrides NetworkAnalysisToolRunAnalysis)
SetArguments Transfers the arguments into the analysis tool.
ToStringReturns a string that represents the current object.
(Inherited from Object)
UpdateCourantNumber Computes and sort the time steps according to the target courant number.
(Inherited from NetworkAnalysisTool)

Fields

AnalysisType This variable will specify the type of analysis to be done.
(Inherited from NetworkAnalysisTool)
Controller Controller related to the Mike1D model to be analyzed.
(Inherited from NetworkAnalysisTool)
HPointListSorted List of sorted Hpoints, according to the criteria.
(Inherited from NetworkAnalysisTool)
Parameters Set of parameters to be used.
(Inherited from NetworkAnalysisTool)
Warnings Warnings to pass to the analysisReporter
(Inherited from NetworkAnalysisTool)

See Also