Tempus Version of the Day
Time Integration
|
Explicit Runge-Kutta time stepper. More...
#include <Tempus_StepperExplicitRK_decl.hpp>
Overridden from Teuchos::Describable | |
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > | stageXDot_ |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
virtual bool | isValidSetup (Teuchos::FancyOStream &out) const |
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 | setupTableau ()=0 |
virtual void | setEmbeddedMemory () |
Basic stepper methods | |
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 |
virtual std::string | getDescription () const =0 |
virtual Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Teuchos::RCP< Teuchos::ParameterList > | getValidParametersBasicERK () const |
Additional Inherited Members | |
![]() | |
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). | |
![]() | |
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. | |
![]() | |
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) |
![]() | |
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. | |
![]() | |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | appModel_ |
Explicit ODE ModelEvaluator. | |
Thyra::ModelEvaluatorBase::InArgs< Scalar > | inArgs_ |
Thyra::ModelEvaluatorBase::OutArgs< Scalar > | outArgs_ |
![]() | |
bool | useFSAL_ = false |
Use First-Same-As-Last (FSAL) principle. | |
bool | isInitialized_ = false |
True if stepper's member data is initialized. | |
![]() | |
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_ |
Explicit Runge-Kutta time stepper.
For the explicit ODE system,
the general explicit Runge-Kutta method for
where
and the time derivative by definition is
Algorithm The single-timestep algorithm for Explicit RK is
For Explicit RK, FSAL requires
Definition at line 100 of file Tempus_StepperExplicitRK_decl.hpp.
|
virtual |
Initialize during construction and after changing input parameters.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 151 of file Tempus_StepperExplicitRK_impl.hpp.
|
virtual |
Set model.
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 166 of file Tempus_StepperExplicitRK_impl.hpp.
|
virtual |
Set the initial conditions and make them consistent.
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 207 of file Tempus_StepperExplicitRK_impl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 224 of file Tempus_StepperExplicitRK_impl.hpp.
|
virtual |
Get a default (initial) StepperState.
Provide a StepperState to the SolutionState. This Stepper does not have any special state data, so just provide the base class StepperState with the Stepper description. This can be checked to ensure that the input StepperState can be used by this Stepper.
Implements Tempus::Stepper< Scalar >.
Definition at line 371 of file Tempus_StepperExplicitRK_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 56 of file Tempus_StepperExplicitRK_impl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 128 of file Tempus_StepperExplicitRK_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 129 of file Tempus_StepperExplicitRK_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 130 of file Tempus_StepperExplicitRK_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 132 of file Tempus_StepperExplicitRK_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 133 of file Tempus_StepperExplicitRK_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 135 of file Tempus_StepperExplicitRK_decl.hpp.
|
pure virtual |
Implemented in Tempus::StepperERK_ForwardEuler< Scalar >, Tempus::StepperERK_4Stage4thOrder< Scalar >, Tempus::StepperERK_BogackiShampine32< Scalar >, Tempus::StepperERK_Merson45< Scalar >, Tempus::StepperERK_3_8Rule< Scalar >, Tempus::StepperERK_4Stage3rdOrderRunge< Scalar >, Tempus::StepperERK_5Stage3rdOrderKandG< Scalar >, Tempus::StepperERK_3Stage3rdOrder< Scalar >, Tempus::StepperERK_3Stage3rdOrderTVD< Scalar >, Tempus::StepperERK_3Stage3rdOrderHeun< Scalar >, Tempus::StepperERK_Midpoint< Scalar >, Tempus::StepperERK_Ralston< Scalar >, Tempus::StepperERK_Trapezoidal< Scalar >, Tempus::StepperERK_SSPERK54< Scalar >, and Tempus::StepperERK_General< Scalar >.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Reimplemented in Tempus::StepperERK_General< Scalar >.
Definition at line 129 of file Tempus_StepperExplicitRK_impl.hpp.
Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperExplicitRK< Scalar >::getValidParametersBasicERK | ( | ) | const |
Definition at line 137 of file Tempus_StepperExplicitRK_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 381 of file Tempus_StepperExplicitRK_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 409 of file Tempus_StepperExplicitRK_impl.hpp.
|
protectedvirtual |
Default setup for constructor.
Definition at line 22 of file Tempus_StepperExplicitRK_impl.hpp.
|
protectedvirtual |
Setup for constructor.
Definition at line 31 of file Tempus_StepperExplicitRK_impl.hpp.
|
protectedpure virtual |
Implemented in Tempus::StepperERK_ForwardEuler< Scalar >, Tempus::StepperERK_4Stage4thOrder< Scalar >, Tempus::StepperERK_BogackiShampine32< Scalar >, Tempus::StepperERK_Merson45< Scalar >, Tempus::StepperERK_3_8Rule< Scalar >, Tempus::StepperERK_4Stage3rdOrderRunge< Scalar >, Tempus::StepperERK_5Stage3rdOrderKandG< Scalar >, Tempus::StepperERK_3Stage3rdOrder< Scalar >, Tempus::StepperERK_3Stage3rdOrderTVD< Scalar >, Tempus::StepperERK_3Stage3rdOrderHeun< Scalar >, Tempus::StepperERK_Midpoint< Scalar >, Tempus::StepperERK_Ralston< Scalar >, Tempus::StepperERK_Trapezoidal< Scalar >, Tempus::StepperERK_SSPERK54< Scalar >, and Tempus::StepperERK_General< Scalar >.
|
protectedvirtual |
Reimplemented from Tempus::StepperRKBase< Scalar >.
Definition at line 187 of file Tempus_StepperExplicitRK_impl.hpp.
|
protected |
Definition at line 172 of file Tempus_StepperExplicitRK_decl.hpp.