TimeStepControl manages the time step size. There several mechanisms that effect the time step size and handled with this class: More...

#include <Tempus_Integrator.hpp>

Inherits Describable, and VerboseObject< Tempus::TimeStepControl< Scalar > >.

Public Member Functions
	TimeStepControl ()
	Default Constructor. More...

	TimeStepControl (Scalar initTime, Scalar finalTime, Scalar minTimeStep, Scalar initTimeStep, Scalar maxTimeStep, int initIndex, int finalIndex, Scalar maxAbsError, Scalar maxRelError, int maxFailures, int maxConsecFailures, int numTimeSteps, bool printDtChanges, bool outputExactly, std::vector< int > outputIndices, std::vector< Scalar > outputTimes, int outputIndexInterval, Scalar outputTimeInterval, Teuchos::RCP< TimeStepControlStrategy< Scalar >> stepControlStrategy)
	Constructor. More...

virtual	~TimeStepControl ()
	Destructor. More...

virtual void	getNextTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &sh, Status &integratorStatus)
	Deprecated get the time step size. More...

virtual void	setNextTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory, Status &integratorStatus)
	Determine the time step size. More...

virtual bool	timeInRange (const Scalar time) const
	Check if time is within minimum and maximum time. More...

virtual bool	indexInRange (const int iStep) const
	Check if time step index is within minimum and maximum index. More...

virtual Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const
	Return ParameterList with current values. More...

virtual void	printDtChanges (int istep, Scalar dt_old, Scalar dt_new, std::string reason) const

virtual void	initialize () const

virtual bool	isInitialized ()

virtual void	checkInitialized ()

Protected Attributes
bool	isInitialized_
	Bool if TimeStepControl is initialized. More...

Scalar	initTime_
	Initial Time. More...

Scalar	finalTime_
	Final Time. More...

Scalar	minTimeStep_
	Minimum Time Step. More...

Scalar	initTimeStep_
	Initial Time Step. More...

Scalar	maxTimeStep_
	Maximum Time Step. More...

int	initIndex_
	Initial Time Index. More...

int	finalIndex_
	Final Time Index. More...

Scalar	maxAbsError_
	Maximum Absolute Error. More...

Scalar	maxRelError_
	Maximum Relative Error. More...

int	maxFailures_
	Maximum Number of Stepper Failures. More...

int	maxConsecFailures_
	Maximum Number of Consecutive Stepper Failures. More...

int	numTimeSteps_
	Number of time steps for Constant time step. More...

bool	printDtChanges_
	Print timestep size when it changes. More...

bool	outputExactly_
	Output Exactly On Output Times. More...

std::vector< int >	outputIndices_
	Vector of output indices. More...

std::vector< Scalar >	outputTimes_
	Vector of output times. More...

int	outputIndexInterval_

Scalar	outputTimeInterval_

bool	outputAdjustedDt_
	Flag indicating that dt was adjusted for output. More...

Scalar	dtAfterOutput_
	dt to reinstate after output step. More...

Teuchos::RCP< TimeStepControlStrategy< Scalar > >	stepControlStrategy_

Overridden from Teuchos::Describable
std::string	description () const

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

Get accessors
virtual std::string	getStepType () const

virtual Scalar	getInitTime () const

virtual Scalar	getFinalTime () const

virtual Scalar	getMinTimeStep () const

virtual Scalar	getInitTimeStep () const

virtual Scalar	getMaxTimeStep () const

virtual int	getInitIndex () const

virtual int	getFinalIndex () const

virtual Scalar	getMaxAbsError () const

virtual Scalar	getMaxRelError () const

virtual bool	getOutputExactly () const

virtual std::vector< int >	getOutputIndices () const

virtual std::vector< Scalar >	getOutputTimes () const

virtual int	getMaxFailures () const

virtual int	getMaxConsecFailures () const

virtual bool	getPrintDtChanges () const

virtual int	getNumTimeSteps () const

virtual Teuchos::RCP< TimeStepControlStrategy< Scalar > >	getTimeStepControlStrategy () const

virtual int	getOutputIndexInterval () const

virtual Scalar	getOutputTimeInterval () const

Set accessors
virtual void	setInitTime (Scalar t)

virtual void	setFinalTime (Scalar t)

virtual void	setMinTimeStep (Scalar t)

virtual void	setInitTimeStep (Scalar t)

virtual void	setMaxTimeStep (Scalar t)

virtual void	setInitIndex (int i)

virtual void	setFinalIndex (int i)

