TimeCheckPointControllerLimitToCheckPoint Method

Make sure next timestep does not go past next CheckPoint. Assume checkpoints are sorted increasingly.

Definition

Namespace: DHI.Mike1D.Generic
Assembly: DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public TimeSpan LimitToCheckPoint(
	DateTime currentTime,
	TimeSpan suggestedTimeStep
)

Parameters

currentTime  DateTime

[Missing <param name="currentTime"/> documentation for "M:DHI.Mike1D.Generic.TimeCheckPointController.LimitToCheckPoint(System.DateTime,System.TimeSpan)"]

suggestedTimeStep  TimeSpan

[Missing <param name="suggestedTimeStep"/> documentation for "M:DHI.Mike1D.Generic.TimeCheckPointController.LimitToCheckPoint(System.DateTime,System.TimeSpan)"]

Return Value

TimeSpan

[Missing <returns> documentation for "M:DHI.Mike1D.Generic.TimeCheckPointController.LimitToCheckPoint(System.DateTime,System.TimeSpan)"]

See Also