Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Tempus::StepperBackwardEuler< Scalar > Class Template Reference

Backward Euler time stepper. More...

#include <Tempus_StepperBackwardEuler_decl.hpp>

Inheritance diagram for Tempus::StepperBackwardEuler< Scalar >:
Tempus::StepperImplicit< Scalar > Tempus::StepperOptimizationInterface< Scalar > Tempus::Stepper< Scalar >

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.
 
- 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.
 
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
 
- Public Member Functions inherited from Tempus::Stepper< Scalar >
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.
 
- Public Member Functions inherited from Tempus::StepperOptimizationInterface< Scalar >
 StepperOptimizationInterface ()
 
virtual ~StepperOptimizationInterface ()
 
virtual int stencilLength () const =0
 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 =0
 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 =0
 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 =0
 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 =0
 Compute time step Jacobian solver.
 

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

- Protected Member Functions inherited from Tempus::Stepper< Scalar >
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.
 
- 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_
 
std::string solverName_
 
- Protected Attributes inherited from Tempus::Stepper< Scalar >
bool useFSAL_ = false
 Use First-Same-As-Last (FSAL) principle.
 
bool isInitialized_ = false
 True if stepper's member data is initialized.
 

Detailed Description

template<class Scalar>
class Tempus::StepperBackwardEuler< Scalar >

Backward Euler time stepper.

For the implicit ODE system, $\mathcal{F}(\dot{x},x,t) = 0$, the solution, $\dot{x}$ and $x$, is determined using a solver (e.g., a non-linear solver, like NOX).

Algorithm The single-timestep algorithm for Backward Euler is

\begin{center}
  \parbox{5in}{
  \rule{5in}{0.4pt} \\
  {\bf Algorithm} Backward Euler \\
  \rule{5in}{0.4pt} \vspace{-15pt}
  \begin{enumerate}
    \setlength{\itemsep}{0pt} \setlength{\parskip}{0pt} \setlength{\parsep}{0pt}
    \item {\it appAction.execute(solutionHistory, stepper, BEGIN\_STEP)}
    \item {\bf Compute the predictor} (e.g., apply stepper to $x_n$).
    \item {\it appAction.execute(solutionHistory, stepper, BEGIN\_SOLVE)}
    \item {\bf Solve $\mathcal{F}_n(\dot{x}=(x_n-x_{n-1})/\Delta t_n, x_n, t_n)=0$ for $x_n$}
    \item {\it appAction.execute(solutionHistory, stepper, AFTER\_SOLVE)}
    \item $\dot{x}_n \leftarrow (x_n-x_{n-1})/\Delta t_n$
    \item {\it appAction.execute(solutionHistory, stepper, END\_STEP)}
  \end{enumerate}
  \vspace{-10pt} \rule{5in}{0.4pt}
  }
\end{center}

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, $W$. Recalling that the definition of the iteration matrix, $W$, is

\[
  W = \alpha \frac{\partial \mathcal{F}_n}{\partial \dot{x}_n}
    + \beta  \frac{\partial \mathcal{F}_n}{\partial x_n},
\]

where $ \alpha \equiv \frac{\partial \dot{x}_n(x_n) }{\partial x_n}, $ and $ \beta \equiv \frac{\partial x_n}{\partial x_n} = 1$, and the time derivative for Backward Euler is

\[
  \dot{x}_n(x_n) = \frac{x_n - x_{n-1}}{\Delta t},
\]

we can determine that $ \alpha = \frac{1}{\Delta t} $ and $ \beta = 1 $, and therefore write

\[
  W = \frac{1}{\Delta t}
      \frac{\partial \mathcal{F}_n}{\partial \dot{x}_n}
    + \frac{\partial \mathcal{F}_n}{\partial x_n}.
\]

Definition at line 75 of file Tempus_StepperBackwardEuler_decl.hpp.

Constructor & Destructor Documentation

◆ StepperBackwardEuler() [1/2]

template<class Scalar >
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.

◆ StepperBackwardEuler() [2/2]

template<class Scalar >
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.

Member Function Documentation

◆ setAppAction()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::setAppAction ( Teuchos::RCP< StepperBackwardEulerAppAction< Scalar > >  appAction)
virtual

Definition at line 109 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ getAppAction()

template<class Scalar >
virtual Teuchos::RCP< StepperBackwardEulerAppAction< Scalar > > Tempus::StepperBackwardEuler< Scalar >::getAppAction ( ) const
inlinevirtual

Definition at line 104 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ setPredictor() [1/2]

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::setPredictor ( std::string  predictorType = "None")

Set the predictor.

Definition at line 66 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ setPredictor() [2/2]

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::setPredictor ( Teuchos::RCP< Stepper< Scalar > >  predictorStepper)

Set the predictor.

Definition at line 88 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ setModel()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::setModel ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  appModel)
overridevirtual

