|
Tempus
Version of the Day
Time Integration
|
|
Tempus
Version of the Day
Time Integration
|
General Explicit Runge-Kutta Butcher Tableau. More...
#include <Tempus_StepperRKButcherTableau.hpp>
Public Member Functions | |
| StepperERK_General () | |
| StepperERK_General (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< StepperRKObserverComposite< Scalar > > &obs, 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) | |
| 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 | 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 > > >) |
Additional Inherited Members | |
| 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... | |
| 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_ |
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} \]](form_222.png)
Definition at line 1231 of file Tempus_StepperRKButcherTableau.hpp.
|
inline |
Definition at line 1235 of file Tempus_StepperRKButcherTableau.hpp.
|
inline |
Definition at line 1242 of file Tempus_StepperRKButcherTableau.hpp.
|
inlinevirtual |
Definition at line 1318 of file Tempus_StepperRKButcherTableau.hpp.
|
inlinevirtual |
Implements Tempus::StepperExplicitRK< Scalar >.
Definition at line 1268 of file Tempus_StepperRKButcherTableau.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicitRK< Scalar >.
Definition at line 1321 of file Tempus_StepperRKButcherTableau.hpp.
|
inline |
Definition at line 1305 of file Tempus_StepperRKButcherTableau.hpp.
|
inlinevirtual |
Implements Tempus::StepperExplicitRK< Scalar >.
Definition at line 1291 of file Tempus_StepperRKButcherTableau.hpp.
1.8.5