Tempus Version of the Day
Time Integration
|
Backward Euler time stepper. More...
#include <Tempus_StepperBackwardEuler_decl.hpp>
Public Member Functions | |
StepperBackwardEuler () | |
Default constructor. | |
StepperBackwardEuler (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, const Teuchos::RCP< Stepper< Scalar > > &predictorStepper, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool zeroInitialGuess, const Teuchos::RCP< StepperBackwardEulerAppAction< Scalar > > &stepperBEAppAction) | |
Constructor. | |
![]() | |
Teuchos::RCP< Teuchos::ParameterList > | getValidParametersBasicImplicit () const |
void | setStepperImplicitValues (Teuchos::RCP< Teuchos::ParameterList > pl) |
Set StepperImplicit member data from the ParameterList. | |
void | setStepperSolverValues (Teuchos::RCP< Teuchos::ParameterList > pl) |
Set solver from ParameterList. | |
void | setSolverName (std::string i) |
Set the Solver Name. | |
std::string | getSolverName () const |
Get the Solver Name. | |
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. | |
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > | getSolver () const override |
Get solver. | |
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=0) |
Solve implicit ODE, f(x, xDot, t, p) = 0. | |
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). | |
virtual void | setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initialGuess) override |
Pass initial guess to Newton solver (only relevant for implicit solvers) | |
virtual void | setZeroInitialGuess (bool zIG) |
Set parameter so that the initial guess is set to zero (=True) or use last timestep (=False). | |
virtual bool | getZeroInitialGuess () const |
virtual Scalar | getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const override |
![]() | |
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 void | initialize () |
Initialize after construction and changing input parameters. | |
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. | |
![]() | |
StepperOptimizationInterface () | |
virtual | ~StepperOptimizationInterface () |
Implementation of StepperOptimizationInterface | |
Teuchos::RCP< Stepper< Scalar > > | predictorStepper_ |
Teuchos::RCP< StepperBackwardEulerAppAction< Scalar > > | stepperBEAppAction_ |
virtual int | stencilLength () const override |
Return the number of solution vectors in the time step stencil. | |
virtual void | computeStepResidual (Thyra::VectorBase< Scalar > &residual, const Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &x, const Teuchos::Array< Scalar > &t, const Thyra::VectorBase< Scalar > &p, const int param_index) const override |
Compute time step residual. | |
virtual void | computeStepJacobian (Thyra::LinearOpBase< Scalar > &jacobian, const Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &x, const Teuchos::Array< Scalar > &t, const Thyra::VectorBase< Scalar > &p, const int param_index, const int deriv_index) const override |
Compute time step Jacobian. | |
virtual void | computeStepParamDeriv (Thyra::LinearOpBase< Scalar > &deriv, const Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &x, const Teuchos::Array< Scalar > &t, const Thyra::VectorBase< Scalar > &p, const int param_index) const override |
Compute time step derivative w.r.t. model parameters. | |
virtual void | computeStepSolver (Thyra::LinearOpWithSolveBase< Scalar > &jacobian_solver, const Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &x, const Teuchos::Array< Scalar > &t, const Thyra::VectorBase< Scalar > &p, const int param_index) const override |
Compute time step Jacobian solver. | |
void | computeStepResidDerivImpl (const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs, const Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &x, const Teuchos::Array< Scalar > &t, const Thyra::VectorBase< Scalar > &p, const int param_index, const int deriv_index=0) const |
Implementation of computeStep*() methods. | |
Basic stepper methods | |
virtual void | setAppAction (Teuchos::RCP< StepperBackwardEulerAppAction< Scalar > > appAction) |
virtual Teuchos::RCP< StepperBackwardEulerAppAction< Scalar > > | getAppAction () const |
void | setPredictor (std::string predictorType="None") |
Set the predictor. | |
void | setPredictor (Teuchos::RCP< Stepper< Scalar > > predictorStepper) |
Set the predictor. | |
virtual void | setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel) override |
Set the model. | |
virtual void | setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) override |
Set the initial conditions and make them consistent. | |
virtual void | takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) override |
Take the specified timestep, dt, and return true if successful. | |
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > | getDefaultStepperState () override |
Get a default (initial) StepperState. | |
virtual Scalar | getOrder () const override |
virtual Scalar | getOrderMin () const override |
virtual Scalar | getOrderMax () const override |
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 Scalar | getAlpha (const Scalar dt) const override |
Return alpha = d(xDot)/dx. | |
virtual Scalar | getBeta (const Scalar) const override |
Return beta = d(x)/dx. | |
virtual void | computePredictor (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Compute predictor given the supplied stepper. | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const override |
Return a valid ParameterList with current settings. | |
Overridden from Teuchos::Describable | |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override |
virtual bool | isValidSetup (Teuchos::FancyOStream &out) const override |
Additional Inherited Members | |
![]() | |
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< WrapperModelEvaluator< Scalar > > | wrapperModel_ |
Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > | solver_ |
Teuchos::RCP< const Thyra::VectorBase< Scalar > > | initialGuess_ |
bool | zeroInitialGuess_ |
std::string | solverName_ |
![]() | |
bool | useFSAL_ = false |
Use First-Same-As-Last (FSAL) principle. | |
bool | isInitialized_ = false |
True if stepper's member data is initialized. | |
Backward Euler time stepper.
For the implicit ODE system,
Algorithm The single-timestep algorithm for Backward Euler is
The First-Same-As-Last (FSAL) principle is not needed with Backward Euler. The default is to set useFSAL=false, however useFSAL=true will also work but have no affect (i.e., no-op).
Iteration Matrix,
where
we can determine that
Definition at line 75 of file Tempus_StepperBackwardEuler_decl.hpp.
Tempus::StepperBackwardEuler< Scalar >::StepperBackwardEuler | ( | ) |
Default constructor.
Requires subsequent setModel(), setSolver() and initialize() calls before calling takeStep().
Definition at line 21 of file Tempus_StepperBackwardEuler_impl.hpp.
Tempus::StepperBackwardEuler< Scalar >::StepperBackwardEuler | ( | const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | appModel, |
const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > & | solver, | ||
const Teuchos::RCP< Stepper< Scalar > > & | predictorStepper, | ||
bool | useFSAL, | ||
std::string | ICConsistency, | ||
bool | ICConsistencyCheck, | ||
bool | zeroInitialGuess, | ||
const Teuchos::RCP< StepperBackwardEulerAppAction< Scalar > > & | stepperBEAppAction ) |
Constructor.
Definition at line 37 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Definition at line 109 of file Tempus_StepperBackwardEuler_impl.hpp.
|
inlinevirtual |
Definition at line 104 of file Tempus_StepperBackwardEuler_decl.hpp.
void Tempus::StepperBackwardEuler< Scalar >::setPredictor | ( | std::string | predictorType = "None" | ) |
Set the predictor.
Definition at line 66 of file Tempus_StepperBackwardEuler_impl.hpp.
void Tempus::StepperBackwardEuler< Scalar >::setPredictor | ( | Teuchos::RCP< Stepper< Scalar > > | predictorStepper | ) |
Set the predictor.
Definition at line 88 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Set the model.
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 124 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Set the initial conditions and make them consistent.
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 142 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 160 of file Tempus_StepperBackwardEuler_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 254 of file Tempus_StepperBackwardEuler_impl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 125 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 126 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 127 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 129 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 130 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 131 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 133 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 134 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 135 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Return alpha = d(xDot)/dx.
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 139 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlineoverridevirtual |
Return beta = d(x)/dx.
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 141 of file Tempus_StepperBackwardEuler_decl.hpp.
|
virtual |
Compute predictor given the supplied stepper.
Definition at line 229 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Return a valid ParameterList with current settings.
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 315 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 264 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 289 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Return the number of solution vectors in the time step stencil.
Implements Tempus::StepperOptimizationInterface< Scalar >.
Definition at line 328 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Compute time step residual.
Implements Tempus::StepperOptimizationInterface< Scalar >.
Definition at line 336 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Compute time step Jacobian.
deriv_index determines which component of x the derivative should be computed with respect to.
Implements Tempus::StepperOptimizationInterface< Scalar >.
Definition at line 351 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Compute time step derivative w.r.t. model parameters.
Implements Tempus::StepperOptimizationInterface< Scalar >.
Definition at line 368 of file Tempus_StepperBackwardEuler_impl.hpp.
|
overridevirtual |
Compute time step Jacobian solver.
Derivative is always w.r.t. the most current solution vector
Implements Tempus::StepperOptimizationInterface< Scalar >.
Definition at line 385 of file Tempus_StepperBackwardEuler_impl.hpp.
|
private |
Implementation of computeStep*() methods.
Definition at line 401 of file Tempus_StepperBackwardEuler_impl.hpp.
|
private |
Definition at line 201 of file Tempus_StepperBackwardEuler_decl.hpp.
|
private |
Definition at line 202 of file Tempus_StepperBackwardEuler_decl.hpp.