Click or drag to resize

DamBreakBase Class

Base class for DamBreak and DamBreakNWS
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 abstract class DamBreakBase : Structure, 
	IDamBreakBase, IStructure, IDoubleProxy, IQuantityProxy, IControllable, 
	ITimeStructure

The DamBreakBase type exposes the following members.

Constructors
  NameDescription
Protected methodDamBreakBase
Constructor
Top
Properties
  NameDescription
Public propertyCrestLevel
Level of dam (before breach)
Public propertyCrestWidth
Width of dam (before breach)
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
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 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
(Overrides StructureInvertLevelDownstream.)
Public propertyInvertLevelUpstream
Invert level up stream
(Overrides StructureInvertLevelUpstream.)
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().
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.

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 type structure.
(Inherited from Structure.)
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.)
Protected methodApplyFlowFactor
Applies flow factor to discharge and it's derivatives
(Inherited from Structure.)
Protected methodCheckForBreach
Check if dambreak structuer should start breach within this time span
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.)
Protected methodExplicitStructureSupport
DEBUG: This method is called from Prepare() if _implitcit == false to check if the structure supports being Explicit. Once all structures support explicit operation this method can be deleted.
(Overrides StructureExplicitStructureSupport.)
Protected methodFinalize (Overrides ObjectFinalize.)
Protected methodFindAndAssignBoundary
Find and assign structure boundaries relevant to this structure.
Public methodFinish
Finish use of dambreak structure.
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

(Overrides StructureGetControlAction(String).)
Public methodGetCurrentValue
Get the current value of the control for the specified id.

Base implementation for IControllable

(Overrides StructureGetCurrentValue(String).)
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 StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
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
(Overrides StructurePrepare(HDParameterData, IDiagnostics).)
Public methodPrepare(DateTime, HDParameterData, IDiagnostics)
Set up structure and set runtime diagnostics object
(Overrides StructurePrepare(DateTime, HDParameterData, IDiagnostics).)
Public methodPrepareTimeStep
Prepare structure for time step
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 StructureResetControlledState.)
Public methodSetControlStrategyId
Set control strategy ID manually.

Base implementation for IControllable

(Inherited from Structure.)
Protected methodSetInputWaterLevels (Inherited from Structure.)
Public methodSetWaterLevels
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.

Override in extending classes to do something useful.

(Inherited from Structure.)
Protected methodSetZeroFlow
Sets the conditions for zero flow
(Inherited from Structure.)
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
Protected methodStartBreach(DateTime)
Start breach
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
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
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Inherited from Structure.)
Public methodValueGetter
Get value setter for the specified data quantity
(Overrides StructureValueGetter(Int32).)
Public methodValueSetter
Get value setter for the specified data type
(Inherited from Structure.)
Protected methodWriteStatePipeCollapseEvent
Write "pipe collapsed" event to state file
Protected methodWriteStateWeirFlowHeader
Write weir-flow header to state file
Top
Fields
  NameDescription
Protected field_accepts
List of quantities that are accepted
(Inherited from Structure.)
Protected field_boundary
Breach level, breach width, and breach slope are stored as components (in that order) in the StructureSourceBoundary.
Protected field_breachIsOpen
Flag indicating if breach is open
Protected field_controlStategyId
If the structure is being controlled, then _controlStategyId contains the ID of the active control strategy
(Inherited from Structure.)
Protected field_crestLevel
Level of dam (before breach)
Protected field_crestWidth
Width of dam (before breach)
Protected field_downstreamWaterLevel
Downstream water level, as set by SetWaterLevels(Double, Double) Unit: [m]
(Inherited from Structure.)
Protected field_dqdhDownstream
The derivative of flow through the structure with downstream water level. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m2/sec]
(Inherited from Structure.)
Protected field_dqdhUpstream
The derivative of flow through the structure with upstream water level. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m2/sec]
(Inherited from Structure.)
Protected field_failureMode
Specifies how the dam break failure evolves
Protected field_failureTrigger
Type of failure trigger
Protected field_flowArea
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.)
Protected field_flowDir
FlowDir is used to determine which parameters to use for the flow calculations. Derived by the SetWaterLevels(Double, Double).
(Inherited from Structure.)
Protected field_id
Identification name of the structure
(Inherited from Structure.)
Protected field_implicit
If _implicit == false, then the derivatives are always zero. Default value: true.
(Inherited from Structure.)
Protected field_location
Location in the network
(Inherited from Structure.)
Protected field_offers
List of quantities that are offered
(Inherited from Structure.)
Protected field_q
Flow through the structure. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m3/sec]
(Inherited from Structure.)
Protected field_reportPath
The directory of the text output file is taken from this file path. It is set from the boundary data connection during Initialize().
Protected field_runTimeDiagnostics
Diagnostics are written into this Diagnostics during calculations. Set during Initialize(IDiagnostics)
(Inherited from Structure.)
Protected field_simStartTime
Start time of simulation
Protected field_timeN
Time N
Protected field_timeNp1
Time N+1 = current time
Protected field_timeOfLastWrite
Time that state results was written last time
Protected field_topoID
Identification used to find referenced cross sections
(Inherited from Structure.)
Protected field_upstreamWaterLevel
Upstream water level, as set by SetWaterLevels(Double, Double) Unit: [m]
(Inherited from Structure.)
Protected field_writer
Writer, for writing state results
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