Tempus
Version of the Day
Time Integration
|
Backward Euler time stepper. More...
#include <Tempus_StepperBackwardEuler_decl.hpp>
Public Member Functions | |
StepperBackwardEuler () | |
Default constructor. More... | |
StepperBackwardEuler (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< StepperObserver< Scalar > > &obs, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, const Teuchos::RCP< Stepper< Scalar > > &predictorStepper, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool zeroInitialGuess) | |
Constructor. More... | |
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. More... | |
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... | |
virtual void | computePredictor (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Compute predictor given the supplied stepper. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
virtual bool | isValidSetup (Teuchos::FancyOStream &out) const |
Basic stepper methods | |
virtual void | setObserver (Teuchos::RCP< StepperObserver< Scalar > > obs=Teuchos::null) |
Set Observer. More... | |
virtual Teuchos::RCP < StepperObserver< Scalar > > | getObserver () const |
Get Observer. More... | |
virtual void | setAppAction (Teuchos::RCP< StepperBackwardEulerAppAction< Scalar > > appAction) |
virtual Teuchos::RCP < StepperBackwardEulerAppAction < Scalar > > | getAppAction () const |
void | setPredictor (std::string predictorType="None") |
Set the predictor. More... | |
void | setPredictor (Teuchos::RCP< Stepper< Scalar > > predictorStepper) |
Set the predictor. 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 bool | isExplicit () const |
virtual bool | isImplicit () const |
virtual bool | isExplicitImplicit () const |
virtual bool | isOneStepMethod () const |
virtual bool | isMultiStepMethod () const |
virtual OrderODE | getOrderODE () const |
Overridden from Teuchos::Describable | |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
Implementation of StepperOptimizationInterface | |
virtual int | stencilLength () const |
Return the number of solution vectors in the time step stencil. More... | |
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 |
Compute time step residual. More... | |
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 |
Compute time step Jacobian. More... | |
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 |
Compute time step derivative w.r.t. model parameters. More... | |
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 |
Compute time step Jacobian solver. More... | |
Public Member Functions inherited from Tempus::StepperImplicit< Scalar > | |
virtual void | setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel) |
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getModel () |
virtual Teuchos::RCP< const WrapperModelEvaluator< Scalar > > | getWrapperModel () |
virtual void | setDefaultSolver () |
virtual void | setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver) |
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 > > initialGuess) |
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 |
Public Member Functions inherited from Tempus::Stepper< Scalar > | |
virtual void | setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &) |
virtual void | initialize () |
Initialize after construction and changing input parameters. 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 | 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 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 std::string | description () const |
virtual void | createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >) |
Public Member Functions inherited from Tempus::StepperOptimizationInterface< Scalar > | |
StepperOptimizationInterface () | |
virtual | ~StepperOptimizationInterface () |
Private Member Functions | |
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. More... | |
Private Attributes | |
Teuchos::RCP< Stepper< Scalar > > | predictorStepper_ |
Teuchos::RCP < StepperBackwardEulerObserver < Scalar > > | stepperBEObserver_ |
Teuchos::RCP < StepperBackwardEulerAppAction < Scalar > > | stepperBEAppAction_ |
Additional Inherited Members | |
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... | |
Protected Attributes inherited from Tempus::StepperImplicit< Scalar > | |
Teuchos::RCP < WrapperModelEvaluator < Scalar > > | wrapperModel_ |
Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > > | solver_ |
Teuchos::RCP< const Thyra::VectorBase< Scalar > > | initialGuess_ |
bool | zeroInitialGuess_ |
Teuchos::RCP< StepperObserver < Scalar > > | stepperObserver_ |
Protected Attributes inherited from Tempus::Stepper< Scalar > | |
bool | isInitialized_ = false |
True if stepper's member data is initialized. More... | |
Backward Euler time stepper.
For the implicit ODE system, , the solution, and , is determined using a solver (e.g., a non-linear solver, like NOX).
Algorithm The single-timestep algorithm for Backward Euler is
The First-Step-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, . Recalling that the definition of the iteration matrix, , is
where and , and the time derivative for Backward Euler is
we can determine that and , and therefore write
Definition at line 72 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 27 of file Tempus_StepperBackwardEuler_impl.hpp.
Tempus::StepperBackwardEuler< Scalar >::StepperBackwardEuler | ( | const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | appModel, |
const Teuchos::RCP< StepperObserver< Scalar > > & | obs, | ||
const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > & | solver, | ||
const Teuchos::RCP< Stepper< Scalar > > & | predictorStepper, | ||
bool | useFSAL, | ||
std::string | ICConsistency, | ||
bool | ICConsistencyCheck, | ||
bool | zeroInitialGuess | ||
) |
Constructor.
Definition at line 46 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 77 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Compute predictor given the supplied stepper.
Definition at line 300 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
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 433 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Compute time step derivative w.r.t. model parameters.
Implements Tempus::StepperOptimizationInterface< Scalar >.
Definition at line 450 of file Tempus_StepperBackwardEuler_impl.hpp.
|
private |
Implementation of computeStep*() methods.
Definition at line 483 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Compute time step residual.
Implements Tempus::StepperOptimizationInterface< Scalar >.
Definition at line 418 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Compute time step Jacobian solver.
Derivative is always w.r.t. the most current solution vector
Implements Tempus::StepperOptimizationInterface< Scalar >.
Definition at line 467 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 335 of file Tempus_StepperBackwardEuler_impl.hpp.
|
inlinevirtual |
Return alpha = d(xDot)/dx.
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 154 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Definition at line 122 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Return beta = d(x)/dx.
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 156 of file Tempus_StepperBackwardEuler_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 326 of file Tempus_StepperBackwardEuler_impl.hpp.
|
inlinevirtual |
Get Observer.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 115 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 139 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 141 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 140 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 150 of file Tempus_StepperBackwardEuler_decl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 394 of file Tempus_StepperBackwardEuler_impl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 143 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 145 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 144 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 148 of file Tempus_StepperBackwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 147 of file Tempus_StepperBackwardEuler_decl.hpp.
|
virtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 363 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Definition at line 178 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Set the initial conditions and make them consistent.
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 193 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Set Observer.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 154 of file Tempus_StepperBackwardEuler_impl.hpp.
void Tempus::StepperBackwardEuler< Scalar >::setPredictor | ( | std::string | predictorType = "None" | ) |
Set the predictor.
Set the predictor to a Stepper with default settings.
Definition at line 109 of file Tempus_StepperBackwardEuler_impl.hpp.
void Tempus::StepperBackwardEuler< Scalar >::setPredictor | ( | Teuchos::RCP< Stepper< Scalar > > | predictorStepper | ) |
Set the predictor.
Definition at line 132 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Return the number of solution vectors in the time step stencil.
Implements Tempus::StepperOptimizationInterface< Scalar >.
Definition at line 410 of file Tempus_StepperBackwardEuler_impl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 218 of file Tempus_StepperBackwardEuler_impl.hpp.
|
private |
Definition at line 215 of file Tempus_StepperBackwardEuler_decl.hpp.
|
private |
Definition at line 219 of file Tempus_StepperBackwardEuler_decl.hpp.
|
private |
Definition at line 217 of file Tempus_StepperBackwardEuler_decl.hpp.