LinkRegulationStructure Class

Initializes a new instance of the LinkRegulationStructure class

Discharge for a single structure.

Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. The value is calculated by SetWaterLevels. Unit: [m^2/s]

Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. The value is calculated by SetWaterLevels. Unit: [m^2/s]

Calculated Discharge. The value is calculated by SetWaterLevels. Unit: [m^3/s]

Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]

Property used by (de)serializer, when it can not find proper target for a data field. Support of forward compatible data contracts.

Flow area through structure. Used by most (but not all) structures.

The discharge (and discharge derivatives) are scaled by the flow factor.

Structure ID

Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when reporting errors, warnings and hints.

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

Invert level down stream

Invert level up stream

Length of the structure. Unit: [m] Default value: 0m

Location property.

The getter is used to get a list of errors.

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).

Reservoir at end of side structure. Null if not side structure, or no reservoir is defined

Type of structure

String used to identified cross sections

Structure type, unique for each structure.

Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]

List of data types that is accepted, i.e., that you can get a ValueSetter for.

Applies flow factor to discharge and it's derivatives

Close gate, set the discharge to zero

Set the discharge to use

Set flow factor to specified value

Return a string that describes this structure. Includes structure type and ID

Frees the licenses held.

Determines whether the specified object is equal to the current object.

DEBUG: This method is called from Validate() if _implitcit == false to check if the structure supports being Explicit. Once all structures support explicit operation this method can be deleted.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

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

Get the current value of the control for the specified id.

Base implementation for IControllable

Serves as the default hash function.

Gets the Type of the current instance.

Set up structure and set runtime diagnostics object

Set up structure and set runtime diagnostics object

Creates a shallow copy of the current Object.

A list of quantities available from this structure

Set up structure and set runtime diagnostics object

Set up structure and set runtime diagnostics object

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

Set control strategy ID manually.

Base implementation for IControllable

Set the _upstreamWaterLevel, _downstreamWaterLevel and _flowDir

Sets up- and down- stream water level. For DischargeGate, SetWaterLevels() does nothing else than implements limits on discharge if _upstreamWaterLevelMinMaxTable != null.

Sets the conditions for zero flow

Returns a string that represents the current object.

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.

Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.

Get value setter for the specified data quantity

Get value setter for the specified data type

List of quantities that are accepted

If the structure is being controlled, then _controlStategyId contains the ID of the active control strategy

Downstream water level, as set by SetWaterLevels(Double, Double) Unit: [m]

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]

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]

Flow area through structure. Used by most (but not all) structures.

FlowDir is used to determine which parameters to use for the flow calculations. Derived by the SetWaterLevels(Double, Double).

Identification name of the structure

If _implicit == false, then the derivatives are always zero. Default value: true.

Location in the network

List of quantities that are offered

Flow through the structure. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m3/sec]

Diagnostics are written into this Diagnostics during calculations. Set during Initialize(IDiagnostics)

Identification used to find referenced cross sections

Upstream water level, as set by SetWaterLevels(Double, Double) Unit: [m]