STModule Class |
ST module handles sediment transport
Inheritance HierarchyNamespace: DHI.Mike1D.Engine.ModuleST
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe STModule type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ADModule | |
| BedShearStress |
Bed shear stress calculator
|
| DoBedModelUpdate |
Flag deciding whether bed model (sediment fraction content in bed) is updated.
|
| DoMorphologicalUpdate |
Flag dedicing whether morphological updates are performed, i.e. cross sections are updated.
|
| Id |
Id of module
|
| Nodes | ST nodes |
| Order |
Order of module. Modules are processed in order.
The ST module must run after the AD module. The AD module has order 300.
|
| Reaches | ST reaches |
Methods| Name | Description | |
|---|---|---|
 | CalculateEngelundFredsoeIntegral |
Tabulate values for Engelund Fredsøe integral
|
| CalculateGamma0 |
Calculate and tabulate gamma0 for later use.
|
| CalculateGamma0GarciaParker |
Calculate and tabulate gamma for garcia parker for later use.
|
| CalculateLaneKalinskeIntegral |
Tabulate values for Lane-Kalinske
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FinalizeTimestep |
FinalizeTimeStep allows the modules to do operations required when
a time step has successfully completed
|
| Finish |
Finishes the module and releases any license
|
| GetEngelundFredsoeIntegral |
x = ln(h/k0)
y = w_s / u_f
Returns f(x,y) interpolated from tabulated values.
|
| GetGamma0 |
Get gamma_0 for suspended load calculations
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLaneKalinskeIntegral |
x = w_s / u_f
y = V / u_f
Returns P(x,y) interpolated from tabulated values.
|
| GetProxy |
Get a proxy for generic/global data
|
| GetProxy(EngineNode) |
Get a proxy for the node
|
| GetProxy(EngineReach) |
Get a proxy for the reach, covering a number of gridpoints
|
| GetProxy(EngineReach, Int32) |
Get a proxy for the gridpoint in the reach
|
| GetProxyReachGeneric |
Get a proxy for the reach, generic data (not gridpoint associated)
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PerformTimestep |
Perform timestep and return true if solution is accepted.
Can be called several times for different values of Dt.
|
| PreferredTimeStep |
Returns the preferred time step for the current state. It is called between every time step
and can increase as well as decrease the time step.
Used when AdaptiveTimeSteppingActivated is true. Do return the maximum of the allowed time step; in case a buffer is required, this is handled by a time step controller. |
| Prepare | |
| PrepareForTimeStep | |
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
|
| StateUpdated | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WriteState |
Write current state of module
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetProxy | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineNode) | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineReach) | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineReach, Int32) | Overloaded. (Defined by EngineExtensions.) |
| GetProxyReachGeneric | (Defined by EngineExtensions.) |
See Also