virtual void	setMaxAbsError (Scalar e)

virtual void	setMaxRelError (Scalar e)

virtual void	setMaxFailures (int i)

virtual void	setMaxConsecFailures (int i)

virtual void	setPrintDtChanges (bool b)

virtual void	setNumTimeSteps (int numTimeSteps)

virtual void	setOutputExactly (bool b)

virtual void	setOutputIndices (std::vector< int > v)

virtual void	setOutputTimes (std::vector< Scalar > v)

virtual void	setOutputIndexInterval (int i)

virtual void	setOutputTimeInterval (Scalar t)

virtual void	setTimeStepControlStrategy (Teuchos::RCP< TimeStepControlStrategy< Scalar > > tscs=Teuchos::null)

Detailed Description

template<class Scalar>
class Tempus::TimeStepControl< Scalar >

TimeStepControl manages the time step size. There several mechanisms that effect the time step size and handled with this class:

Maximum and minimum time
Maximum and minimum time index
Maximum and minimum time step size
Maximum and minimum error
Startup considerations (e.g., ramping)
Solution and/or diagnostic output Additional step control can be added through the step control observer, or inheriting from this class.
Stability limits (e.g., CFL number)

Using TimeStepControlStrategy allows applications to define their very own strategy used to determine the next time step size (setNextTimeStep()). Applications can define multiple strategies and add it to a vector of strategies TimeStepControlStrategyComposite using setTimeStepControlStrategy(). TimeStepControlStrategyComposite iterates over the list of strategies to determine the "optimal" next time step size.

Definition at line 26 of file Tempus_Integrator.hpp.

Constructor & Destructor Documentation

◆ TimeStepControl() [1/2]

template<class Scalar >

Tempus::TimeStepControl< Scalar >::TimeStepControl ( )

Default Constructor.

Definition at line 23 of file Tempus_TimeStepControl_impl.hpp.

◆ TimeStepControl() [2/2]

template<class Scalar >

Tempus::TimeStepControl< Scalar >::TimeStepControl	(	Scalar	initTime,
		Scalar	finalTime,
		Scalar	minTimeStep,
		Scalar	initTimeStep,
		Scalar	maxTimeStep,
		int	initIndex,
		int	finalIndex,
		Scalar	maxAbsError,
		Scalar	maxRelError,
		int	maxFailures,
		int	maxConsecFailures,
		int	numTimeSteps,
		bool	printDtChanges,
		bool	outputExactly,
		std::vector< int >	outputIndices,
		std::vector< Scalar >	outputTimes,
		int	outputIndexInterval,
		Scalar	outputTimeInterval,
		Teuchos::RCP< TimeStepControlStrategy< Scalar >>	stepControlStrategy
	)

Constructor.

Definition at line 52 of file Tempus_TimeStepControl_impl.hpp.

◆ ~TimeStepControl()

template<class Scalar>

virtual Tempus::TimeStepControl< Scalar >::~TimeStepControl ( )

inlinevirtual

Destructor.

Definition at line 81 of file Tempus_TimeStepControl_decl.hpp.

Member Function Documentation

◆ getNextTimeStep()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::getNextTimeStep	(	const Teuchos::RCP< SolutionHistory< Scalar > > &	sh,
		Status &	integratorStatus
	)

inlinevirtual

Deprecated get the time step size.

Definition at line 85 of file Tempus_TimeStepControl_decl.hpp.

◆ setNextTimeStep()

template<class Scalar >

void Tempus::TimeStepControl< Scalar >::setNextTimeStep	(	const Teuchos::RCP< SolutionHistory< Scalar > > &	solutionHistory,
		Status &	integratorStatus
	)

virtual

Determine the time step size.

Definition at line 200 of file Tempus_TimeStepControl_impl.hpp.

◆ timeInRange()

template<class Scalar >

bool Tempus::TimeStepControl< Scalar >::timeInRange ( const Scalar time ) const

virtual

Check if time is within minimum and maximum time.

Test if time is within range: include initTime and exclude finalTime.

Definition at line 392 of file Tempus_TimeStepControl_impl.hpp.

◆ indexInRange()

template<class Scalar >

bool Tempus::TimeStepControl< Scalar >::indexInRange ( const int iStep ) const

virtual

Check if time step index is within minimum and maximum index.

Test if index is within range: include initIndex and exclude finalIndex.

Definition at line 412 of file Tempus_TimeStepControl_impl.hpp.

◆ getValidParameters()

template<class Scalar >

