Tempus
Version of the Day
Time Integration
|
Diagonally Implicit Runge-Kutta (DIRK) time stepper. More...
#include <Tempus_StepperDIRK_decl.hpp>
Public Member Functions | |
virtual Scalar | getAlpha (const Scalar dt) const |
Return alpha = d(xDot)/dx. More... | |
virtual Scalar | getBeta (const Scalar) const |
Return beta = d(x)/dx. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Basic stepper methods | |
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 | 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) |
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 bool | isExplicit () const |
virtual bool | isImplicit () const |
virtual bool | isExplicitImplicit () const |
virtual bool | isOneStepMethod () const |
virtual bool | isMultiStepMethod () const |
virtual OrderODE | getOrderODE () const |
void | getValidParametersBasicDIRK (Teuchos::RCP< Teuchos::ParameterList > pl) const |
virtual std::string | getDescription () const =0 |
Overridden from Teuchos::Describable | |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
Accessors methods | |
virtual void | setUseEmbedded (bool a) |
Use embedded if avialable. More... | |
virtual bool | getUseEmbedded () const |
virtual bool | getUseEmbeddedDefault () const |
Public Member Functions inherited from Tempus::StepperImplicit< 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 Teuchos::RCP< const WrapperModelEvaluator< Scalar > > | getWrapperModel () |
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... | |
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 > > initial_guess) |
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 |
virtual void | setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot) |
Set xDot for 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... | |
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 | |
virtual void | setupDefault () |
Default setup for constructor. More... | |
virtual void | setup (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &wrapperModel, const Teuchos::RCP< StepperRKObserver< Scalar > > &obs, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool useEmbedded, bool zeroInitialGuess) |
Setup for constructor. More... | |
virtual void | setupTableau ()=0 |
Protected Attributes | |
Teuchos::RCP< RKButcherTableau < Scalar > > | tableau_ |
std::vector< Teuchos::RCP < Thyra::VectorBase< Scalar > > > | stageXDot_ |
Teuchos::RCP < Thyra::VectorBase< Scalar > > | stageX_ |
Teuchos::RCP < Thyra::VectorBase< Scalar > > | xTilde_ |
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 |
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 > > | initial_guess_ |
bool | zeroInitialGuess_ |
Teuchos::RCP< StepperObserver < Scalar > > | stepperObserver_ |
Teuchos::RCP < Thyra::VectorBase< Scalar > > | stepperXDot_ |
Teuchos::RCP < Thyra::VectorBase< Scalar > > | stepperXDotDot_ |
Diagonally Implicit Runge-Kutta (DIRK) time stepper.
For the implicit ODE system, , the general DIRK method for -stages, can be written as
where is the explicit form of the ODE, are intermediate approximations to the solution at times, , (stage solutions) which may be correct to a lower order of accuracy than the solution, . We should note that these lower-order approximations are combined through so that error terms cancel out and produce a more accurate solution. Note for DIRK methods that for all the diagonal components is referred to as Singly Diagonal Implicit Runge-Kutta (SDIRK) methods.
Note that the stage time derivatives,
can be found via
where
Recalling that the definition for a DIRK is that for , and for at least one . Thus for stages where , we can use the explicit RK methods (see StepperExplicitRK for additional details).
Algorithm The single-timestep algorithm for DIRK is,
The First-Step-As-Last (FSAL) principle is not needed with DIRK, but maybe useful if the first stage is explicit (i.e, EDIRK). The default is to set useFSAL=false.
Definition at line 87 of file Tempus_StepperDIRK_decl.hpp.
|
virtual |
Definition at line 352 of file Tempus_StepperDIRK_impl.hpp.
|
inlinevirtual |
Return alpha = d(xDot)/dx.
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 148 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Return beta = d(x)/dx.
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 154 of file Tempus_StepperDIRK_decl.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 343 of file Tempus_StepperDIRK_impl.hpp.
|
pure virtual |
Implemented in Tempus::StepperDIRK_General< Scalar >, Tempus::StepperSDIRK_21Pair< Scalar >, Tempus::StepperSDIRK_5Stage5thOrder< Scalar >, Tempus::StepperSDIRK_3Stage4thOrder< Scalar >, Tempus::StepperSDIRK_5Stage4thOrder< Scalar >, Tempus::StepperDIRK_2Stage2ndOrderLobattoIIIB< Scalar >, Tempus::StepperDIRK_1Stage1stOrderRadauIA< Scalar >, Tempus::StepperSDIRK_ImplicitMidpoint< Scalar >, Tempus::StepperEDIRK_TrapezoidalRule< Scalar >, Tempus::StepperEDIRK_2StageTheta< Scalar >, Tempus::StepperDIRK_1StageTheta< Scalar >, Tempus::StepperEDIRK_2Stage3rdOrder< Scalar >, Tempus::StepperSDIRK_2Stage3rdOrder< Scalar >, Tempus::StepperSDIRK_2Stage2ndOrder< Scalar >, and Tempus::StepperDIRK_BackwardEuler< Scalar >.
|
inlinevirtual |
Get Observer.
Implements Tempus::Stepper< Scalar >.
Definition at line 99 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 121 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 123 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 122 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 139 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Definition at line 112 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Definition at line 96 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Definition at line 168 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Definition at line 169 of file Tempus_StepperDIRK_decl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Reimplemented in Tempus::StepperDIRK_General< Scalar >, Tempus::StepperSDIRK_21Pair< Scalar >, Tempus::StepperSDIRK_5Stage5thOrder< Scalar >, Tempus::StepperSDIRK_3Stage4thOrder< Scalar >, Tempus::StepperSDIRK_5Stage4thOrder< Scalar >, Tempus::StepperDIRK_2Stage2ndOrderLobattoIIIB< Scalar >, Tempus::StepperDIRK_1Stage1stOrderRadauIA< Scalar >, Tempus::StepperSDIRK_ImplicitMidpoint< Scalar >, Tempus::StepperEDIRK_TrapezoidalRule< Scalar >, Tempus::StepperEDIRK_2StageTheta< Scalar >, Tempus::StepperDIRK_1StageTheta< Scalar >, Tempus::StepperEDIRK_2Stage3rdOrder< Scalar >, Tempus::StepperSDIRK_2Stage3rdOrder< Scalar >, Tempus::StepperSDIRK_2Stage2ndOrder< Scalar >, and Tempus::StepperDIRK_BackwardEuler< Scalar >.
Definition at line 363 of file Tempus_StepperDIRK_impl.hpp.
void Tempus::StepperDIRK< Scalar >::getValidParametersBasicDIRK | ( | Teuchos::RCP< Teuchos::ParameterList > | pl | ) | const |
Definition at line 67 of file Tempus_StepperDIRK_impl.hpp.
|
virtual |
Initialize during construction and after changing input parameters.
Implements Tempus::Stepper< Scalar >.
Definition at line 116 of file Tempus_StepperDIRK_impl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 125 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 134 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 133 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 137 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 136 of file Tempus_StepperDIRK_decl.hpp.
|
virtual |
Set the initial conditions and make them consistent.
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 159 of file Tempus_StepperDIRK_impl.hpp.
|
virtual |
Set Observer.
Implements Tempus::Stepper< Scalar >.
Definition at line 86 of file Tempus_StepperDIRK_impl.hpp.
|
inlinevirtual |
Set parameter so that the initial guess is reset at the beginning of each timestep.
Definition at line 110 of file Tempus_StepperDIRK_decl.hpp.
|
protectedvirtual |
Setup for constructor.
Definition at line 39 of file Tempus_StepperDIRK_impl.hpp.
|
protectedvirtual |
Default setup for constructor.
Definition at line 26 of file Tempus_StepperDIRK_impl.hpp.
|
protectedpure virtual |
Implemented in Tempus::StepperDIRK_General< Scalar >, Tempus::StepperSDIRK_21Pair< Scalar >, Tempus::StepperSDIRK_5Stage5thOrder< Scalar >, Tempus::StepperSDIRK_3Stage4thOrder< Scalar >, Tempus::StepperSDIRK_5Stage4thOrder< Scalar >, Tempus::StepperDIRK_2Stage2ndOrderLobattoIIIB< Scalar >, Tempus::StepperDIRK_1Stage1stOrderRadauIA< Scalar >, Tempus::StepperSDIRK_ImplicitMidpoint< Scalar >, Tempus::StepperEDIRK_TrapezoidalRule< Scalar >, Tempus::StepperEDIRK_2StageTheta< Scalar >, Tempus::StepperDIRK_1StageTheta< Scalar >, Tempus::StepperEDIRK_2Stage3rdOrder< Scalar >, Tempus::StepperSDIRK_2Stage3rdOrder< Scalar >, Tempus::StepperSDIRK_2Stage2ndOrder< Scalar >, and Tempus::StepperDIRK_BackwardEuler< Scalar >.
|
inlinevirtual |
Use embedded if avialable.
Definition at line 167 of file Tempus_StepperDIRK_decl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 175 of file Tempus_StepperDIRK_impl.hpp.
|
protected |
Definition at line 203 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 202 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 201 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 206 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 204 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 194 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 193 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 197 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 191 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 200 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 195 of file Tempus_StepperDIRK_decl.hpp.