Click or drag to resize

DamBreakNWS Class

Dambreak class.
Inheritance Hierarchy

Namespace:  DHI.Mike1D.StructureModule
Assembly:  DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public sealed class DamBreakNWS : DamBreakBase, 
	IDamBreakNWS, IDamBreakBase, IStructure, IDoubleProxy, IQuantityProxy, 
	IStructureBoundarySetup

The DamBreakNWS type exposes the following members.

Constructors
  NameDescription
Public methodDamBreakNWS
Constructor
Top
Properties
  NameDescription
Public propertyCrestLevel
Level of dam (before breach)
(Inherited from DamBreakBase.)
Public propertyCrestWidth
Width of dam (before breach)
(Inherited from DamBreakBase.)
Public propertyCrestWidthForApproachCorrection
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.
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 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 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 propertyLocation
Location property.
(Inherited from Structure.)
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 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
Methods
  NameDescription
Public methodAccepts
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure.)
Public methodControlSetFlowFactor
Set flow factor to specified value
(Inherited from Structure.)
Public methodDescription
Return a string that describes this structure. Includes structure type and ID
(Inherited from Structure.)
Public methodDispose
Frees the licenses held.
(Inherited from Structure.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFinish
Finish use of dambreak structure.
(Inherited from DamBreakBase.)
Public methodGetControlAction
Get control action for the specified id. It always returns one of the ActionControl delegates. It will return null if controlActionId is not valid.

Base implementation for IControllable

(Inherited from DamBreakBase.)
Public methodGetCurrentValue
Get the current value of the control for the specified id.

Base implementation for IControllable

(Inherited from DamBreakBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize(IDiagnostics)
Set up structure and set runtime diagnostics object
(Inherited from Structure.)
Public methodInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics)
Set up structure and set runtime diagnostics object
(Overrides DamBreakBaseInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).)
Public methodOffers
A list of quantities available from this structure
(Inherited from Structure.)
Public methodPrepare(HDParameterData, IDiagnostics)
Set up structure and set runtime diagnostics object
(Inherited from DamBreakBase.)
Public methodPrepare(DateTime, HDParameterData, IDiagnostics)
Set up structure and set runtime diagnostics object
(Inherited from DamBreakBase.)
Public methodPrepareTimeStep
Prepare structure for time step
(Overrides DamBreakBasePrepareTimeStep(DateTime, DateTime).)
Public methodResetControlledState
Reset internal state (if any) used by controlling class. Called after a controlling class has performed a control sequence, and simulation is restarted.

Base implementation for IControllable

(Overrides DamBreakBaseResetControlledState.)
Public methodSetControlStrategyId
Set control strategy ID manually.

Base implementation for IControllable

(Inherited from Structure.)
Public methodSetup
Public methodSetWaterLevels
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Overrides StructureSetWaterLevels(Double, Double).)
Public methodStartBreach
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.)
Public methodStartBreach(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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdatedWaterLevels
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.)
Public methodValidate
Generates errors, warnings.
(Overrides StructureValidate.)
Public methodValueGetter
Get value setter for the specified data quantity
(Inherited from DamBreakBase.)
Public methodValueSetter
Get value setter for the specified data type
(Inherited from Structure.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetter

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.

(Defined by ProxyExtensions.)
Public Extension MethodGetters
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.)
Public Extension MethodGettersFraction
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.)
Public Extension MethodGetterUnboxed

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.

(Defined by ProxyExtensions.)
Public Extension MethodInitialize(CrossSectionData, Boolean, IDiagnostics)Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.)
Public Extension MethodInitialize(BoundaryData, CrossSectionData, Boolean, IDiagnostics)Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.)
Public Extension MethodIsSideStructure
Returns true if the structure is a side structure
(Defined by StructureExtensions.)
Public Extension MethodSetter

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.

(Defined by ProxyExtensions.)
Top
See Also