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 void	setUseEmbedded (bool a)

virtual bool	getUseEmbedded () const

virtual void	setErrorNorm (const Teuchos::RCP< Stepper_ErrorNorm< Scalar >> &errCalculator=Teuchos::null)

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

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

virtual void	setStepperRKValues (Teuchos::RCP< Teuchos::ParameterList > pl)
	Set StepperRK member data from the ParameterList. More...

virtual Teuchos::RCP < RKButcherTableau< Scalar > >	createTableau (Teuchos::RCP< Teuchos::ParameterList > pl)

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

void	setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl)
	Set Stepper member data from ParameterList. More...

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

Teuchos::RCP < Teuchos::ParameterList >	getValidParametersBasic () const
	Add basic parameters to Steppers ParameterList. More...

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

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

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	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	setStepperName (std::string s)
	Set the stepper name. More...

std::string	getStepperName () const
	Get the stepper name. More...

std::string	getStepperType () const
	Get the stepper type. The stepper type is used as an identifier for the stepper, and can only be set by the derived Stepper class. More...

virtual void	setUseFSAL (bool a)

void	setUseFSALTrueOnly (bool a)

void	setUseFSALFalseOnly (bool a)

bool	getUseFSAL () const

void	setICConsistency (std::string s)

std::string	getICConsistency () const

void	setICConsistencyCheck (bool c)

bool	getICConsistencyCheck () const

virtual OrderODE	getOrderODE () const =0

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperX ()
	Get Stepper x. More...

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperXDot ()
	Get Stepper xDot. More...

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperXDotDot ()
	Get Stepper xDotDot. 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

Public Member Functions inherited from Teuchos::Describable
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

Public Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< ObjectType > verboseObject)

Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual	~VerboseObjectBase ()

	VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () const

virtual std::string	getLinePrefix () const

virtual OSTab	getOSTab (const int tabs=1, const std::string &linePrefix="") const

Protected Member Functions
virtual void	setEmbeddedMemory ()

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

void	setStepperType (std::string s)
	Set the stepper type. More...

Protected Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

Protected Member Functions inherited from Teuchos::VerboseObjectBase
void	initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual void	informUpdatedVerbosityState () const

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

bool	useEmbedded_

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

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

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

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

Teuchos::RCP < Stepper_ErrorNorm< Scalar > >	stepperErrorNormCalculator_

int	stageNumber_

Teuchos::RCP < StepperRKAppAction< Scalar > >	stepperRKAppAction_

Protected Attributes inherited from Tempus::Stepper< Scalar >
bool	useFSAL_ = false
	Use First-Same-As-Last (FSAL) principle. More...

bool	isInitialized_
	True if stepper's member data is initialized. More...

Additional Inherited Members
Static Public Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

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<const RKButcherTableau<Scalar> > Tempus::StepperRKBase< Scalar >::getTableau ( ) const

inlinevirtual

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

Definition at line 32 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 >::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 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 int Tempus::StepperRKBase< Scalar >::getNumberOfStages ( ) const

inlinevirtual

Definition at line 40 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 void Tempus::StepperRKBase< Scalar >::setStageNumber ( int s )

inlinevirtual

Definition at line 43 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual void Tempus::StepperRKBase< Scalar >::setUseEmbedded ( bool a )

inlinevirtual

Definition at line 45 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual bool Tempus::StepperRKBase< Scalar >::getUseEmbedded ( ) const

inlinevirtual

Definition at line 52 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual void Tempus::StepperRKBase< Scalar >::setErrorNorm ( const Teuchos::RCP< Stepper_ErrorNorm< Scalar >> & errCalculator = Teuchos::null )

inlinevirtual

Definition at line 54 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

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

inlinevirtual

Definition at line 66 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

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

inlinevirtual

Definition at line 79 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual void Tempus::StepperRKBase< Scalar >::setStepperRKValues ( Teuchos::RCP< Teuchos::ParameterList > pl )

inlinevirtual

Set StepperRK member data from the ParameterList.

Definition at line 85 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual Teuchos::RCP<RKButcherTableau<Scalar> > Tempus::StepperRKBase< Scalar >::createTableau ( Teuchos::RCP< Teuchos::ParameterList > pl )

inlinevirtual

Definition at line 95 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

virtual void Tempus::StepperRKBase< Scalar >::setEmbeddedMemory ( )

inlineprotectedvirtual

Reimplemented in Tempus::StepperDIRK< Scalar >, and Tempus::StepperExplicitRK< Scalar >.

Definition at line 209 of file Tempus_StepperRKBase.hpp.

Member Data Documentation

template<class Scalar >

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

protected

Definition at line 211 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

bool Tempus::StepperRKBase< Scalar >::useEmbedded_

protected

Definition at line 214 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

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

protected

Definition at line 215 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

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

protected

Definition at line 216 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

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

protected

Definition at line 217 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

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

protected

Definition at line 218 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

Teuchos::RCP<Stepper_ErrorNorm<Scalar> > Tempus::StepperRKBase< Scalar >::stepperErrorNormCalculator_

protected

Definition at line 220 of file Tempus_StepperRKBase.hpp.

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 224 of file Tempus_StepperRKBase.hpp.

template<class Scalar >

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

protected

Definition at line 225 of file Tempus_StepperRKBase.hpp.

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

Public Member Functions

Protected 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 >