ICompositStructure Interface

Collection of structures at the same location. Interface used by the engines.

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 interface ICompositStructure

Properties

dDischargedDownStreamWaterLevel Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. Unit: [m^2/s]
dDischargedUpStreamWaterLevel Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. Unit: [m^2/s]
dHeadLossDischarge Head loss derivative with respect to discharge
Diagnostics The getter is used to get a list of errors.
Discharge Get discharge across structure. SetWaterLevels() calculates the discharge so it must be called first.
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 of the structure
Residual Get residual of composite structure energy equation.
StationaryStateCalculation Temporarily disable head loss mode. Used when searching for stationary state.
Structures Getter to the list of structures
TotalIterations Total number of composit structure iterations.

Methods

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.
Initialize Initialize the composite structure
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.

Validate Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.

See Also