Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Tempus::StepperERK_General< Scalar > Class Template Reference

General Explicit Runge-Kutta Butcher Tableau. More...

#include <Tempus_StepperRKButcherTableau.hpp>

Inheritance diagram for Tempus::StepperERK_General< Scalar >:
Tempus::StepperExplicitRK< Scalar > Tempus::StepperExplicit< Scalar > Tempus::StepperRKBase< Scalar > Tempus::Stepper< Scalar > Tempus::Stepper< Scalar >

Public Member Functions

 StepperERK_General ()
 
 StepperERK_General (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool useEmbedded, const Teuchos::SerialDenseMatrix< int, Scalar > &A, const Teuchos::SerialDenseVector< int, Scalar > &b, const Teuchos::SerialDenseVector< int, Scalar > &c, const int order, const int orderMin, const int orderMax, const Teuchos::SerialDenseVector< int, Scalar > &bstar, const Teuchos::RCP< StepperRKAppAction< Scalar > > &stepperRKAppAction=Teuchos::null)
 
virtual std::string getDescription () const
 
void setupTableau ()
 
void setTableau (const Teuchos::SerialDenseMatrix< int, Scalar > &A, const Teuchos::SerialDenseVector< int, Scalar > &b, const Teuchos::SerialDenseVector< int, Scalar > &c, const int order, const int orderMin, const int orderMax, const Teuchos::SerialDenseVector< int, Scalar > &bstar=Teuchos::SerialDenseVector< int, Scalar >())
 
virtual std::string getDefaultICConsistency () const
 
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const
 
- Public Member Functions inherited from Tempus::StepperExplicitRK< Scalar >
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 
virtual bool isValidSetup (Teuchos::FancyOStream &out) const
 
virtual void initialize ()
 Initialize during construction and after changing input parameters.
 
virtual void setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
 Set model.
 
virtual void setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
 Set the initial conditions and make them consistent.
 
virtual void takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
 Take the specified timestep, dt, and return true if successful.
 
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState ()
 Get a default (initial) StepperState.
 
virtual Scalar getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const
 
virtual bool isExplicit () const
 
virtual bool isImplicit () const
 
virtual bool isExplicitImplicit () const
 
virtual bool isOneStepMethod () const
 
virtual bool isMultiStepMethod () const
 
virtual OrderODE getOrderODE () const
 
Teuchos::RCP< Teuchos::ParameterList > getValidParametersBasicERK () const
 
- Public Member Functions inherited from Tempus::StepperExplicit< Scalar >
void setStepperExplicitValues (Teuchos::RCP< Teuchos::ParameterList > pl)
 Set StepperExplicit member data from the ParameterList.
 
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel () const
 Return the application ModelEvaluator.
 
virtual void setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver)
 Set solver.
 
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > getSolver () const
 Get solver.
 
virtual void setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >)
 Pass initial guess to Newton solver (only relevant for implicit solvers)
 
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).
 
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).
 
- Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual std::string description () const
 
void setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl)
 Set Stepper member data from ParameterList.
 
Teuchos::RCP< Teuchos::ParameterList > getValidParametersBasic () const
 Add basic parameters to Steppers ParameterList.
 
virtual bool isInitialized ()
 True if stepper's member data is initialized.
 
virtual void checkInitialized ()
 Check initialization, and error out on failure.
 
void setStepperName (std::string s)
 Set the stepper name.
 
std::string getStepperName () const
 Get the stepper name.
 
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.
 
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.
 
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > getStepperXDot ()
 Get Stepper xDot.
 
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > getStepperXDotDot ()
 Get Stepper xDotDot.
 
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > getStepperXDotDot (Teuchos::RCP< SolutionState< Scalar > > state)
 Get xDotDot from SolutionState or Stepper storage.
 
- 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.
 
virtual Teuchos::RCP< RKButcherTableau< Scalar > > createTableau (Teuchos::RCP< Teuchos::ParameterList > pl)
 

Additional Inherited Members

- Protected Member Functions inherited from Tempus::StepperExplicitRK< Scalar >
virtual void setupDefault ()
 Default setup for constructor.
 
virtual void setup (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool useEmbedded, const Teuchos::RCP< StepperRKAppAction< Scalar > > &stepperRKAppAction)
 Setup for constructor.
 
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.
 
virtual void setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot)
 Set xDot for Stepper storage.
 
virtual void setStepperXDotDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot)
 Set x for Stepper storage.
 
