SDIRK 2 Stage 3rd order. More...

#include <Tempus_StepperRKButcherTableau.hpp>

Inheritance diagram for Tempus::StepperSDIRK_2Stage3rdOrder< Scalar >:

Public Member Functions
	StepperSDIRK_2Stage3rdOrder ()
	Default constructor. More...

	StepperSDIRK_2Stage3rdOrder (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool useEmbedded, bool zeroInitialGuess, const Teuchos::RCP< StepperRKAppAction< Scalar > > &stepperRKAppAction, std::string gammaType="3rd Order A-stable", Scalar gamma=Scalar(0.7886751345948128))

void	setGammaType (std::string gammaType)

std::string	getGammaType () const

void	setGamma (Scalar gamma)

Scalar	getGamma () const

std::string	getDescription () const

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

Public Member Functions inherited from Tempus::StepperDIRK< Scalar >
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > &	getStageXDot ()

Teuchos::RCP< Thyra::VectorBase< Scalar > > &	getXTilde ()

virtual Scalar	getAlpha (const Scalar dt) const override
	Return alpha = d(xDot)/dx. More...

virtual Scalar	getBeta (const Scalar) const override
	Return beta = d(x)/dx. More...

virtual Scalar	getAlpha (const Scalar dt, int i) const
	Return alpha = d(xDot)/dx for stage i. More...

Teuchos::RCP< Teuchos::ParameterList >	getValidParametersBasicDIRK () const

virtual bool	isValidSetup (Teuchos::FancyOStream &out) const override

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

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

virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel) override
	Set the model. More...

virtual void	setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) override
	Set the initial conditions and make them consistent. More...

virtual void	setResetInitialGuess (bool reset_guess)
	Set parameter so that the initial guess is reset at the beginning of each timestep. More...

virtual bool	getResetInitialGuess () const

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

virtual Teuchos::RCP< Tempus::StepperState< Scalar > >	getDefaultStepperState () override
	Get a default (initial) StepperState. More...

virtual bool	isExplicit () const override

virtual bool	isImplicit () const override

virtual bool	isExplicitImplicit () const override

virtual bool	isOneStepMethod () const override

virtual bool	isMultiStepMethod () const override

virtual OrderODE	getOrderODE () const override

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

Public Member Functions inherited from Tempus::StepperImplicit< Scalar >
Teuchos::RCP< Teuchos::ParameterList >	getValidParametersBasicImplicit () const

void	setStepperImplicitValues (Teuchos::RCP< Teuchos::ParameterList > pl)
	Set StepperImplicit member data from the ParameterList. More...

void	setStepperSolverValues (Teuchos::RCP< Teuchos::ParameterList > pl)
	Set solver from ParameterList. More...

void	setSolverName (std::string i)
	Set the Solver Name. More...

std::string	getSolverName () const
	Get the Solver Name. More...

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

virtual Teuchos::RCP< const WrapperModelEvaluator< Scalar > >	getWrapperModel ()

virtual void	setDefaultSolver ()

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

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

const Thyra::SolveStatus< Scalar >	solveImplicitODE (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x)
	Solve problem using x in-place. (Needs to be deprecated!) More...

const Thyra::SolveStatus< Scalar >	solveImplicitODE (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p)
	Solve implicit ODE, f(x, xDot, t, p) = 0. More...

void	evaluateImplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > &f, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p)
	Evaluate implicit ODE residual, f(x, xDot, t, p). More...

virtual void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initialGuess) override
	Pass initial guess to Newton solver (only relevant for implicit solvers) More...

virtual void	setZeroInitialGuess (bool zIG)
	Set parameter so that the initial guess is set to zero (=True) or use last timestep (=False). More...

virtual bool	getZeroInitialGuess () const

virtual Scalar	getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const override

Public Member Functions inherited from Tempus::Stepper< Scalar >
void	setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl)
	Set Stepper member data from ParameterList. More...

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

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

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

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

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

Public Member Functions inherited from Tempus::StepperRKBase< Scalar >
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)

Protected Member Functions
void	setupTableau ()

Protected Member Functions inherited from Tempus::StepperDIRK< Scalar >
virtual void	setupDefault ()
	Default setup for constructor. More...

virtual void	setup (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &wrapperModel, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool useEmbedded, bool zeroInitialGuess, const Teuchos::RCP< StepperRKAppAction< Scalar > > &stepperRKAppAction)
	Setup for constructor. More...

virtual void	setEmbeddedMemory () override

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

Private Attributes
std::string	gammaTypeDefault_

std::string	gammaType_

Scalar	gammaDefault_

Scalar	gamma_

Additional Inherited Members
Protected Attributes inherited from Tempus::StepperDIRK< Scalar >
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > >	stageXDot_

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

bool	resetGuess_ = true

Protected Attributes inherited from Tempus::StepperImplicit< Scalar >
Teuchos::RCP< WrapperModelEvaluator< Scalar > >	wrapperModel_

Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > >	solver_

Teuchos::RCP< const Thyra::VectorBase< Scalar > >	initialGuess_

bool	zeroInitialGuess_

std::string	solverName_

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

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

Protected Attributes inherited from Tempus::StepperRKBase< Scalar >
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_
	The current Runge-Kutta stage number, {0,...,s-1}. -1 indicates outside stage loop. More...

Teuchos::RCP< StepperRKAppAction< Scalar > >	stepperRKAppAction_

Detailed Description

template<class Scalar>
class Tempus::StepperSDIRK_2Stage3rdOrder< Scalar >

SDIRK 2 Stage 3rd order.

The tableau (order=2 or 3) is

$\begin{array}{c|c} c & A \\ \hline & b^T \end{array} \;\;\;\;\mbox{ where }\;\;\;\; \begin{array}{c|cc} \gamma & \gamma & \\ 1-\gamma & 1-2\gamma & \gamma \\ \hline & 1/2 & 1/2 \end{array}$

$\gamma = \left\{ \begin{array}{cc} (2\pm \sqrt{2})/2 & \mbox{then 2nd order and L-stable} \\ (3\pm \sqrt{3})/6 & \mbox{then 3rd order and A-stable} \end{array} \right.$

The default value is $\gamma = (3 + \sqrt{3})/6$ .

Reference: E. Hairer, S. P. Norsett, and G. Wanner, Solving Ordinary Differential Equations I: Nonstiff Problems, 2nd Revised Edition, Table 7.2, pg 207.

Definition at line 2584 of file Tempus_StepperRKButcherTableau.hpp.

Constructor & Destructor Documentation

◆ StepperSDIRK_2Stage3rdOrder() [1/2]

template<class Scalar >

Tempus::StepperSDIRK_2Stage3rdOrder< Scalar >::StepperSDIRK_2Stage3rdOrder ( )

inline

Default constructor.

Requires subsequent setModel() and initialize() calls before calling takestep().

Definition at line 2593 of file Tempus_StepperRKButcherTableau.hpp.

◆ StepperSDIRK_2Stage3rdOrder() [2/2]

template<class Scalar >

Tempus::StepperSDIRK_2Stage3rdOrder< Scalar >::StepperSDIRK_2Stage3rdOrder	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	appModel,
		const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &	solver,
		bool	useFSAL,
		std::string	ICConsistency,
		bool	ICConsistencyCheck,
		bool	useEmbedded,
		bool	zeroInitialGuess,
		const Teuchos::RCP< StepperRKAppAction< Scalar > > &	stepperRKAppAction,
		std::string	gammaType = `"3rd Order A-stable"`,
		Scalar	gamma = `Scalar(0.7886751345948128)`
	)