Teuchos::RCP< const Teuchos::ParameterList > Tempus::TimeStepControl< Scalar >::getValidParameters ( ) const

virtual

Return ParameterList with current values.

Definition at line 531 of file Tempus_TimeStepControl_impl.hpp.

◆ description()

template<class Scalar >

std::string Tempus::TimeStepControl< Scalar >::description ( ) const

Definition at line 451 of file Tempus_TimeStepControl_impl.hpp.

◆ describe()

template<class Scalar >

void Tempus::TimeStepControl< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)		const

Definition at line 459 of file Tempus_TimeStepControl_impl.hpp.

◆ getStepType()

template<class Scalar>

virtual std::string Tempus::TimeStepControl< Scalar >::getStepType ( ) const

inlinevirtual

Definition at line 116 of file Tempus_TimeStepControl_decl.hpp.

◆ getInitTime()

template<class Scalar>

virtual Scalar Tempus::TimeStepControl< Scalar >::getInitTime ( ) const

inlinevirtual

Definition at line 117 of file Tempus_TimeStepControl_decl.hpp.

◆ getFinalTime()

template<class Scalar>

virtual Scalar Tempus::TimeStepControl< Scalar >::getFinalTime ( ) const

inlinevirtual

Definition at line 118 of file Tempus_TimeStepControl_decl.hpp.

◆ getMinTimeStep()

template<class Scalar>

virtual Scalar Tempus::TimeStepControl< Scalar >::getMinTimeStep ( ) const

inlinevirtual

Definition at line 119 of file Tempus_TimeStepControl_decl.hpp.

◆ getInitTimeStep()

template<class Scalar>

virtual Scalar Tempus::TimeStepControl< Scalar >::getInitTimeStep ( ) const

inlinevirtual

Definition at line 120 of file Tempus_TimeStepControl_decl.hpp.

◆ getMaxTimeStep()

template<class Scalar>

virtual Scalar Tempus::TimeStepControl< Scalar >::getMaxTimeStep ( ) const

inlinevirtual

Definition at line 121 of file Tempus_TimeStepControl_decl.hpp.

◆ getInitIndex()

template<class Scalar>

virtual int Tempus::TimeStepControl< Scalar >::getInitIndex ( ) const

inlinevirtual

Definition at line 122 of file Tempus_TimeStepControl_decl.hpp.

◆ getFinalIndex()

template<class Scalar>

virtual int Tempus::TimeStepControl< Scalar >::getFinalIndex ( ) const

inlinevirtual

Definition at line 123 of file Tempus_TimeStepControl_decl.hpp.

◆ getMaxAbsError()

template<class Scalar>

virtual Scalar Tempus::TimeStepControl< Scalar >::getMaxAbsError ( ) const

inlinevirtual

Definition at line 124 of file Tempus_TimeStepControl_decl.hpp.

◆ getMaxRelError()

template<class Scalar>

virtual Scalar Tempus::TimeStepControl< Scalar >::getMaxRelError ( ) const

inlinevirtual

Definition at line 125 of file Tempus_TimeStepControl_decl.hpp.

◆ getOutputExactly()

template<class Scalar>

virtual bool Tempus::TimeStepControl< Scalar >::getOutputExactly ( ) const

inlinevirtual

Definition at line 126 of file Tempus_TimeStepControl_decl.hpp.

◆ getOutputIndices()

template<class Scalar>

virtual std::vector<int> Tempus::TimeStepControl< Scalar >::getOutputIndices ( ) const

inlinevirtual

Definition at line 127 of file Tempus_TimeStepControl_decl.hpp.

◆ getOutputTimes()

template<class Scalar>

virtual std::vector<Scalar> Tempus::TimeStepControl< Scalar >::getOutputTimes ( ) const

inlinevirtual

Definition at line 128 of file Tempus_TimeStepControl_decl.hpp.

◆ getMaxFailures()

template<class Scalar>

virtual int Tempus::TimeStepControl< Scalar >::getMaxFailures ( ) const

inlinevirtual

Definition at line 129 of file Tempus_TimeStepControl_decl.hpp.

◆ getMaxConsecFailures()

template<class Scalar>

virtual int Tempus::TimeStepControl< Scalar >::getMaxConsecFailures ( ) const

inlinevirtual

Definition at line 130 of file Tempus_TimeStepControl_decl.hpp.

◆ getPrintDtChanges()

template<class Scalar>

virtual bool Tempus::TimeStepControl< Scalar >::getPrintDtChanges ( ) const

inlinevirtual

