Orifice Class |
Inheritance HierarchyDHI.Mike1D.StructureModuleStructure
DHI.Mike1D.StructureModuleValvedStructure
DHI.Mike1D.StructureModuleOrifice
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe Orifice type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | 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.) |
| DischargeCoefficient |
Set scale factor for total discharge through orifice
|
| DownstreamBottomLevel |
Set downstream bottom level.
On a structure reach, if this is not set, (i.e. if having the default value of MinValue), the bottom level of the downstream node is used. Also disable UseUpAndDownstreamCrossSection to enable this |
| DownstreamCrossSection |
Set downstream cross section
|
| DownstreamTopLevel |
Set downstream top level.
On a structure reach, if this is not set, (i.e. if having the default value of MinValue), the ground level of the downstream node is used, and the downstream node must be a node with volume. Also disable UseUpAndDownstreamCrossSection to enable this |
| 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.) |
| DownstreamXsDisplacement |
Set downstream cross section displacement
A positive value displaces the cross section to the right when looking from the upstream direction
|
| 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.) |
| 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.) |
| GateLevel |
Actual gate level.
Type: River Structure Geometry
Unit: [m]
this is not a setup parameter, but a run parameter, which will change during the run (if the gate is controlled). If the gate is not explicitly controlled, this can be used to change the gate (manual/user defined control). |
| GatePolygons |
Shape of gates as polygons. Gate polygons can move
in between MinGateLevel and MaxGateLevel.
Y coordinates of gate polygons are relative to MinGateLevel If changing gate level properties during runtime, be sure to update internal state by calling PrepareForGate |
| 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.) |
| InitialGateLevel |
Initial value of the gate level.
Type: River Structure Geometry
Unit: [m]
|
| InvertLevelDownstream |
Invert level down stream
(Overrides StructureInvertLevelDownstream.) |
| InvertLevelUpstream |
Invert level up stream
(Overrides StructureInvertLevelUpstream.) |
| Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure.) |
| Location |
Location property.
(Inherited from Structure.) |
| MaxGateLevel |
Maximum allowed gate level
If changing gate level properties during runtime, be sure to update internal state by calling PrepareForGate |
| MaxGateLevelDecreaseSpeed |
Maximum speed of lowering gate/weir
|
| MaxGateLevelIncreaseSpeed |
Maximum speed of rising gate/weir
|
| MinGateLevel |
Minimum allowed gate level.
If changing gate level properties during runtime, be sure to update internal state by calling PrepareForGate |
| OrificePolygons |
Shape of the opening
|
| 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.) |
| StructureType |
Type of structure
(Inherited from Structure.) |
| TopoID |
String used to identified cross sections
(Inherited from Structure.) |
| Type |
Structure type, unique for each type structure.
(Overrides StructureType.) |
| UpstreamBottomLevel |
Set upstream bottom level.
On a structure reach, if this is not set, (i.e. if having the default value of MinValue), the bottom level of the upstream node is used. Also disable UseUpAndDownstreamCrossSection to enable this |
| UpstreamCrossSection |
Set upstream cross section
|
| UpstreamTopLevel |
Set downstream top level. Not used if _useUpAndDownstreamCrossSection On a structure reach, if this is not set, (i.e. if having the default value of MinValue), the ground level of the upstream node is used, and the upstream node must be a node with volume. Also disable UseUpAndDownstreamCrossSection to enable this |
| 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.) |
| UpstreamXsDisplacement |
Set upstream cross section displacement
A positive value displaces the cross section to the right when looking from the upstream direction
|
| UseUpAndDownstreamCrossSection |
Flag specifying whether to use upstream and downstream cross section for
geometry, or whether to use the 4 geometry parameters:
UpstreamBottomLevel, DownstreamBottomLevel,
UpstreamTopLevel, DownstreamTopLevel.
If setting this to false, all the 4 geometry parameters must be set manually |
| Valve |
Type of the valve
Default: None
(Inherited from ValvedStructure.) |
Methods| Name | Description | |
|---|---|---|
 | Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure.) |
