Click or drag to resize

OverFlowFormula Properties

The OverFlowFormula type exposes the following members.

Properties
  NameDescription
Public propertyCrestLevel
The level of the weir crest. For structures with control, this is the initial creste level only. Type: River Structure Geometry Unit: [m] Default: 0
Public propertyCrestType
Integere indicating which weir type it is: 1: Rectangular 2: V-Notch 3: Trapezoidal 4: Irregular 5: Long weir
Public propertyCrestWidth
The width of the weir. Type: River Structure Geometry Unit: [m] Default: 0
Public propertyCurrentCrestLevel
For structure with control, the crest level may change. Use this property to get/set the current crest level.
Public propertyDataSetID
ID of the table where the Q-h relation is located.
Public propertydDischargedDownStreamWaterLevel
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. The value is calculated by SetWaterLevels. Unit: [m^2/s]
(Inherited from Structure.)
Public propertydDischargedUpStreamWaterLevel
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. The value is calculated by SetWaterLevels. Unit: [m^2/s]
(Inherited from Structure.)
Public propertyDelhs
Linear flow variation. For water level differences less than delhs use a linear Q variation between h1-h2=delhs and h1-h2=0. This is to avoid stability problems for small water level differences where dQdh goes to infinity. Unit: [m] Default: 0.01
Public propertyDischarge
Calculated Discharge. The value is calculated by SetWaterLevels. Unit: [m^3/s]
(Inherited from Structure.)
Public propertyDownstreamWaterLevel
Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]
(Inherited from Structure.)
Public propertyExtensionData
Property used by (de)serializer, when it can not find proper target for a data field. Support of forward compatible data contracts.
(Inherited from Structure.)
Public propertyFlowArea
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.)
Public propertyFlowFactor
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure.)
Public propertyID
Structure ID
(Inherited from Structure.)
Public propertyIDInUserUnit
Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when reporting errors, warnings and hints.
(Inherited from Structure.)
Public propertyImplicit
Flag to control if the structure is implicit or explicit. If the structure is explicit (Implicit == false) then the derivatives of the dicharge are always zero. Default value: true
(Inherited from Structure.)
Public propertyInvertLevelDownstream
Invert level down stream
(Overrides StructureInvertLevelDownstream.)
Public propertyInvertLevelUpstream
Invert level up stream
(Overrides StructureInvertLevelUpstream.)
Public propertyKc
Coeffcient used to determine overall flow coefficient when weir coefficient is not used. Type: Undefined Unit: [] Default: Undefined
Public propertyLength
Length of the structure. Unit: [m] Default value: 0m
(Inherited from Structure.)
Public propertyLocation
Location property.
(Inherited from Structure.)
Public propertyMaxCrestLevel
Maximum crest level

Used when crest level is being controlled

Public propertyMaxCrestLevelDecreaseSpeed
Maximum crest level decrease speed

Used when crest level is being controlled

Public propertyMaxCrestLevelIncreaseSpeed
Maximum crest level increase speed

Used when crest level is being controlled

Public propertyMethodNumber
Calculation method: 1 for a Q-h table and 2 for weir formula Default: 2
Public propertyMinCrestLevel
Minimum crest level

Used when crest level is being controlled

Public propertyOutlet
Flag specifying whether the downstream end is out of the system (outlet boundary). If true, flow out of the system is always free outflow (critical flow conditions)
Public propertyRunTimeDiagnostics
The getter is used to get a list of errors.
(Inherited from Structure.)
Public propertySideStructureBank
Bank side that side-structure is located on

If side structure contains reservoir, and has the Coordinate set, this is not used (and should be set to Undefined).

(Inherited from Structure.)
Public propertySideStructureReservoir
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from Structure.)
Public propertyStructureType
Type of structure
(Inherited from Structure.)
Public propertyTopoID
String used to identified cross sections
(Inherited from Structure.)
Public propertyTransitionCoefficient
Coefficient used to make a continuos transistion between submerged and not submerged flow at the weir Unit: [] Default: 0.00.
Public propertyType
Structure type, unique for each structure.
(Overrides StructureType.)
Public propertyUpstreamWaterLevel
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]
(Inherited from Structure.)
Public propertyUseWeirCoeff
Flag telling if the weir coefficient should be used or the coefficient should be based on the angle of the weir.
Public propertyValve
Type of the valve Default: None
(Inherited from ValvedStructure.)
Public propertyWeirCoefficient
Flow coeffcient for the weir. If left undefined the flow coeeficient is calculated based on information on the WeirFlowAngle Type: Dimensional factor Unit: [] Default: 0.66
Public propertyWeirFlowAngle
The angle of the weir to the flow direction of the branch Type: Angels Unit: [degrees] Default: 0
Top
See Also