AdaptiveTSCheckSolutionConstraintsPreferredTimeStep Method

Calculate preferred time step

Definition

Namespace: DHI.Mike1D.Engine.ModuleHD
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public TimeSpan PreferredTimeStep(
	TimeSpan previousDt,
	DateTime timeN,
	bool onFailure,
	TimeSpan maxDt
)

Parameters

previousDt  TimeSpan

[Missing <param name="previousDt"/> documentation for "M:DHI.Mike1D.Engine.ModuleHD.AdaptiveTSCheckSolutionConstraints.PreferredTimeStep(System.TimeSpan,System.DateTime,System.Boolean,System.TimeSpan)"]

timeN  DateTime

[Missing <param name="timeN"/> documentation for "M:DHI.Mike1D.Engine.ModuleHD.AdaptiveTSCheckSolutionConstraints.PreferredTimeStep(System.TimeSpan,System.DateTime,System.Boolean,System.TimeSpan)"]

onFailure  Boolean

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

maxDt  TimeSpan

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

Return Value

TimeSpan

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

See Also