Definition at line 131 of file Tempus_TimeStepControl_decl.hpp.

◆ getNumTimeSteps()

template<class Scalar>

virtual int Tempus::TimeStepControl< Scalar >::getNumTimeSteps ( ) const

inlinevirtual

Definition at line 132 of file Tempus_TimeStepControl_decl.hpp.

◆ getTimeStepControlStrategy()

template<class Scalar>

virtual Teuchos::RCP<TimeStepControlStrategy<Scalar> > Tempus::TimeStepControl< Scalar >::getTimeStepControlStrategy ( ) const

inlinevirtual

Definition at line 135 of file Tempus_TimeStepControl_decl.hpp.

◆ getOutputIndexInterval()

template<class Scalar>

virtual int Tempus::TimeStepControl< Scalar >::getOutputIndexInterval ( ) const

inlinevirtual

Definition at line 136 of file Tempus_TimeStepControl_decl.hpp.

◆ getOutputTimeInterval()

template<class Scalar>

virtual Scalar Tempus::TimeStepControl< Scalar >::getOutputTimeInterval ( ) const

inlinevirtual

Definition at line 137 of file Tempus_TimeStepControl_decl.hpp.

◆ setInitTime()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setInitTime ( Scalar t )

inlinevirtual

Definition at line 142 of file Tempus_TimeStepControl_decl.hpp.

◆ setFinalTime()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setFinalTime ( Scalar t )

inlinevirtual

Definition at line 143 of file Tempus_TimeStepControl_decl.hpp.

◆ setMinTimeStep()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setMinTimeStep ( Scalar t )

inlinevirtual

Definition at line 144 of file Tempus_TimeStepControl_decl.hpp.

◆ setInitTimeStep()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setInitTimeStep ( Scalar t )

inlinevirtual

Definition at line 145 of file Tempus_TimeStepControl_decl.hpp.

◆ setMaxTimeStep()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setMaxTimeStep ( Scalar t )

inlinevirtual

Definition at line 146 of file Tempus_TimeStepControl_decl.hpp.

◆ setInitIndex()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setInitIndex ( int i )

inlinevirtual

Definition at line 147 of file Tempus_TimeStepControl_decl.hpp.

◆ setFinalIndex()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setFinalIndex ( int i )

inlinevirtual

Definition at line 148 of file Tempus_TimeStepControl_decl.hpp.

◆ setMaxAbsError()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setMaxAbsError ( Scalar e )

inlinevirtual

Definition at line 149 of file Tempus_TimeStepControl_decl.hpp.

◆ setMaxRelError()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setMaxRelError ( Scalar e )

inlinevirtual

Definition at line 150 of file Tempus_TimeStepControl_decl.hpp.

◆ setMaxFailures()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setMaxFailures ( int i )

inlinevirtual

Definition at line 151 of file Tempus_TimeStepControl_decl.hpp.

◆ setMaxConsecFailures()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setMaxConsecFailures ( int i )

inlinevirtual

Definition at line 152 of file Tempus_TimeStepControl_decl.hpp.

◆ setPrintDtChanges()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setPrintDtChanges ( bool b )

inlinevirtual

Definition at line 153 of file Tempus_TimeStepControl_decl.hpp.

◆ setNumTimeSteps()

template<class Scalar >

void Tempus::TimeStepControl< Scalar >::setNumTimeSteps ( int numTimeSteps )

virtual

Definition at line 419 of file Tempus_TimeStepControl_impl.hpp.

◆ setOutputExactly()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setOutputExactly ( bool b )

inlinevirtual

Definition at line 156 of file Tempus_TimeStepControl_decl.hpp.

◆ setOutputIndices()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setOutputIndices ( std::vector< int > v )

inlinevirtual

Definition at line 157 of file Tempus_TimeStepControl_decl.hpp.

◆ setOutputTimes()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setOutputTimes ( std::vector< Scalar > v )

inlinevirtual

Definition at line 158 of file Tempus_TimeStepControl_decl.hpp.

◆ setOutputIndexInterval()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setOutputIndexInterval ( int i )

inlinevirtual

Definition at line 159 of file Tempus_TimeStepControl_decl.hpp.

◆ setOutputTimeInterval()

template<class Scalar>

virtual void Tempus::TimeStepControl< Scalar >::setOutputTimeInterval ( Scalar t )

inlinevirtual

Definition at line 160 of file Tempus_TimeStepControl_decl.hpp.

◆ setTimeStepControlStrategy()

template<class Scalar >

