TimeCheckPointController Class

The check point controller contains functionality for limiting the time step to a set of check points in time.

It contains itself a list of check points, where check points can be added, CheckPoints.

It also contains a list of ITimeCheckPointSet, CheckPointSets, in case a user implementation of a check point set is appropriate (e.g. constant equidistant check points)

All check points within the list of check points and the list of check point sets will be considered as check points.

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 class TimeCheckPointController : ITimeCheckPointSet
Inheritance
Object    TimeCheckPointController
Derived
Implements
ITimeCheckPointSet

Constructors

TimeCheckPointControllerInitializes a new instance of the TimeCheckPointController class

Properties

CheckPoints List of check points
CheckPointSets List of check point sets
LookAhead Lookahead variables. dt is adjusted to hit checkpoints in _nLookAhead times steps.

Default is 2

Methods

AddCheckPoint Add check point. Time series is written at each check point.
AddCheckPoints Add check point. Time series is written at each check point.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetCheckpoint Get the first check point after the provided current time, or MaxValue if no checkpoint exists after current time.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
LimitToCheckPoint Make sure next timestep does not go past next CheckPoint. Assume checkpoints are sorted increasingly.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare for simulation
SortCheckPoints Sort check points. Must be called after all checkpoint have been added and before LimitToCheckPoint() is used
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also