void setStepperType (std::string s)
 Set the stepper type.
 
virtual void setEmbeddedMemory ()
 
- Protected Attributes inherited from Tempus::StepperExplicitRK< Scalar >
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > stageXDot_
 
- Protected Attributes inherited from Tempus::StepperExplicit< Scalar >
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > appModel_
 Explicit ODE ModelEvaluator.
 
Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs_
 
Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs_
 
- Protected Attributes inherited from Tempus::Stepper< Scalar >
bool useFSAL_ = false
 Use First-Same-As-Last (FSAL) principle.
 
bool isInitialized_ = false
 True if stepper's member data is initialized.
 
- 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.
 
Teuchos::RCP< StepperRKAppAction< Scalar > > stepperRKAppAction_
 

Detailed Description

template<class Scalar>
class Tempus::StepperERK_General< Scalar >

General Explicit Runge-Kutta Butcher Tableau.

The format of the Butcher Tableau parameter list is

  <Parameter name="A" type="string" value="# # # ;
                                           # # # ;
                                           # # #">
  <Parameter name="b" type="string" value="# # #">
  <Parameter name="c" type="string" value="# # #">

Note the number of stages is implicit in the number of entries. The number of stages must be consistent.

Default tableau is RK4 (order=4):

\[
\begin{array}{c|c}
  c & A \\ \hline
    & b^T
\end{array}
\;\;\;\;\mbox{ where }\;\;\;\;
\begin{array}{c|cccc}  0  &  0  &     &     &    \\
                      1/2 & 1/2 &  0  &     &    \\
                      1/2 &  0  & 1/2 &  0  &    \\
                       1  &  0  &  0  &  1  &  0 \\ \hline
                          & 1/6 & 1/3 & 1/3 & 1/6 \end{array}
\]

See StepperExplicitRK for additional details.

Definition at line 1970 of file Tempus_StepperRKButcherTableau.hpp.

Constructor & Destructor Documentation

◆ StepperERK_General() [1/2]

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

Definition at line 1974 of file Tempus_StepperRKButcherTableau.hpp.

◆ StepperERK_General() [2/2]

template<class Scalar >
Tempus::StepperERK_General< Scalar >::StepperERK_General ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  appModel,
bool  useFSAL,
std::string  ICConsistency,
bool  ICConsistencyCheck,
bool  useEmbedded,
const Teuchos::SerialDenseMatrix< int, Scalar > &  A,
const Teuchos::SerialDenseVector< int, Scalar > &  b,
const Teuchos::SerialDenseVector< int, Scalar > &  c,
const int  order,
const int  orderMin,
const int  orderMax,
const Teuchos::SerialDenseVector< int, Scalar > &  bstar,
const Teuchos::RCP< StepperRKAppAction< Scalar > > &  stepperRKAppAction = Teuchos::null 
)
inline

Definition at line 1985 of file Tempus_StepperRKButcherTableau.hpp.

Member Function Documentation

◆ getDescription()

template<class Scalar >
virtual std::string Tempus::StepperERK_General< Scalar >::getDescription ( ) const
inlinevirtual

◆ setupTableau()

template<class Scalar >
void Tempus::StepperERK_General< Scalar >::setupTableau ( )
inlinevirtual

◆ setTableau()

template<class Scalar >
void Tempus::StepperERK_General< Scalar >::setTableau ( const Teuchos::SerialDenseMatrix< int, Scalar > &  A,
const Teuchos::SerialDenseVector< int, Scalar > &  b,
const Teuchos::SerialDenseVector< int, Scalar > &  c,
const int  order,
const int  orderMin,
const int  orderMax,
const Teuchos::SerialDenseVector< int, Scalar > &  bstar = Teuchos::SerialDenseVector<int,Scalar>() 
)
inline

Definition at line 2049 of file Tempus_StepperRKButcherTableau.hpp.

◆ getDefaultICConsistency()

template<class Scalar >
virtual std::string Tempus::StepperERK_General< Scalar >::getDefaultICConsistency ( ) const
inlinevirtual

Definition at line 2063 of file Tempus_StepperRKButcherTableau.hpp.

◆ getValidParameters()

template<class Scalar >
Teuchos::RCP< const Teuchos::ParameterList > Tempus::StepperERK_General< Scalar >::getValidParameters ( ) const
inlinevirtual

Reimplemented from Tempus::StepperExplicitRK< Scalar >.

Definition at line 2066 of file Tempus_StepperRKButcherTableau.hpp.


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