void Tempus::TimeStepControl< Scalar >::setTimeStepControlStrategy ( Teuchos::RCP< TimeStepControlStrategy< Scalar > > tscs = Teuchos::null )

virtual

Definition at line 514 of file Tempus_TimeStepControl_impl.hpp.

◆ printDtChanges()

template<class Scalar >

void Tempus::TimeStepControl< Scalar >::printDtChanges	(	int	istep,
		Scalar	dt_old,
		Scalar	dt_new,
		std::string	reason
	)		const

virtual

Definition at line 170 of file Tempus_TimeStepControl_impl.hpp.

◆ initialize()

template<class Scalar >

void Tempus::TimeStepControl< Scalar >::initialize ( ) const

virtual

Definition at line 101 of file Tempus_TimeStepControl_impl.hpp.

◆ isInitialized()

template<class Scalar>

virtual bool Tempus::TimeStepControl< Scalar >::isInitialized ( )

inlinevirtual

Definition at line 170 of file Tempus_TimeStepControl_decl.hpp.

◆ checkInitialized()

template<class Scalar >

void Tempus::TimeStepControl< Scalar >::checkInitialized ( )

virtual

Definition at line 189 of file Tempus_TimeStepControl_impl.hpp.

Member Data Documentation

◆ isInitialized_

template<class Scalar>

bool Tempus::TimeStepControl< Scalar >::isInitialized_

mutableprotected

Bool if TimeStepControl is initialized.

Definition at line 175 of file Tempus_TimeStepControl_decl.hpp.

◆ initTime_

template<class Scalar>

Scalar Tempus::TimeStepControl< Scalar >::initTime_

protected

Initial Time.

Definition at line 176 of file Tempus_TimeStepControl_decl.hpp.

◆ finalTime_

template<class Scalar>

Scalar Tempus::TimeStepControl< Scalar >::finalTime_

protected

Final Time.

Definition at line 177 of file Tempus_TimeStepControl_decl.hpp.

◆ minTimeStep_

template<class Scalar>

Scalar Tempus::TimeStepControl< Scalar >::minTimeStep_

protected

Minimum Time Step.

Definition at line 178 of file Tempus_TimeStepControl_decl.hpp.

◆ initTimeStep_

template<class Scalar>

Scalar Tempus::TimeStepControl< Scalar >::initTimeStep_

protected

Initial Time Step.

Definition at line 179 of file Tempus_TimeStepControl_decl.hpp.

◆ maxTimeStep_

template<class Scalar>

Scalar Tempus::TimeStepControl< Scalar >::maxTimeStep_

protected

Maximum Time Step.

Definition at line 180 of file Tempus_TimeStepControl_decl.hpp.

◆ initIndex_

template<class Scalar>

int Tempus::TimeStepControl< Scalar >::initIndex_

protected

Initial Time Index.

Definition at line 181 of file Tempus_TimeStepControl_decl.hpp.

◆ finalIndex_

template<class Scalar>

int Tempus::TimeStepControl< Scalar >::finalIndex_

protected

Final Time Index.

Definition at line 182 of file Tempus_TimeStepControl_decl.hpp.

◆ maxAbsError_

template<class Scalar>

Scalar Tempus::TimeStepControl< Scalar >::maxAbsError_

protected

Maximum Absolute Error.

Definition at line 183 of file Tempus_TimeStepControl_decl.hpp.

◆ maxRelError_

template<class Scalar>

Scalar Tempus::TimeStepControl< Scalar >::maxRelError_

protected

Maximum Relative Error.

Definition at line 184 of file Tempus_TimeStepControl_decl.hpp.

◆ maxFailures_

template<class Scalar>

int Tempus::TimeStepControl< Scalar >::maxFailures_

protected

Maximum Number of Stepper Failures.

Definition at line 185 of file Tempus_TimeStepControl_decl.hpp.

◆ maxConsecFailures_

template<class Scalar>

int Tempus::TimeStepControl< Scalar >::maxConsecFailures_

protected

Maximum Number of Consecutive Stepper Failures.

Definition at line 186 of file Tempus_TimeStepControl_decl.hpp.

◆ numTimeSteps_

template<class Scalar>

int Tempus::TimeStepControl< Scalar >::numTimeSteps_

protected

Number of time steps for Constant time step.

Definition at line 187 of file Tempus_TimeStepControl_decl.hpp.

◆ printDtChanges_

template<class Scalar>

bool Tempus::TimeStepControl< Scalar >::printDtChanges_

protected

Print timestep size when it changes.

