DamBreakNWS Properties |
The DamBreakNWS type exposes the following members.
Name | Description | |
---|---|---|
CrestLevel |
Level of dam (before breach)
(Inherited from DamBreakBase.) | |
CrestWidth |
Width of dam (before breach)
(Inherited from DamBreakBase.) | |
CrestWidthForApproachCorrection |
Special crest width used when calculating the approach correction.
Usually (default value) CrestWidthForApproachCorrection is equal to
CrestWidth but in special circumstances it is necessary
to control the approach correction directly through this width.
| |
dDischargedDownStreamWaterLevel |
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.) | |
dDischargedUpStreamWaterLevel |
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.) | |
Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure.) | |
DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) | |
ExtensionData |
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.) | |
FailOnDateTime |
Date of failure
(Inherited from DamBreakBase.) | |
FailOnHoursAfterStart |
Hours of simulation start of failure
(Inherited from DamBreakBase.) | |
FailOnWaterLevel |
Upstream water level of failure
(Inherited from DamBreakBase.) | |
FailureMode |
Specifies how the dam break failure evolves
(Inherited from DamBreakBase.) | |
FailureTrigger |
Type of failure trigger
(Inherited from DamBreakBase.) | |
FlowArea |
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.) | |
FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure.) | |
ID |
Structure ID
(Inherited from Structure.) | |
IDInUserUnit |
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.) | |
Implicit |
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.) | |
InvertLevelDownstream |
Invert level down stream
(Inherited from DamBreakBase.) | |
InvertLevelUpstream |
Invert level up stream
(Inherited from DamBreakBase.) | |
Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure.) | |
Location |
Location property.
(Inherited from Structure.) | |
ReportPath |
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.) | |
RunTimeDiagnostics |
The getter is used to get a list of errors.
(Inherited from Structure.) | |
SideStructureBank |
Bank side that side-structure is located on
(Inherited from Structure.)If side structure contains reservoir, and has the Coordinate set, this is not used (and should be set to Undefined). | |
SideStructureReservoir |
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from Structure.) | |
SimulationStartTime |
Simulation start time.
(Inherited from DamBreakBase.)Used in case FailureTrigger is HoursAfterStart. Also used to write information to the DamBreak state text output file. | |
StructureType |
Type of structure
(Inherited from Structure.) | |
TopoID |
String used to identified cross sections
(Inherited from Structure.) | |
Type |
Structure type, unique for each structure.
(Overrides StructureType.) | |
UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) |