Set the model.

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 124 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ setInitialConditions()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::setInitialConditions ( const Teuchos::RCP< SolutionHistory< Scalar > > &  solutionHistory)
overridevirtual

Set the initial conditions and make them consistent.

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 142 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ takeStep()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::takeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > &  solutionHistory)
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.

◆ getDefaultStepperState()

template<class Scalar >
Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperBackwardEuler< Scalar >::getDefaultStepperState
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.

◆ getOrder()

template<class Scalar >
virtual Scalar Tempus::StepperBackwardEuler< Scalar >::getOrder ( ) const
inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 125 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ getOrderMin()

template<class Scalar >
virtual Scalar Tempus::StepperBackwardEuler< Scalar >::getOrderMin ( ) const
inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 126 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ getOrderMax()

template<class Scalar >
virtual Scalar Tempus::StepperBackwardEuler< Scalar >::getOrderMax ( ) const
inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 127 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ isExplicit()

template<class Scalar >
virtual bool Tempus::StepperBackwardEuler< Scalar >::isExplicit ( ) const
inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 129 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ isImplicit()

template<class Scalar >
virtual bool Tempus::StepperBackwardEuler< Scalar >::isImplicit ( ) const
inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 130 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ isExplicitImplicit()

template<class Scalar >
virtual bool Tempus::StepperBackwardEuler< Scalar >::isExplicitImplicit ( ) const
inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 131 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ isOneStepMethod()

template<class Scalar >
virtual bool Tempus::StepperBackwardEuler< Scalar >::isOneStepMethod ( ) const
inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 133 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ isMultiStepMethod()

template<class Scalar >
virtual bool Tempus::StepperBackwardEuler< Scalar >::isMultiStepMethod ( ) const
inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 134 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ getOrderODE()

template<class Scalar >
virtual OrderODE Tempus::StepperBackwardEuler< Scalar >::getOrderODE ( ) const
inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 135 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ getAlpha()

template<class Scalar >
virtual Scalar Tempus::StepperBackwardEuler< Scalar >::getAlpha ( const Scalar  dt) const
inlineoverridevirtual

Return alpha = d(xDot)/dx.

Implements Tempus::StepperImplicit< Scalar >.

Definition at line 139 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ getBeta()

template<class Scalar >
virtual Scalar Tempus::StepperBackwardEuler< Scalar >::getBeta ( const  Scalar) const
inlineoverridevirtual

Return beta = d(x)/dx.

Implements Tempus::StepperImplicit< Scalar >.

Definition at line 141 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ computePredictor()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::computePredictor ( const Teuchos::RCP< SolutionHistory< Scalar > > &  solutionHistory)
virtual

Compute predictor given the supplied stepper.

Definition at line 229 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ getValidParameters()

template<class Scalar >
Teuchos::RCP< const Teuchos::ParameterList > Tempus::StepperBackwardEuler< Scalar >::getValidParameters
overridevirtual

Return a valid ParameterList with current settings.

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 315 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ describe()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const
overridevirtual

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 264 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ isValidSetup()

template<class Scalar >
bool Tempus::StepperBackwardEuler< Scalar >::isValidSetup ( Teuchos::FancyOStream &  out) const
overridevirtual

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 289 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ stencilLength()

template<class Scalar >
int Tempus::StepperBackwardEuler< Scalar >::stencilLength ( ) const
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.

◆ computeStepResidual()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::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
overridevirtual

Compute time step residual.

Implements Tempus::StepperOptimizationInterface< Scalar >.

Definition at line 336 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ computeStepJacobian()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::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
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.

◆ computeStepParamDeriv()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::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
overridevirtual

Compute time step derivative w.r.t. model parameters.

Implements Tempus::StepperOptimizationInterface< Scalar >.

Definition at line 368 of file Tempus_StepperBackwardEuler_impl.hpp.

◆ computeStepSolver()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::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
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.

◆ computeStepResidDerivImpl()

template<class Scalar >
void Tempus::StepperBackwardEuler< Scalar >::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
private

Implementation of computeStep*() methods.

Definition at line 401 of file Tempus_StepperBackwardEuler_impl.hpp.

Member Data Documentation

◆ predictorStepper_

template<class Scalar >
Teuchos::RCP<Stepper<Scalar> > Tempus::StepperBackwardEuler< Scalar >::predictorStepper_
private

Definition at line 201 of file Tempus_StepperBackwardEuler_decl.hpp.

◆ stepperBEAppAction_

template<class Scalar >
Teuchos::RCP<StepperBackwardEulerAppAction<Scalar> > Tempus::StepperBackwardEuler< Scalar >::stepperBEAppAction_
private

Definition at line 202 of file Tempus_StepperBackwardEuler_decl.hpp.


The documentation for this class was generated from the following files: