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

Do return the maximum of the allowed time step; in case a buffer is required, this is handled by a time step controller.

Definition

Namespace: DHI.Mike1D.Engine.ModuleRouting
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)

C#

public TimeSpan PreferredTimeStep(
	bool onFailure,
	TimeSpan maxDt
)

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

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