IStructure Interface |
Base interface for all structures.
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IStructure type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | dDischargedDownStreamWaterLevel |
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage.
Unit: [m^2/s]
|
| dDischargedUpStreamWaterLevel |
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage.
Unit: [m^2/s]
|
| Discharge |
Calculated Discharge
Unit: [m^3/s]
|
| DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of
SetWaterLevels
Unit: [m]
|
| FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
|
| ID |
Name of the structure.
|
| IDInUserUnit | 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.
|
| Implicit |
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
|
| InvertLevelDownstream |
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.
|
| InvertLevelUpstream |
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.
|
| Length | Obsolete.
Length of the structure.
Unit: [m]
|
| Location |
Location of structure.
|
| RunTimeDiagnostics |
The getter is used to get a list of errors. OBSOLETE
|
| SideStructureBank |
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). |
| SideStructureReservoir |
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
|
| StructureType |
Type of structure
|
| TopoID |
TopoID used when structure is searching for neighboring cross sections in the reach.
|
| Type |
Structure type, unique for each type of structure.
|
| UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
|
Methods| Name | Description | |
|---|---|---|
 | Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from IQuantityProxy.) |
| Description |
Description of the structure.
|
| Initialize |
Set up structure and set runtime diagnostics object
|
| Offers |
List of data types that is offered, i.e., that you can get a ValueGetter for.
(Inherited from IQuantityProxy.) |
| Prepare |
Set up structure and set runtime diagnostics object
|
| SetWaterLevels |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
|
| 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.
|
| Validate |
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
|
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from IDoubleProxy.) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from IDoubleProxy.) |
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