EngineTimeSteppingAdaptive Class

Class handling adaptive time stepping

Definition

Namespace: DHI.Mike1D.Engine
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class EngineTimeSteppingAdaptive : IEngineTimeStepAdaptive, 
	IEngineTimeStep
Inheritance
Object    EngineTimeSteppingAdaptive
Implements
IEngineTimeStep, IEngineTimeStepAdaptive

Constructors

Properties

DtMax Maximum allowed time step
DtMin Minimum allowed time step
FixedChangeFactor Change factor to multiply or divide the current time step with, in case UsedFixedChangeFactor has been set.
SimulationEndTime End of simulation time
TimeStepOk Flag indicating if last time step was OK.
UsedFixedChangeFactor Flag indicating whether to use the constant change factor FixedChangeFactor

Methods

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

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)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
NextTimeStep Return the new time step, based on the current time.
Prepare 
Reset Reset the time stepping information.
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

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

See Also