Definition at line 188 of file Tempus_TimeStepControl_decl.hpp.

◆ outputExactly_

template<class Scalar>

bool Tempus::TimeStepControl< Scalar >::outputExactly_

protected

Output Exactly On Output Times.

Definition at line 190 of file Tempus_TimeStepControl_decl.hpp.

◆ outputIndices_

template<class Scalar>

std::vector<int> Tempus::TimeStepControl< Scalar >::outputIndices_

protected

Vector of output indices.

Definition at line 191 of file Tempus_TimeStepControl_decl.hpp.

◆ outputTimes_

template<class Scalar>

std::vector<Scalar> Tempus::TimeStepControl< Scalar >::outputTimes_

protected

Vector of output times.

Definition at line 192 of file Tempus_TimeStepControl_decl.hpp.

◆ outputIndexInterval_

template<class Scalar>

int Tempus::TimeStepControl< Scalar >::outputIndexInterval_

protected

Definition at line 193 of file Tempus_TimeStepControl_decl.hpp.

◆ outputTimeInterval_

template<class Scalar>

Scalar Tempus::TimeStepControl< Scalar >::outputTimeInterval_

protected

Definition at line 194 of file Tempus_TimeStepControl_decl.hpp.

◆ outputAdjustedDt_

template<class Scalar>

bool Tempus::TimeStepControl< Scalar >::outputAdjustedDt_

protected

Flag indicating that dt was adjusted for output.

Definition at line 196 of file Tempus_TimeStepControl_decl.hpp.

◆ dtAfterOutput_

template<class Scalar>

Scalar Tempus::TimeStepControl< Scalar >::dtAfterOutput_

protected

dt to reinstate after output step.

Definition at line 197 of file Tempus_TimeStepControl_decl.hpp.

◆ stepControlStrategy_

template<class Scalar>

Teuchos::RCP<TimeStepControlStrategy<Scalar> > Tempus::TimeStepControl< Scalar >::stepControlStrategy_

protected

Definition at line 199 of file Tempus_TimeStepControl_decl.hpp.

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

Public Member Functions

Protected Attributes

Overridden from Teuchos::Describable

Get accessors

Set accessors

Detailed Description

template<class Scalar> class Tempus::TimeStepControl< Scalar >

Constructor & Destructor Documentation

◆ TimeStepControl() [1/2]

◆ TimeStepControl() [2/2]

◆ ~TimeStepControl()

Member Function Documentation

◆ getNextTimeStep()

◆ setNextTimeStep()

◆ timeInRange()

◆ indexInRange()

◆ getValidParameters()

◆ description()

◆ describe()

◆ getStepType()

◆ getInitTime()

◆ getFinalTime()

◆ getMinTimeStep()

◆ getInitTimeStep()

◆ getMaxTimeStep()

◆ getInitIndex()

◆ getFinalIndex()

◆ getMaxAbsError()

◆ getMaxRelError()

◆ getOutputExactly()

◆ getOutputIndices()

◆ getOutputTimes()

◆ getMaxFailures()

◆ getMaxConsecFailures()

◆ getPrintDtChanges()

◆ getNumTimeSteps()

◆ getTimeStepControlStrategy()

◆ getOutputIndexInterval()

◆ getOutputTimeInterval()

◆ setInitTime()

◆ setFinalTime()

◆ setMinTimeStep()

◆ setInitTimeStep()

◆ setMaxTimeStep()

◆ setInitIndex()

◆ setFinalIndex()

◆ setMaxAbsError()

◆ setMaxRelError()

◆ setMaxFailures()

◆ setMaxConsecFailures()

◆ setPrintDtChanges()

◆ setNumTimeSteps()

◆ setOutputExactly()

◆ setOutputIndices()

◆ setOutputTimes()

◆ setOutputIndexInterval()

◆ setOutputTimeInterval()

◆ setTimeStepControlStrategy()

◆ printDtChanges()

◆ initialize()

◆ isInitialized()

◆ checkInitialized()

Member Data Documentation

◆ isInitialized_

◆ initTime_

◆ finalTime_

◆ minTimeStep_

◆ initTimeStep_

◆ maxTimeStep_

◆ initIndex_

◆ finalIndex_

◆ maxAbsError_

◆ maxRelError_

◆ maxFailures_

◆ maxConsecFailures_

◆ numTimeSteps_

◆ printDtChanges_

◆ outputExactly_

◆ outputIndices_

◆ outputTimes_

template<class Scalar>
class Tempus::TimeStepControl< Scalar >