Click or drag to resize

UtilLimitTimeStepToCheckPoint Method

Make sure timestep hits exactly checkPoint.

The lookAhead parameter defines how many time steps before checkPoint to modify in order to hit the checkPoint. If lookAhead is 1, only the last time step before checkPoint will be modified. If 2, then two time steps before checkPoint will be modified etc.

Assuming checkPoint is after currentTime (suggestedTimeStep is returned).

Namespace:  DHI.Mike1D.Generic
Assembly:  DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
Copy
public static TimeSpan LimitTimeStepToCheckPoint(
	DateTime currentTime,
	TimeSpan suggestedTimeStep,
	DateTime checkPoint,
	int lookAhead
)

Parameters

currentTime
Type: SystemDateTime

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

suggestedTimeStep
Type: SystemTimeSpan

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

checkPoint
Type: SystemDateTime

[Missing <param name="checkPoint"/> documentation for "M:DHI.Mike1D.Generic.Util.LimitTimeStepToCheckPoint(System.DateTime,System.TimeSpan,System.DateTime,System.Int32)"]

lookAhead
Type: SystemInt32

[Missing <param name="lookAhead"/> documentation for "M:DHI.Mike1D.Generic.Util.LimitTimeStepToCheckPoint(System.DateTime,System.TimeSpan,System.DateTime,System.Int32)"]

Return Value

Type: TimeSpan
Time step that is sure to hit exactly checkPoint in this or one of the following time steps
See Also