Click or drag to resize

Structure Fields

The Structure type exposes the following members.

Fields
  NameDescription
Protected field_accepts
List of quantities that are accepted
Protected field_controlStategyId
If the structure is being controlled, then _controlStategyId contains the ID of the active control strategy
Protected field_downstreamWaterLevel
Downstream water level, as set by SetWaterLevels(Double, Double) Unit: [m]
Protected field_dqdhDownstream
The derivative of flow through the structure with downstream water level. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m2/sec]
Protected field_dqdhUpstream
The derivative of flow through the structure with upstream water level. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m2/sec]
Protected field_flowArea
Flow area through structure. Used by most (but not all) structures.
Protected field_flowDir
FlowDir is used to determine which parameters to use for the flow calculations. Derived by the SetWaterLevels(Double, Double).
Protected field_id
Identification name of the structure
Protected field_implicit
If _implicit == false, then the derivatives are always zero. Default value: true.
Protected field_location
Location in the network
Protected field_offers
List of quantities that are offered
Protected field_q
Flow through the structure. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m3/sec]
Protected field_runTimeDiagnostics
Diagnostics are written into this Diagnostics during calculations. Set during Initialize(IDiagnostics)
Protected field_topoID
Identification used to find referenced cross sections
Protected field_upstreamWaterLevel
Upstream water level, as set by SetWaterLevels(Double, Double) Unit: [m]
Protected fieldStatic memberZeroWaterLevelDifference
The constant is used to define the lower limit for which we will try to calculate the flow and typically more problematic the flow derivatives.
Top
See Also