Click or drag to resize

IValve Interface

Sluice gate interface

Namespace:  DHI.Mike1D.StructureModule
Assembly:  DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public interface IValve : IValvedStructure, IStructure, 
	IDoubleProxy, IQuantityProxy, ILinearZeroVariation

The IValve type exposes the following members.

Properties
  NameDescription
Public propertydDischargedDownStreamWaterLevel
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. Unit: [m^2/s]
(Inherited from IStructure.)
Public propertydDischargedUpStreamWaterLevel
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. Unit: [m^2/s]
(Inherited from IStructure.)
Public propertyDelhs
Level from where the variation is forced to be linear.
(Inherited from ILinearZeroVariation.)
Public propertyDiameter
The diameter of the valve Type: River Structure Geometry Unit: [m] Default: 0
Public propertyDischarge
Calculated Discharge Unit: [m^3/s]
(Inherited from IStructure.)
Public propertyDownstreamWaterLevel
Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of SetWaterLevels Unit: [m]
(Inherited from IStructure.)
Public propertyFlowArea
The flow area of the valve Type: River Structure Geometry Unit: [m2] Default: 0
Public propertyFlowFactor
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from IStructure.)
Public propertyFlowFactorTable
Table holding flow factor as a function of opening (as fractions [0;1]).
Public propertyID
Name of the structure.
(Inherited from IStructure.)
Public propertyIDInUserUnit Obsolete.
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 IStructure.)
Public propertyImplicit
Flag to control if the structure is implicit or explicit. If the structure is explicit (Implicit == false) then the derivatives of the discharge are always zero. Default value: true
(Inherited from IStructure.)
Public propertyInvertLevel
The invert level of the valve Type: River Structure Geometry Unit: [m] Default: 0
Public propertyInvertLevelDownstream
Invert level down stream The invert level is the level where water starts flowing in to the structure from the downstream side. It does not necessarily flow through the structure.
(Inherited from IStructure.)
Public propertyInvertLevelUpstream
Invert level up stream. The invert level is the level where water starts flowing in to the structure from the upstream side. It does not necessarily flow through the structure.
(Inherited from IStructure.)
Public propertyLength Obsolete.
Length of the structure. Unit: [m]
(Inherited from IStructure.)
Public propertyLocation
Location of structure.
(Inherited from IStructure.)
Public propertyMaxValveOpening
Maximum valve opening, when valve is controlled Unit: fraction [0;1]
Public propertyMaxValveSpeed
Maximum valve speed, i.e. speed with which it can open and close Unit: [/s] - fraction per second.
Public propertyMinValveOpening
Minimum valve opening, when valve is controlled Unit: fraction [0;1]
Public propertyRunTimeDiagnostics
The getter is used to get a list of errors. OBSOLETE
(Inherited from IStructure.)
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 IStructure.)
Public propertySideStructureReservoir
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from IStructure.)
Public propertyStructureType
Type of structure
(Inherited from IStructure.)
Public propertyTopoID
TopoID used when structure is searching for neighboring cross sections in the reach.
(Inherited from IStructure.)
Public propertyType
Structure type, unique for each type of structure.
(Inherited from IStructure.)
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 IStructure.)
Public propertyValve
Type of valve giving the direction of flow that is possible.
(Inherited from IValvedStructure.)
Public propertyValveOpening
The opening of the valve in percent. This value is overwritten if RTC is applied. Type: River Structure Geometry Unit: fraction [0;1] Default: 0
Top
Methods
  NameDescription
Public methodAccepts
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from IQuantityProxy.)
Public methodDescription
Description of the structure.
(Inherited from IStructure.)
Public methodInitialize
Set up structure and set runtime diagnostics object
(Inherited from IStructure.)
Public methodOffers
List of data types that is offered, i.e., that you can get a ValueGetter for.
(Inherited from IQuantityProxy.)
Public methodPrepare
Set up structure and set runtime diagnostics object
(Inherited from IStructure.)
Public methodSetWaterLevels
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from IStructure.)
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 IStructure.)
Public methodValidate
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Inherited from IStructure.)
Public methodValueGetter
Get value setter for the specified data quantity
(Inherited from IDoubleProxy.)
Public methodValueSetter
Get value setter for the specified data type
(Inherited from IDoubleProxy.)
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