ADModule Class

AD module handles component transport

Inheritance Hierarchy

SystemObject
DHI.Mike1D.Engine.ModuleADADModule

Namespace: DHI.Mike1D.Engine.ModuleAD
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class ADModule : IModule, IModuleNetwork, 
	IModuleNetwork<IADNode, IADReach>, IModelStateReadWrite, IProxyProvider, 
	ISourcePointProxyProvider

Public Class ADModule
	Implements IModule, IModuleNetwork, IModuleNetwork(Of IADNode, IADReach), 
	IModelStateReadWrite, IProxyProvider, ISourcePointProxyProvider

public ref class ADModule : IModule, 
	IModuleNetwork, IModuleNetwork<IADNode^, IADReach^>, IModelStateReadWrite, 
	IProxyProvider, ISourcePointProxyProvider

The ADModule type exposes the following members.

Properties

	Name	Description
	Components	AD components, shortcut to AD Data components list
	Id	Id of module
	Nodes	List of AD Nodes
	Order	Order of module. Modules are processed in order. The AD module must run after the HD module. The HD module has order 200.
	Reaches	List of AD Reaches

Top

Methods

	Name	Description
	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
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetNode	Maps an EngineNode to the corresponding AD Node
	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)
	GetReach	Maps an EngineReach to the corresponding AD Reach
	GetSourcePointProxy(EngineNode)	Get a source point proxy for the node. Usually this can only be called after the Prepare(Diagnostics) function has been called.
	GetSourcePointProxy(EngineReach, Int32)	Get a source point proxy for the gridpoint in the reach. Usually this can only be called after the Prepare(Diagnostics) function has been called.
	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.
	PerformTimestep(Int32)	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 module for first time step.
	PrepareForTimeStep	Prepare module for time step (set state(n+1) = state(n)).
	ReadState
	SetInitialValues
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteState	Write current state of module

Top

Fields

	Name	Description
	STWaterVolumeErrorConcentrationCorrection	Flag indicating how water volume errors are handled for suspended ST components. When true, the concentration is kept constant, and mass is added/removed matching the volume error. When false, the mass is kept constant, and the concentration changes with the volume error. Default is false
	WaterVolumeErrorConcentrationCorrection	Flag indicating how water volume errors are handled for AD components. When true, the concentration is kept constant, and mass is added/removed matching the volume error. When false, the mass is kept constant, and the concentration changes with the volume error. Default is true

Top

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

Top

Reference

DHI.Mike1D.Engine.ModuleAD Namespace