AirModule Class

AirModule retrieves air flow results using decoupled file.

Definition

Namespace: DHI.Mike1D.Engine.ModuleAir
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class AirModule : IFlowModule, IModule, 
	IModuleNetwork, IModuleNetwork<IAirNode, IAirReach>, IProxyProvider, 
	IDoubleNetworkProxy, IGraph
Inheritance
Object    AirModule
Implements
IModule, IModuleNetwork, IModuleNetworkIAirNode, IAirReach, IProxyProvider, IFlowModule, IGraph, IDoubleNetworkProxy

Properties

AirData Data for air module
DecoupledFileData Actual ResultData object corresponding to DecoupledFile.
EngineNet The EngineNet holds the network that is used for the computations. It is the main entrance to module data/state.
EngineTime NetworkEngine time.
HDModule HDModule solves the HD equations on a EngineNet, and keeps track of state for the HDModule.

The HDModule also implements the IGraph interface, defining only the part of the HD network in the graph.

Id Id of module
Nodes List of all air nodes in network.

Need not include all Engine nodes, use the GetNode(EngineNode) to check if a given engine node also has a corresponding air node.

Order Order of module. Modules are processed in order.
Reaches List of all air reaches in network.

Need not include all Engine reaches, use the GetReach(EngineReach) to check if a given engine reach also has a corresponding air reach.

RuntimeDiagnostics Diagnostics instance for the air module. Used during runtime.

Created in Initialize(DateTime, Diagnostics).

UseHDState Flag specifying to mock air module state using HD module

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows 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
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetNode Maps an EngineNode to the corresponding air node
GetProxy An IQuantityProxy also specifying the geometry that the element values belong to.
GetProxy(EngineNode) Get a proxy for the node
GetProxy(EngineReach) Get a proxy for the reach, covering a number of gridpoints
GetProxy(INetworkNode) Get a proxy for the node
GetProxy(INetworkReach) Get a proxy for the reach, covering a number of gridpoints
GetProxy(EngineReach, Int32) Get a proxy for the gridpoint in the reach
GetProxy(INetworkReach, Int32) Get a proxy for the gridpoint in the reach
GetProxyReachGeneric(EngineReach) Get a proxy for the reach, generic data (not gridpoint associated)
GetProxyReachGeneric(INetworkReach) Get a proxy for the reach, generic data (not gridpoint associated)
GetReach Maps an EngineReach to the corresponding air reach
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates 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 Prepare AirModule for first time step.
PrepareForTimeStep Prepare module for time step (set state(n+1) = state(n)).

Reset Resets some of the AirModule variables to initial values.
ToStringReturns a string that represents the current object.
(Inherited from Object)

Extension Methods

See Also