Click or drag to resize

DamBreak Properties

The DamBreak type exposes the following members.

Properties
  NameDescription
Public propertyCrestLevel
Level of dam (before breach)
(Inherited from DamBreakBase.)
Public propertyCrestWidth
Width of dam (before breach)
(Inherited from DamBreakBase.)
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 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 propertyErosion
Erosion parameters
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 propertyFailOnDateTime
Date of failure
(Inherited from DamBreakBase.)
Public propertyFailOnHoursAfterStart
Hours of simulation start of failure
(Inherited from DamBreakBase.)
Public propertyFailOnWaterLevel
Upstream water level of failure
(Inherited from DamBreakBase.)
Public propertyFailureMode
Specifies how the dam break failure evolves
(Inherited from DamBreakBase.)
Public propertyFailureTrigger
Type of failure trigger
(Inherited from DamBreakBase.)
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 propertyHeadLossFreeOverflowNegativeFlow
Free overflow factor for negative flow. Default value = 1.
Public propertyHeadLossFreeOverflowPositiveFlow
Free overflow factor for positive flow. Default value = 1.
Public propertyHeadLossInflowNegativeFlow
Inflow head loss factor for positive flow. Default value = 0.5.
Public propertyHeadLossInflowPositiveFlow
Inflow head loss factor for positive flow. Default value = 0.5.
Public propertyHeadLossOutflowNegativeFlow
Free overflow factor for negative flow. Default value = 1.
Public propertyHeadLossOutflowPositiveFlow
Outflow head loss factor for positive flow. Default value = 1.
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
(Inherited from DamBreakBase.)
Public propertyInvertLevelUpstream
Invert level up stream
(Inherited from DamBreakBase.)
Public propertyLength
Length of the structure. Unit: [m] Default value: 0m
(Inherited from Structure.)
Public propertyLimitCrossSectionBreachCenter
Position of center of breach relative to the limit cross section
Public propertyLimitCrossSectionLocation
Location of limiting cross section. The limiting cross section limits the size of the breach in the downwar direction. If LimitCrossSectionLocation is set, then the cross section at that location is used to limit the breach (used when the area of the breach is calculated)
Public propertyLimitCrossSectionTopoID
Topo ID of limiting cross section
Public propertyLocation
Location property.
(Inherited from Structure.)
Public propertyMaximumIterations
Maximum number of iterations in a structure to obtain convergence of the discharge. Default value = 100

Currently this is set for all structures from the MaximumIterationsInStructure, but it is prepared for individual structure values.

Public propertyReportPath
The directory of the text output file is taken from this file path. It is set from the boundary data connection during Initialize().
(Inherited from DamBreakBase.)
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 propertySimulationStartTime
Simulation start time.

Used in case FailureTrigger is HoursAfterStart.

Also used to write information to the DamBreak state text output file.

(Inherited from DamBreakBase.)
Public propertyStructureIterationCentering
Used when making relaxation when iterating to find the subcritical solution for structures solved using the energy equation. When it equals 1 no relaxation is made.
Public propertyStructureType
Type of structure
(Inherited from Structure.)
Public propertyTopoID
String used to identified cross sections
(Inherited from Structure.)
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.)
Top
See Also