Click or drag to resize

EngineTimeSteppingAdaptive Class

Class handling adaptive time stepping
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.EngineEngineTimeSteppingAdaptive

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 EngineTimeSteppingAdaptive : IEngineTimeStepAdaptive, 
	IEngineTimeStep

The EngineTimeSteppingAdaptive type exposes the following members.

Constructors
  NameDescription
Public methodEngineTimeSteppingAdaptive(EngineNet)
Default constructor
Public methodEngineTimeSteppingAdaptive(EngineNet, TimeStepping)
Default constructor
Top
Properties
  NameDescription
Public propertyDtMax
Maximum allowed time step
Public propertyDtMin
Minimum allowed time step
Public propertyFixedChangeFactor
Change factor to multiply or divide the current time step with, in case UsedFixedChangeFactor has been set.
Public propertySimulationEndTime
End of simulation time
Public propertyTimeStepOk
Flag indicating if last time step was OK.
Public propertyUsedFixedChangeFactor
Flag indicating whether to use the constant change factor FixedChangeFactor
Top
Methods
  NameDescription
Public methodDecreaseTimeStep
Returns a new decreased time step, based on the current time and the current dt.

This method is called when a time step has been rejected and needs to be re-evaluated, hence this method must return a time step that is smaller than the current one.

If the currentDt is already the minimum allowed time step, this can be returned again.

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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNextTimeStep
Return the new time step, based on the current time.
Public methodPrepare
Public methodReset
Reset the time stepping information.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldAdaptiveSafeFactor
Factor to multiply the preferred time step.

1.0 is not optimal, because then too many time steps fail. Tests has indicated values between 0.95 and 0.99 to be optimal for M11 type setups and between 0.8 and 0.9 for MU type setups.

Top
See Also