Click or drag to resize

EngineTimeCheckPointController 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.

Inheritance Hierarchy

Namespace:  DHI.Mike1D.Engine
Assembly:  DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class EngineTimeCheckPointController : TimeCheckPointController

The EngineTimeCheckPointController type exposes the following members.

Constructors
  NameDescription
Public methodEngineTimeCheckPointController
Initializes a new instance of the EngineTimeCheckPointController class
Top
Properties
  NameDescription
Public propertyCheckPoints
List of check points
(Inherited from TimeCheckPointController.)
Public propertyCheckPointSets
List of check point sets
(Inherited from TimeCheckPointController.)
Public propertyLookAhead
Lookahead variables. dt is adjusted to hit checkpoints in _nLookAhead times steps.

Default is 2

(Inherited from TimeCheckPointController.)
Top
Methods
  NameDescription
Public methodAddCheckPoint
Add check point. Time series is written at each check point.
(Inherited from TimeCheckPointController.)
Public methodAddCheckPoints
Add check point. Time series is written at each check point.
(Inherited from TimeCheckPointController.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetCheckpoint
Get the first check point after the provided current time, or MaxValue if no checkpoint exists after current time.
(Inherited from TimeCheckPointController.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLimitToCheckPoint
Make sure next timestep does not go past next CheckPoint. Assume checkpoints are sorted increasingly.
(Inherited from TimeCheckPointController.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare for simulation
(Inherited from TimeCheckPointController.)
Public methodSortCheckPoints
Sort check points. Must be called after all checkpoint have been added and before LimitToCheckPoint() is used
(Inherited from TimeCheckPointController.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also