CompositStructure Class

Composite structure is a structure which contains one or more structures at the same location. Uses the Composite Pattern.

Definition

Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class CompositStructure : ICompositStructure
Inheritance
Object    CompositStructure
Implements
ICompositStructure

Constructors

CompositStructureInitializes a new instance of the Object class.

Properties

CriticalFlowConditionCalculator 
CriticalFlowConditionsCalculation Flag specifying that calculations are performed when generating critical flow condition tables.
dDischargedDownStreamWaterLevel Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. The value is calculated by SetWaterLevels. Unit: [m^2/s]
dDischargedUpStreamWaterLevel Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. The value is calculated by SetWaterLevels. Unit: [m^2/s]
dHeadLossDischarge Head loss derivative with respect to discharge
Diagnostics Validate composite structure
Discharge Calculated Discharge. The value is calculated by SetWaterLevels. Unit: [m^3/s]
FrictionGetter A delegate which returns friction factor.
GenerateCriticalFlowConditions Flag specifying to generate critical flow condition tables when the whole composite structure is taken into account.
HeadLoss Head loss for HeadLossMode true.
HeadLossMode True if Head Loss coefficients should be set up
ID 
InvertLevelDownstream Invert level downstream Unit: [m]
InvertLevelUpstream Invert level upstream Unit: [m]
Location Location property.
MaximumIterations Maximum number of iterations
MinimalFlowFractionInHeadLossMode Minimal flow fraction in head loss structures needed to perform head loss mode calculations. For smaller values discharge mode calculations are performed.
Residual Get residual of composite structure energy equation.
SkipInitialGuess Skip initial guess for energy equation solver.
SolverMethod Solver methods for composite structures.
StationaryStateCalculation Temporarily disable head loss mode. Used when searching for stationary state.
Structures List of structures of the composite structure.
TotalIterations Total number of composit structure iterations.

Methods

Add Add structure.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Evaluate(StructureParametersFromHD) Calculates structure discharge based on parameters from HD module (upstream and downstream water levels, etc.)
Evaluate(Double, Double) Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
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)
Initialize Initialize the composite structure
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare for simulation
PrepareTimeStep Prepare structure for time step

This method need only be called in case structures are being controlled and i.e. a gate is closing with a specified speed and needs to know time.

ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.

See Also