public class LinkRegulationStructure : Structure,
IControllable| LinkRegulationStructure | Initializes a new instance of the LinkRegulationStructure class |
| ActualDischarge | Discharge for a single structure. |
| 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) |
| 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) |
| EnableCheckFlowDirectionOscillations |
Flag indicating whether to use special check and damping
for structure discharge oscillating around zero.
(Inherited from Structure) |
| 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) |
| 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) |
| 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) |
| RunTimeDiagnostics |
The getter is used to get a list of errors.
(Inherited from Structure) |
| 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). (Inherited from Structure) |
| SideStructureReservoir |
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from Structure) |
| SmoothingFactor |
Exponential smoothing factor for structure discharge.
The smoothing factor is the weight of the previous discharge on the new discharge:
q = (1 - SmoothingFactor) * qStructure + SmoothingFactor * qPrevious
(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 structure.
(Overrides StructureType) |
| 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) |
| WaterLevelDifferenceMinimal |
Water level difference below which it is assumed
that structure has no flow.
(Inherited from Structure) |
| Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure) |
| AddToOffers |
Add additional offers to structure
(Inherited from Structure) |
| ApplyFlowFactor |
Applies flow factor to discharge and it's derivatives
(Inherited from Structure) |
| ControlClose | Close gate, set the discharge to zero |
| ControlSetDischarge | Set the discharge to use |
| ControlSetFlowFactor |
Set flow factor to specified value
(Inherited from Structure) |
| 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 Validate() if _implitcit == false to check if
the structure supports being Explicit.
Once all structures support explicit operation this method can be deleted.
(Inherited from Structure) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetActionInfos |
List of control action infos
(Overrides StructureGetActionInfos) |
| 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.
Base implementation for IControllable (Overrides StructureGetControlAction(String)) |
| GetCurrentValue |
Get the current value of the control for the specified id.
Base implementation for IControllable (Overrides StructureGetCurrentValue(String)) |
| 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) |
| ResetControlledState |
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) |
| SetControlStrategyId |
Set control strategy ID manually.
Base implementation for IControllable (Inherited from Structure) |
| SetInputWaterLevels |
Set the _upstreamWaterLevel, _downstreamWaterLevel and _flowDir (Inherited from Structure) |
| SetWaterLevels |
Sets up- and down- stream water level. For DischargeGate, SetWaterLevels() does nothing else
than implements limits on discharge if _upstreamWaterLevelMinMaxTable != null.
(Overrides StructureSetWaterLevels(Double, Double)) |
| SetZeroFlow |
Sets the conditions for zero flow
(Inherited from Structure) |
| ToString | Returns a string that represents the current object. (Overrides ObjectToString) |
| 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) |
| _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) |
| GetControlActionInfo |
Get control action info for the specified id. It will return null if
controlActionId is not valid.
(Defined by StructureExtensions) |