Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tempus::StepperERK_BogackiShampine32< Scalar > Class Template Reference

Explicit RK Bogacki-Shampine Butcher Tableau. More...

#include <Tempus_StepperRKButcherTableau.hpp>

Inheritance diagram for Tempus::StepperERK_BogackiShampine32< Scalar >:
Tempus::StepperExplicitRK< Scalar > Tempus::StepperExplicit< Scalar > Tempus::Stepper< Scalar >

Public Member Functions

 StepperERK_BogackiShampine32 ()
 
 StepperERK_BogackiShampine32 (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< StepperRKObserverComposite< Scalar > > &obs, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool useEmbedded)
 
std::string getDescription () const
 
- Public Member Functions inherited from Tempus::StepperExplicitRK< Scalar >
Teuchos::RCP< const
Teuchos::ParameterList > 
getValidParameters () const
 
virtual void setObserver (Teuchos::RCP< StepperObserver< Scalar > > obs=Teuchos::null)
 Set Observer. More...
 
virtual Teuchos::RCP< const
RKButcherTableau< Scalar > > 
getTableau ()
 
virtual Teuchos::RCP
< StepperObserver< Scalar > > 
getObserver () const
 Get Observer. More...
 
virtual void initialize ()
 Initialize during construction and after changing input parameters. More...
 
virtual void setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
 Set the initial conditions and make them consistent. More...
 
virtual void takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
 Take the specified timestep, dt, and return true if successful. More...
 
virtual Teuchos::RCP
< Tempus::StepperState< Scalar > > 
getDefaultStepperState ()
 Get a default (initial) StepperState. More...
 
virtual Scalar getOrder () const
 
virtual Scalar getOrderMin () const
 
virtual Scalar getOrderMax () const
 
virtual Scalar getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const
 
virtual Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
getStageX ()
 
virtual bool isExplicit () const
 
virtual bool isImplicit () const
 
virtual bool isExplicitImplicit () const
 
virtual bool isOneStepMethod () const
 
virtual bool isMultiStepMethod () const
 
virtual OrderODE getOrderODE () const
 
void getValidParametersBasicERK (Teuchos::RCP< Teuchos::ParameterList > pl) const
 
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 
virtual void setUseEmbedded (bool a)
 Use embedded if avialable. More...
 
virtual bool getUseEmbedded () const
 
virtual bool getUseEmbeddedDefault () const
 
- Public Member Functions inherited from Tempus::StepperExplicit< Scalar >
virtual void setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
 
virtual void setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &appModel)
 
virtual Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
getModel ()
 
virtual void setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver=Teuchos::null)
 Set solver. More...
 
virtual Teuchos::RCP
< Thyra::NonlinearSolverBase
< Scalar > > 
getSolver () const
 Get solver. More...
 
virtual void setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >)
 Pass initial guess to Newton solver (only relevant for implicit solvers) More...
 
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...
 
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 void evaluateExplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, const Scalar time, const Teuchos::RCP< ExplicitODEParameters< Scalar > > &p)
 Evaluate xDot = f(x,t). More...
 
virtual void evaluateExplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xDot, const Scalar time, const Teuchos::RCP< ExplicitODEParameters< Scalar > > &p)
 Evaluate xDotDot = f(x, xDot, t). More...
 
- Public Member Functions inherited from Tempus::Stepper< Scalar >
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 std::string description () const
 
virtual void createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >)
 

Protected Member Functions

void setupTableau ()
 
- Protected Member Functions inherited from Tempus::StepperExplicitRK< Scalar >
virtual void setupDefault ()
 Default setup for constructor. More...
 
virtual void setup (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< StepperRKObserverComposite< Scalar > > &obs, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool useEmbedded)
 Setup for constructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from Tempus::StepperExplicitRK< Scalar >
Teuchos::RCP< RKButcherTableau
< Scalar > > 
tableau_
 
std::vector< Teuchos::RCP
< Thyra::VectorBase< Scalar > > > 
stageXDot_
 
Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
stageX_
 
Teuchos::RCP
< StepperRKObserverComposite
< Scalar > > 
stepperObserver_
 
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
 
- Protected Attributes inherited from Tempus::StepperExplicit< Scalar >
Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
appModel_
 Explicit ODE ModelEvaluator. More...
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
inArgs_
 
Thyra::ModelEvaluatorBase::OutArgs
< Scalar > 
outArgs_
 
Teuchos::RCP< StepperObserver
< Scalar > > 
stepperObserver_
 
Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
stepperX_
 
Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
stepperXDot_
 
Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
stepperXDotDot_
 

Detailed Description

template<class Scalar>
class Tempus::StepperERK_BogackiShampine32< Scalar >

Explicit RK Bogacki-Shampine Butcher Tableau.

The tableau (order=3(2)) is

\[ \begin{array}{c|c} c & A \\ \hline & b^T \\ & b^{*T} \end{array} \;\;\;\;\mbox{ where }\;\;\;\; \begin{array}{c|cccc} 0 & 0 & & & \\ 1/2 & 1/2 & 0 & & \\ 3/4 & 0 & 3/4 & 0 & \\ 1 & 2/9 & 1/3 & 4/9 & 0 \\ \hline & 2/9 & 1/3 & 4/9 & 0 \\ & 7/24 & 1/4 & 1/3 & 1/8 \end{array} \]

Reference: P. Bogacki and L.F. Shampine. A 3(2) pair of Runge–Kutta formulas. Applied Mathematics Letters, 2(4):321 – 325, 1989.

Definition at line 212 of file Tempus_StepperRKButcherTableau.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Tempus::StepperERK_BogackiShampine32< Scalar >::StepperERK_BogackiShampine32 ( )
inline

Definition at line 216 of file Tempus_StepperRKButcherTableau.hpp.

template<class Scalar >
Tempus::StepperERK_BogackiShampine32< Scalar >::StepperERK_BogackiShampine32 ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  appModel,
const Teuchos::RCP< StepperRKObserverComposite< Scalar > > &  obs,
bool  useFSAL,
std::string  ICConsistency,
bool  ICConsistencyCheck,
bool  useEmbedded 
)
inline

Definition at line 223 of file Tempus_StepperRKButcherTableau.hpp.

Member Function Documentation

template<class Scalar >
std::string Tempus::StepperERK_BogackiShampine32< Scalar >::getDescription ( ) const
inlinevirtual
template<class Scalar >
void Tempus::StepperERK_BogackiShampine32< Scalar >::setupTableau ( )
inlineprotectedvirtual

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