Click or drag to resize

STModulePreferredTimeStep Method

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.

Namespace:  DHI.Mike1D.Engine.ModuleST
Assembly:  DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
Copy
public TimeSpan PreferredTimeStep(
	bool onFailure,
	TimeSpan maxDt
)

Parameters

onFailure
Type: SystemBoolean

[Missing <param name="onFailure"/> documentation for "M:DHI.Mike1D.Engine.ModuleST.STModule.PreferredTimeStep(System.Boolean,System.TimeSpan)"]

maxDt
Type: SystemTimeSpan

[Missing <param name="maxDt"/> documentation for "M:DHI.Mike1D.Engine.ModuleST.STModule.PreferredTimeStep(System.Boolean,System.TimeSpan)"]

Return Value

Type: TimeSpan

[Missing <returns> documentation for "M:DHI.Mike1D.Engine.ModuleST.STModule.PreferredTimeStep(System.Boolean,System.TimeSpan)"]

Implements

IModulePreferredTimeStep(Boolean, TimeSpan)
See Also