Tempus::TimeStepControlStrategyConstant< Scalar > Class Template Reference

StepControlStrategy class for TimeStepControl. More...

#include <Tempus_TimeStepControlStrategyConstant.hpp>

Inheritance diagram for Tempus::TimeStepControlStrategyConstant< Scalar >:

Public Member Functions
	TimeStepControlStrategyConstant ()
	Default Constructor.
	TimeStepControlStrategyConstant (Scalar constantTimeStep, std::string name="Constant")
	Full Constructor.
virtual	~TimeStepControlStrategyConstant ()
	Destructor.
virtual void	setNextTimeStep (const TimeStepControl< Scalar > &tsc, Teuchos::RCP< SolutionHistory< Scalar > > solutionHistory, Status &integratorStatus) override
	Determine the time step size.
Public Member Functions inherited from Tempus::TimeStepControlStrategy< Scalar >
	TimeStepControlStrategy ()
	Constructor.
virtual	~TimeStepControlStrategy ()
	Destructor.
virtual bool	isInitialized ()
virtual void	checkInitialized ()
virtual void	setName (std::string s)
virtual std::string	getStrategyType () const
virtual std::string	getStepType () const
virtual std::string	getName () const

Overridden from Teuchos::Describable
Scalar	constantTimeStep_
	Constant time step size.
std::string	description () const override
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override
virtual Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const override
	Return ParameterList with current values.
virtual void	initialize () const override
virtual Scalar	getConstantTimeStep () const
virtual void	setConstantTimeStep (Scalar dt)

Additional Inherited Members
Protected Member Functions inherited from Tempus::TimeStepControlStrategy< Scalar >
virtual void	setStrategyType (std::string s)
virtual void	setStepType (std::string s)
Protected Attributes inherited from Tempus::TimeStepControlStrategy< Scalar >
std::string	strategyType_
	Strategy type.
std::string	stepType_
	Step Type - "Constant" or "Variable".
std::string	name_
	Name of strategy.
bool	isInitialized_
	Bool if strategy is initialized.

Detailed Description

template<class Scalar>
class Tempus::TimeStepControlStrategyConstant< Scalar >

StepControlStrategy class for TimeStepControl.

Definition at line 25 of file Tempus_TimeStepControlStrategyConstant.hpp.

Constructor & Destructor Documentation

TimeStepControlStrategyConstant() [1/2]

template<class Scalar >

Tempus::TimeStepControlStrategyConstant< Scalar >::TimeStepControlStrategyConstant ( )

inline

Default Constructor.

Definition at line 29 of file Tempus_TimeStepControlStrategyConstant.hpp.

TimeStepControlStrategyConstant() [2/2]

template<class Scalar >

Tempus::TimeStepControlStrategyConstant< Scalar >::TimeStepControlStrategyConstant ( Scalar  constantTimeStep, std::string  name = "Constant"  )

inline

Full Constructor.

Definition at line 38 of file Tempus_TimeStepControlStrategyConstant.hpp.

~TimeStepControlStrategyConstant()

template<class Scalar >

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

inlinevirtual

Destructor.

Definition at line 49 of file Tempus_TimeStepControlStrategyConstant.hpp.

Member Function Documentation

setNextTimeStep()

template<class Scalar >

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

inlineoverridevirtual

Determine the time step size.

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 52 of file Tempus_TimeStepControlStrategyConstant.hpp.

description()

template<class Scalar >

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

inlineoverride

Definition at line 120 of file Tempus_TimeStepControlStrategyConstant.hpp.

describe()

template<class Scalar >

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

inlineoverride

Definition at line 125 of file Tempus_TimeStepControlStrategyConstant.hpp.

getValidParameters()

template<class Scalar >

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

inlineoverridevirtual

Return ParameterList with current values.

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 145 of file Tempus_TimeStepControlStrategyConstant.hpp.

initialize()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyConstant< Scalar >::initialize ( ) const

inlineoverridevirtual

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 157 of file Tempus_TimeStepControlStrategyConstant.hpp.

getConstantTimeStep()

template<class Scalar >

virtual Scalar Tempus::TimeStepControlStrategyConstant< Scalar >::getConstantTimeStep ( ) const

inlinevirtual

Definition at line 162 of file Tempus_TimeStepControlStrategyConstant.hpp.

setConstantTimeStep()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyConstant< Scalar >::setConstantTimeStep ( Scalar  dt )

inlinevirtual

Definition at line 164 of file Tempus_TimeStepControlStrategyConstant.hpp.

Member Data Documentation

constantTimeStep_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyConstant< Scalar >::constantTimeStep_

private

Constant time step size.

Definition at line 171 of file Tempus_TimeStepControlStrategyConstant.hpp.

---

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

• Tempus_TimeStepControlStrategyConstant.hpp