| AddGatePolygon |
Add a polygon to the shape of the gate
|
| AddOrificePolygon |
Add a polygon to the shape of the orifice
|
 | ApplyFlowFactor |
Applies flow factor to discharge and it's derivatives
(Inherited from Structure.) |
| ControlClose |
Close orifice
|
| ControlOpen |
Open orifice
|
| ControlSetFlowFactor |
Set flow factor to specified value
(Inherited from Structure.) |
| ControlSetGateLevel |
Control the gate, set gate level to specified value
|
| 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.) |
| ExplicitStructureSupport |
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.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| 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.
(Overrides StructureGetControlAction(String).)Base implementation for IControllable |
| GetCurrentValue |
Get the current value of the control for the specified id.
(Overrides StructureGetCurrentValue(String).)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 StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Offers |
A list of quantities available from this structure
(Inherited from Structure.) |
| Prepare(HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Overrides StructurePrepare(HDParameterData, IDiagnostics).) |
| Prepare(DateTime, HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure.) |
| PrepareForGate |
Set orifice discharge for al positions of the gate. If a control is active (a weir or gate is present)
then this must be called after:
1) Prepare()
2) Gate polygons have been defined
3) MaxGateLevel and MinGateLevel have been set.
This is called automatically in prepare. It must be called explicitly if gate polygons or max/min gate level are changed after the prepare step |
| PrepareTimeStep |
Setter for controllable structure. Used by the control module.
Can safely be called multiple times with the same timeN.
|
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
|
| 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 StructureResetControlledState.)Base implementation for IControllable |
| SetControlStrategyId |
Set control strategy ID manually.
(Inherited from Structure.)Base implementation for IControllable |
| SetInputWaterLevels | (Inherited from Structure.) |
| SetWaterLevels |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Overrides StructureSetWaterLevels(Double, Double).) |
| SetZeroFlow |
Sets the conditions for zero flow
(Inherited from Structure.) |
| 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 |
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Overrides StructureValidate.) |
| ValueGetter |
Get value setter for the specified data quantity
(Overrides StructureValueGetter(Int32).) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from Structure.) |
| ValveDecidesFlow |
Decides whether the valve will decide the flow and sets the flow to zero in case the valve
forbids flow.
(Inherited from ValvedStructure.) |
| WriteState |
Write current state of module
|
| ZeroFlowDueToValve |
Decides wheather the valve will prevent flow given the flow direction.
(Inherited from ValvedStructure.) |
Fields| Name | Description | |
|---|---|---|
 | _accepts |
List of quantities that are accepted
(Inherited from Structure.) |
| _controlStategyId |
If the structure is being controlled, then _controlStategyId contains the ID of the
active control strategy
(Inherited from Structure.) |
| _downstreamWaterLevel |
Downstream water level, as set by SetWaterLevels(Double, Double)
Unit: [m]
(Inherited from Structure.) |
| _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.) |
| _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.) |
| _flowArea |
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.) |
| _flowDir |
FlowDir is used to determine which parameters to use for the flow calculations.
Derived by the SetWaterLevels(Double, Double).
(Inherited from Structure.) |
| _id |
Identification name of the structure
(Inherited from Structure.) |
| _implicit |
If _implicit == false, then the derivatives are always zero.
Default value: true.
(Inherited from Structure.) |
| _location |
Location in the network
(Inherited from Structure.) |
| _offers |
List of quantities that are offered
(Inherited from Structure.) |
| _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.) |
| _runTimeDiagnostics |
Diagnostics are written into this Diagnostics during calculations.
Set during Initialize(IDiagnostics) (Inherited from Structure.) |
| _topoID |
Identification used to find referenced cross sections
(Inherited from Structure.) |
| _upstreamWaterLevel |
Upstream water level, as set by SetWaterLevels(Double, Double)
Unit: [m]
(Inherited from Structure.) |
| _valveType |
Type of the valve
Default: None
(Inherited from ValvedStructure.) |
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