Tempus
Version of the Day
Time Integration
|
Diagonally Implicit Runge-Kutta (DIRK) time stepper. More...
#include <Tempus_StepperDIRK_decl.hpp>
Public Member Functions | |
std::vector< Teuchos::RCP < Thyra::VectorBase< Scalar > > > & | getStageXDot () |
Teuchos::RCP < Thyra::VectorBase< Scalar > > & | getXTilde () |
virtual Scalar | getAlpha (const Scalar dt) const override |
Return alpha = d(xDot)/dx. More... | |
virtual Scalar | getBeta (const Scalar) const override |
Return beta = d(x)/dx. More... | |
virtual Scalar | getAlpha (const Scalar dt, int i) const |
Return alpha = d(xDot)/dx for stage i. More... | |
virtual Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const override |
Teuchos::RCP < Teuchos::ParameterList > | getValidParametersBasicDIRK () const |
virtual bool | isValidSetup (Teuchos::FancyOStream &out) const override |
virtual void | setStepperDIRKValues (Teuchos::RCP< Teuchos::ParameterList > pl) |
Set StepperDIRK member data from the ParameterList. More... | |
Public Member Functions inherited from Tempus::StepperImplicit< Scalar > | |
Teuchos::RCP < Teuchos::ParameterList > | getValidParametersBasicImplicit () const |
void | setStepperImplicitValues (Teuchos::RCP< Teuchos::ParameterList > pl) |
Set StepperImplicit member data from the ParameterList. More... | |
void | setStepperSolverValues (Teuchos::RCP< Teuchos::ParameterList > pl) |
Set solver from ParameterList. More... | |
void | setSolverName (std::string i) |
Set the Solver Name. More... | |
std::string | getSolverName () const |
Get the Solver Name. More... | |
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getModel () const override |
virtual Teuchos::RCP< const WrapperModelEvaluator< Scalar > > | getWrapperModel () |
virtual void | setDefaultSolver () |
virtual void | setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver) override |
Set solver. More... | |
virtual Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > > | getSolver () const override |
Get solver. 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, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &y=Teuchos::null, const int index=-1) |
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 > > initialGuess) override |
Pass initial guess to Newton solver (only relevant for implicit solvers) More... | |
virtual void | setZeroInitialGuess (bool zIG) |
virtual bool | getZeroInitialGuess () const |
virtual Scalar | getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const override |
Public Member Functions inherited from Tempus::Stepper< Scalar > | |
void | setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl) |
Set Stepper member data from ParameterList. More... | |
Teuchos::RCP < Teuchos::ParameterList > | getValidParametersBasic () const |
Add basic parameters to Steppers ParameterList. More... | |
virtual bool | isInitialized () |
True if stepper's member data is initialized. More... | |
virtual void | checkInitialized () |
Check initialization, and error out on failure. More... | |
void | setStepperName (std::string s) |
Set the stepper name. More... | |
std::string | getStepperName () const |
Get the stepper name. More... | |
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. More... | |
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. More... | |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getStepperXDot () |
Get Stepper xDot. More... | |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getStepperXDotDot () |
Get Stepper xDotDot. More... | |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getStepperXDotDot (Teuchos::RCP< SolutionState< Scalar > > state) |
Get xDotDot from SolutionState or Stepper storage. More... | |
virtual std::string | description () const |
Public Member Functions inherited from Teuchos::Describable | |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
virtual | ~Describable () |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Public Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > > | |
VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) | |
virtual const VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
virtual const VerboseObject & | setOverridingVerbLevel (const EVerbosityLevel verbLevel) const |
virtual EVerbosityLevel | getVerbLevel () const |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList > | getValidVerboseObjectSublist () |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | setupVerboseObjectSublist (ParameterList *paramList) |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel) |
void | readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject) |
Public Member Functions inherited from Teuchos::VerboseObjectBase | |
virtual | ~VerboseObjectBase () |
VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) | |
virtual const VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
virtual RCP< FancyOStream > | getOStream () const |
virtual RCP< FancyOStream > | getOverridingOStream () const |
virtual std::string | getLinePrefix () const |
virtual OSTab | getOSTab (const int tabs=1, const std::string &linePrefix="") const |
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. More... | |
virtual Teuchos::RCP < RKButcherTableau< Scalar > > | createTableau (Teuchos::RCP< Teuchos::ParameterList > pl) |
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< Thyra::NonlinearSolverBase< Scalar > > &solver, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool useEmbedded, bool zeroInitialGuess, const Teuchos::RCP< StepperRKAppAction< Scalar > > &stepperRKAppAction) |
Setup for constructor. More... | |
virtual void | setupTableau ()=0 |
virtual void | setEmbeddedMemory () override |
Protected Member Functions inherited from Tempus::Stepper< Scalar > | |
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... | |
void | setStepperType (std::string s) |
Set the stepper type. More... | |
Protected Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > > | |
void | initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) |
Protected Member Functions inherited from Teuchos::VerboseObjectBase | |
void | initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) |
virtual void | informUpdatedVerbosityState () const |
Basic stepper methods | |
virtual void | initialize () override |
Initialize after construction and changing input parameters. More... | |
virtual void | setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel) override |
Set the model. More... | |
virtual void | setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) override |
Set the initial conditions and make them consistent. More... | |
virtual void | setResetInitialGuess (bool reset_guess) |
virtual bool | getResetInitialGuess () const |
virtual void | takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) override |
Take the specified timestep, dt, and return true if successful. More... | |
virtual Teuchos::RCP < Tempus::StepperState< Scalar > > | getDefaultStepperState () override |
Get a default (initial) StepperState. More... | |
virtual bool | isExplicit () const override |
virtual bool | isImplicit () const override |
virtual bool | isExplicitImplicit () const override |
virtual bool | isOneStepMethod () const override |
virtual bool | isMultiStepMethod () const override |
virtual OrderODE | getOrderODE () const override |
virtual std::string | getDescription () const =0 |
Overridden from Teuchos::Describable | |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override |
Additional Inherited Members | |
Static Public Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > > | |
static void | setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel) |
static EVerbosityLevel | getDefaultVerbLevel () |
Static Public Member Functions inherited from Teuchos::VerboseObjectBase | |
static void | setDefaultOStream (const RCP< FancyOStream > &defaultOStream) |
static RCP< FancyOStream > | getDefaultOStream () |
Static Public Attributes inherited from Teuchos::Describable | |
static const EVerbosityLevel | verbLevel_default |
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-Same-As-Last (FSAL) principle is not needed with DIRK, but maybe useful if the first stage is explicit (EDIRK) (e.g., Trapezoidal Method). The default is to set useFSAL=false.
Iteration Matrix, . Recalling that the definition of the iteration matrix, , is
where and . For the stage solutions, we have
where , , and . The time derivative for the DIRK stages is
and we can determine that and , and therefore write
Definition at line 144 of file Tempus_StepperDIRK_decl.hpp.
|
overridevirtual |
Initialize after construction and changing input parameters.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 72 of file Tempus_StepperDIRK_impl.hpp.
|
overridevirtual |
Set the model.
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 87 of file Tempus_StepperDIRK_impl.hpp.
|
overridevirtual |
Set the initial conditions and make them consistent.
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 129 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 163 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Definition at line 167 of file Tempus_StepperDIRK_decl.hpp.
|
overridevirtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 137 of file Tempus_StepperDIRK_impl.hpp.
|
overridevirtual |
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 331 of file Tempus_StepperDIRK_impl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 177 of file Tempus_StepperDIRK_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 186 of file Tempus_StepperDIRK_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 187 of file Tempus_StepperDIRK_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 191 of file Tempus_StepperDIRK_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 192 of file Tempus_StepperDIRK_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 194 of file Tempus_StepperDIRK_decl.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_SSPDIRK33< Scalar >, Tempus::StepperSDIRK_SSPDIRK23< Scalar >, Tempus::StepperSDIRK_SSPDIRK32< Scalar >, Tempus::StepperSDIRK_SSPDIRK22< 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_3Stage2ndOrder< Scalar >, Tempus::StepperSDIRK_2Stage2ndOrder< Scalar >, and Tempus::StepperDIRK_BackwardEuler< Scalar >.
|
inline |
Definition at line 199 of file Tempus_StepperDIRK_decl.hpp.
|
inline |
Definition at line 203 of file Tempus_StepperDIRK_decl.hpp.
|
inlineoverridevirtual |
Return alpha = d(xDot)/dx.
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 206 of file Tempus_StepperDIRK_decl.hpp.
|
inlineoverridevirtual |
Return beta = d(x)/dx.
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 221 of file Tempus_StepperDIRK_decl.hpp.
|
inlinevirtual |
Return alpha = d(xDot)/dx for stage i.
Definition at line 224 of file Tempus_StepperDIRK_decl.hpp.
|
overridevirtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Reimplemented in Tempus::StepperDIRK_General< Scalar >, Tempus::StepperEDIRK_2StageTheta< Scalar >, Tempus::StepperDIRK_1StageTheta< Scalar >, Tempus::StepperSDIRK_2Stage3rdOrder< Scalar >, and Tempus::StepperSDIRK_2Stage2ndOrder< Scalar >.
Definition at line 389 of file Tempus_StepperDIRK_impl.hpp.
Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperDIRK< Scalar >::getValidParametersBasicDIRK | ( | ) | const |
Definition at line 57 of file Tempus_StepperDIRK_impl.hpp.
|
overridevirtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 339 of file Tempus_StepperDIRK_impl.hpp.
|
overridevirtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 366 of file Tempus_StepperDIRK_impl.hpp.
|
inlinevirtual |
Set StepperDIRK member data from the ParameterList.
Definition at line 246 of file Tempus_StepperDIRK_decl.hpp.
|
protectedvirtual |
Default setup for constructor.
Definition at line 20 of file Tempus_StepperDIRK_impl.hpp.
|
protectedvirtual |
Setup for constructor.
Definition at line 31 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_SSPDIRK33< Scalar >, Tempus::StepperSDIRK_SSPDIRK23< Scalar >, Tempus::StepperSDIRK_SSPDIRK32< Scalar >, Tempus::StepperSDIRK_SSPDIRK22< 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_3Stage2ndOrder< Scalar >, Tempus::StepperSDIRK_2Stage2ndOrder< Scalar >, and Tempus::StepperDIRK_BackwardEuler< Scalar >.
|
overrideprotectedvirtual |
Reimplemented from Tempus::StepperRKBase< Scalar >.
Definition at line 109 of file Tempus_StepperDIRK_impl.hpp.
|
protected |
Definition at line 276 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 277 of file Tempus_StepperDIRK_decl.hpp.
|
protected |
Definition at line 279 of file Tempus_StepperDIRK_decl.hpp.