Click or drag to resize

IDamBreakBase Properties

The IDamBreakBase type exposes the following members.

Properties
  NameDescription
Public propertyCrestLevel
Level of dam (before breach)
Public propertyCrestWidth
Width of dam (before breach)
Public propertydDischargedDownStreamWaterLevel
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. Unit: [m^2/s]
(Inherited from IStructure.)
Public propertydDischargedUpStreamWaterLevel
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. Unit: [m^2/s]
(Inherited from IStructure.)
Public propertyDischarge
Calculated Discharge Unit: [m^3/s]
(Inherited from IStructure.)
Public propertyDownstreamWaterLevel
Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of SetWaterLevels Unit: [m]
(Inherited from IStructure.)
Public propertyFailOnDateTime
Date of failure
Public propertyFailOnHoursAfterStart
Hours of simulation start of failure
Public propertyFailOnWaterLevel
Upstream water level of failure
Public propertyFailureMode
Specifies how the dam break failure evolves
Public propertyFailureTrigger
Type of failure trigger
Public propertyFlowFactor
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from IStructure.)
Public propertyID
Name of the structure.
(Inherited from IStructure.)
Public propertyIDInUserUnit Obsolete.
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 IStructure.)
Public propertyImplicit
Flag to control if the structure is implicit or explicit. If the structure is explicit (Implicit == false) then the derivatives of the discharge are always zero. Default value: true
(Inherited from IStructure.)
Public propertyInvertLevelDownstream
Invert level down stream The invert level is the level where water starts flowing in to the structure from the downstream side. It does not necessarily flow through the structure.
(Inherited from IStructure.)
Public propertyInvertLevelUpstream
Invert level up stream. The invert level is the level where water starts flowing in to the structure from the upstream side. It does not necessarily flow through the structure.
(Inherited from IStructure.)
Public propertyLength Obsolete.
Length of the structure. Unit: [m]
(Inherited from IStructure.)
Public propertyLocation
Location of structure.
(Inherited from IStructure.)
Public propertyRunTimeDiagnostics
The getter is used to get a list of errors. OBSOLETE
(Inherited from IStructure.)
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 IStructure.)
Public propertySideStructureReservoir
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from IStructure.)
Public propertyStructureType
Type of structure
(Inherited from IStructure.)
Public propertyTopoID
TopoID used when structure is searching for neighboring cross sections in the reach.
(Inherited from IStructure.)
Public propertyType
Structure type, unique for each type of structure.
(Inherited from IStructure.)
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 IStructure.)
Top
See Also