Click or drag to resize

DataModulePreferredTimeStep Method

Increase time step after PerformTimestep() returned true. If possible, the time step is increased before next PerformTimestep().

Namespace:  DHI.Mike1D.Engine.ModuleData
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.ModuleData.DataModule.PreferredTimeStep(System.Boolean,System.TimeSpan)"]

maxDt
Type: SystemTimeSpan

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

Return Value

Type: TimeSpan

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

Implements

IModulePreferredTimeStep(Boolean, TimeSpan)
See Also