DamBreakNWS Class |
Dambreak class.
Inheritance HierarchySystemObject
DHI.Mike1D.StructureModuleStructure
DHI.Mike1D.StructureModuleDamBreakBase
DHI.Mike1D.StructureModuleDamBreakNWS
DHI.Mike1D.StructureModuleStructure
DHI.Mike1D.StructureModuleDamBreakBase
DHI.Mike1D.StructureModuleDamBreakNWS
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe DamBreakNWS type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DamBreakNWS |
Constructor
|
Properties| 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.) |
Methods| Name | Description | |
|---|---|---|
| Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure.) |
| ControlSetFlowFactor |
Set flow factor to specified value
(Inherited from Structure.) |
| Description |
Return a string that describes this structure. Includes structure type and ID
(Inherited from Structure.) |
| Dispose |
Frees the licenses held.
(Inherited from Structure.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finish |
Finish use of dambreak structure.
(Inherited from DamBreakBase.) |
| GetControlAction |
Get control action for the specified id. It always returns one of
the ActionControl delegates. It will return null if
controlActionId is not valid.
(Inherited from DamBreakBase.)Base implementation for IControllable |
| GetCurrentValue |
Get the current value of the control for the specified id.
(Inherited from DamBreakBase.)Base implementation for IControllable |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initialize(IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure.) |
| Initialize(ICrossSection, ICrossSection, Boolean, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Overrides DamBreakBaseInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).) |
| Offers |
A list of quantities available from this structure
(Inherited from Structure.) |
| Prepare(HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from DamBreakBase.) |
| Prepare(DateTime, HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from DamBreakBase.) |
| PrepareTimeStep |
Prepare structure for time step
(Overrides DamBreakBasePrepareTimeStep(DateTime, DateTime).) |
| ResetControlledState |
Reset internal state (if any) used by controlling class.
Called after a controlling class has performed a control sequence,
and simulation is restarted.
(Overrides DamBreakBaseResetControlledState.)Base implementation for IControllable |
| SetControlStrategyId |
Set control strategy ID manually.
(Inherited from Structure.)Base implementation for IControllable |
| Setup | |
| SetWaterLevels |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Overrides StructureSetWaterLevels(Double, Double).) |
| StartBreach |
Start the breach now (matching time Np1). This can be called to manually
start the breach at a certain time. It must be called in between time steps,
and not in the middle of a time step
(Inherited from DamBreakBase.) |
| StartBreach(Int32) |
Start the breach now (matching time Np1). This can be called to manually
start the breach at a certain time. It must be called in between time steps,
and not in the middle of a time step
(Inherited from DamBreakBase.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdatedWaterLevels |
After a time step (or iteration) has finished, update the discharge to the actual value, based
on the final water levels and the discharge derivatives.
(Inherited from Structure.) |
| Validate |
Generates errors, warnings.
(Overrides StructureValidate.) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from DamBreakBase.) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from Structure.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Getter | From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. |
| Getters |
Returns a set of FuncTResult for the quantity.
We can return several quantities with the same id (usually they will differ in their description).
If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions.) |
| GettersFraction |
Returns a set of FuncT, TResult for the quantity.
We can return several quantities with the same id (usually they will differ in their description).
If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions.) |
| GetterUnboxed | From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. |
| Initialize(CrossSectionData, Boolean, IDiagnostics) | Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.) |
| Initialize(BoundaryData, CrossSectionData, Boolean, IDiagnostics) | Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.) |
| IsSideStructure |
Returns true if the structure is a side structure
(Defined by StructureExtensions.) |
| Setter | From the proxy, return an IDoubleGetSet for the specified quantity. It returns the first quantity of that type that is accepted, and null if the quantity is not accepted. |
See Also