Base class for Runge-Kutta methods, ExplicitRK, DIRK and IMEX. More...

#include <Tempus_StepperRKAppAction.hpp>

Inheritance diagram for Tempus::StepperRKBase< Scalar >:

Public Member Functions
virtual Teuchos::RCP< const RKButcherTableau< Scalar > >	getTableau () const

virtual Scalar	getOrder () const

virtual Scalar	getOrderMin () const

virtual Scalar	getOrderMax () const

virtual int	getNumberOfStages () const

virtual int	getStageNumber () const

virtual void	setStageNumber (int s)

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStageX ()

virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > >	getStageX () const

virtual void	setAppAction (Teuchos::RCP< StepperRKAppAction< Scalar > > appAction)

virtual Teuchos::RCP < StepperRKAppAction< Scalar > >	getAppAction () const

Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual bool	isValidSetup (Teuchos::FancyOStream &out) const

virtual Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const =0

virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)

virtual void	setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &)

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getModel ()

virtual void	setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver)
	Set solver. More...

virtual Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > >	getSolver () const
	Get solver. More...

virtual void	setObserver (Teuchos::RCP< StepperObserver< Scalar > > obs=Teuchos::null)
	Set Observer. More...

virtual Teuchos::RCP < StepperObserver< Scalar > >	getObserver () const
	Get Observer. More...

virtual void	initialize ()
	Initialize after construction and changing input parameters. More...

virtual bool	isInitialized ()
	True if stepper's member data is initialized. More...

virtual void	checkInitialized ()
	Check initialization, and error out on failure. More...

virtual void	setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)=0
	Set initial conditions, make them consistent, and set stepper memory. More...

virtual void	takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)=0
	Take the specified timestep, dt, and return true if successful. More...

virtual void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initialGuess=Teuchos::null)=0
	Pass initial guess to Newton solver (for implicit schemes) More...

virtual Teuchos::RCP < Tempus::StepperState< Scalar > >	getDefaultStepperState ()=0

virtual Scalar	getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const =0

virtual bool	isExplicit () const =0

virtual bool	isImplicit () const =0

virtual bool	isExplicitImplicit () const =0

virtual bool	isOneStepMethod () const =0

virtual bool	isMultiStepMethod () const =0

void	setStepperType (std::string s)

std::string	getStepperType () const

void	setUseFSAL (bool a)

bool	getUseFSAL () const

virtual bool	getUseFSALDefault () const

void	setICConsistency (std::string s)

std::string	getICConsistency () const

virtual std::string	getICConsistencyDefault () const

void	setICConsistencyCheck (bool c)

bool	getICConsistencyCheck () const

virtual bool	getICConsistencyCheckDefault () const

virtual OrderODE	getOrderODE () const =0

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperX (Teuchos::RCP< SolutionState< Scalar > > state)
	Get x from SolutionState or Stepper storage. More...

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperXDot (Teuchos::RCP< SolutionState< Scalar > > state)
	Get xDot from SolutionState or Stepper storage. More...

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperXDotDot (Teuchos::RCP< SolutionState< Scalar > > state)
	Get xDotDot from SolutionState or Stepper storage. More...

virtual std::string	description () const

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

virtual void	createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >)

Protected Attributes
Teuchos::RCP< RKButcherTableau < Scalar > >	tableau_

int	stageNumber_
	The current Runge-Kutta stage number, {0,...,s-1}. -1 indicates outside stage loop. More...

Teuchos::RCP < Thyra::VectorBase< Scalar > >	stageX_

Teuchos::RCP < StepperRKAppAction< Scalar > >	stepperRKAppAction_

Protected Attributes inherited from Tempus::Stepper< Scalar >
bool	isInitialized_ = false
	True if stepper's member data is initialized. More...

Additional Inherited Members
Protected Member Functions inherited from Tempus::Stepper< Scalar >
virtual void	setStepperX (Teuchos::RCP< Thyra::VectorBase< Scalar > > x)
	Set x for Stepper storage. More...

virtual void	setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot)
	Set xDot for Stepper storage. More...

virtual void	setStepperXDotDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot)
	Set x for Stepper storage. More...

Detailed Description

template<class Scalar>
class Tempus::StepperRKBase< Scalar >

Base class for Runge-Kutta methods, ExplicitRK, DIRK and IMEX.

Only common RK methods should be implemented in StepperRKBase. All other Stepper methods should be implemented through Stepper, StepperExplicit or StepperImplicit.

Definition at line 19 of file Tempus_StepperRKAppAction.hpp.

Member Function Documentation

template<class Scalar >

virtual Teuchos::RCP<StepperRKAppAction<Scalar> > Tempus::StepperRKBase< Scalar >::getAppAction ( ) const

inlinevirtual

Definition at line 60 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual int Tempus::StepperRKBase< Scalar >::getNumberOfStages ( ) const

inlinevirtual

Definition at line 40 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperRKBase< Scalar >::getOrder ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperIMEX_RK_Partition< Scalar >, and Tempus::StepperIMEX_RK< Scalar >.

Definition at line 37 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperRKBase< Scalar >::getOrderMax ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperIMEX_RK_Partition< Scalar >, and Tempus::StepperIMEX_RK< Scalar >.

Definition at line 39 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperRKBase< Scalar >::getOrderMin ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperIMEX_RK_Partition< Scalar >, and Tempus::StepperIMEX_RK< Scalar >.

Definition at line 38 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual int Tempus::StepperRKBase< Scalar >::getStageNumber ( ) const

inlinevirtual

Definition at line 42 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::StepperRKBase< Scalar >::getStageX ( )

inlinevirtual

Reimplemented in Tempus::StepperIMEX_RK_Partition< Scalar >.

Definition at line 45 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > Tempus::StepperRKBase< Scalar >::getStageX ( ) const

inlinevirtual

Definition at line 46 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual Teuchos::RCP<const RKButcherTableau<Scalar> > Tempus::StepperRKBase< Scalar >::getTableau ( ) const

inlinevirtual

Reimplemented in Tempus::StepperIMEX_RK_Partition< Scalar >, and Tempus::StepperIMEX_RK< Scalar >.

Definition at line 34 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual void Tempus::StepperRKBase< Scalar >::setAppAction ( Teuchos::RCP< StepperRKAppAction< Scalar > > appAction )

inlinevirtual

Definition at line 48 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual void Tempus::StepperRKBase< Scalar >::setStageNumber ( int s )

inlinevirtual

Definition at line 43 of file Tempus_StepperRKBase.hpp.

Member Data Documentation

template<class Scalar >

int Tempus::StepperRKBase< Scalar >::stageNumber_

protected

The current Runge-Kutta stage number, {0,...,s-1}. -1 indicates outside stage loop.

Definition at line 68 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::StepperRKBase< Scalar >::stageX_

protected

Definition at line 69 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

Teuchos::RCP<StepperRKAppAction<Scalar> > Tempus::StepperRKBase< Scalar >::stepperRKAppAction_

protected

Definition at line 70 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

Teuchos::RCP<RKButcherTableau<Scalar> > Tempus::StepperRKBase< Scalar >::tableau_

protected

Definition at line 65 of file Tempus_StepperRKBase.hpp.

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

http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_StepperRKAppAction.hpp
http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_StepperRKBase.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Scalar> class Tempus::StepperRKBase< Scalar >

Member Function Documentation

Member Data Documentation

template<class Scalar>
class Tempus::StepperRKBase< Scalar >