Alsvinn  0.5.3
The fast FVM simulator with UQ support
Public Member Functions | List of all members
alsfvm::integrator::TimestepAdjuster Class Referenceabstract

The TimestepAdjuster class is an abstract interface for adjusting timesteps. More...

#include <alsfvm/integrator/TimestepAdjuster.hpp>

Inheritance diagram for alsfvm::integrator::TimestepAdjuster:
alsfvm::io::CoarseGrainingIntervalWriter alsfvm::io::FixedIntervalWriter alsuq::stats::FixedIntervalStatistics

Public Member Functions

virtual real adjustTimestep (real dt, const simulator::TimestepInformation &timestepInformation) const =0
 adjustTimestep returns the new timestep that the simulator should use More...
 

Detailed Description

The TimestepAdjuster class is an abstract interface for adjusting timesteps.

The main use is to ensure that we hit the save times exactly, ie. that if the end time is T, then it will truncate the timestep to min(T - currentTime, dt)

Note
The adjuster can only make the timestep SMALLER or equal to the previous given timestep.

Member Function Documentation

◆ adjustTimestep()

virtual real alsfvm::integrator::TimestepAdjuster::adjustTimestep ( real  dt,
const simulator::TimestepInformation timestepInformation 
) const
pure virtual

adjustTimestep returns the new timestep that the simulator should use

Parameters
dtthe current timestep being used
timestepInformationtimesteps information
Returns
the new timestep

Implemented in alsfvm::io::CoarseGrainingIntervalWriter, alsfvm::io::FixedIntervalWriter, and alsuq::stats::FixedIntervalStatistics.


The documentation for this class was generated from the following file: