Backward Euler time stepper. More...

#include <Tempus_StepperBackwardEuler_decl.hpp>

Inheritance diagram for Tempus::StepperBackwardEuler< Scalar >:

Public Member Functions
	StepperBackwardEuler ()
	Default 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 override
	Return alpha = d(xDot)/dx. More...

virtual Scalar	getBeta (const Scalar) const override
	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 override
	Return a valid ParameterList with current settings. More...

virtual bool	isValidSetup (Teuchos::FancyOStream &out) const override

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 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	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::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 < StepperBackwardEulerAppAction < Scalar > >	stepperBEAppAction_

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. More...

void	setPredictor (Teuchos::RCP< Stepper< Scalar > > predictorStepper)
	Set the predictor. 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	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 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

Overridden from Teuchos::Describable
virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override

Implementation of StepperOptimizationInterface
virtual int	stencilLength () const override
	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 override
	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 override
	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 override
	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 override
	Compute time step Jacobian solver. More...

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

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

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. More...

bool	isInitialized_
	True if stepper's member data is initialized. More...

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, . 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

template<class Scalar >

Tempus::StepperBackwardEuler< Scalar >::StepperBackwardEuler ( )

Default constructor.

Requires subsequent setModel(), setSolver() and initialize() calls before calling takeStep().

Definition at line 20 of file Tempus_StepperBackwardEuler_impl.hpp.

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 35 of file Tempus_StepperBackwardEuler_impl.hpp.

Member Function Documentation

template<class Scalar >

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

virtual

Definition at line 104 of file Tempus_StepperBackwardEuler_impl.hpp.

template<class Scalar >

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

inlinevirtual

Definition at line 100 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

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

Set the predictor.

Definition at line 61 of file Tempus_StepperBackwardEuler_impl.hpp.

template<class Scalar >

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

Set the predictor.

Definition at line 83 of file Tempus_StepperBackwardEuler_impl.hpp.

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 119 of file Tempus_StepperBackwardEuler_impl.hpp.

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 136 of file Tempus_StepperBackwardEuler_impl.hpp.

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 153 of file Tempus_StepperBackwardEuler_impl.hpp.

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 252 of file Tempus_StepperBackwardEuler_impl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperBackwardEuler< Scalar >::getOrder ( ) const

inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 126 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperBackwardEuler< Scalar >::getOrderMin ( ) const

inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 127 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperBackwardEuler< Scalar >::getOrderMax ( ) const

inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 128 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

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

inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 130 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

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

inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 131 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

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

inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 132 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

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

inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 136 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

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

inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 137 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

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

inlineoverridevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 138 of file Tempus_StepperBackwardEuler_decl.hpp.

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 142 of file Tempus_StepperBackwardEuler_decl.hpp.

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 147 of file Tempus_StepperBackwardEuler_decl.hpp.

template<class Scalar >

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

virtual

Compute predictor given the supplied stepper.

Definition at line 226 of file Tempus_StepperBackwardEuler_impl.hpp.

template<class Scalar >

Teuchos::RCP< const Teuchos::ParameterList > Tempus::StepperBackwardEuler< Scalar >::getValidParameters ( ) const

overridevirtual

Return a valid ParameterList with current settings.

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 309 of file Tempus_StepperBackwardEuler_impl.hpp.

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 260 of file Tempus_StepperBackwardEuler_impl.hpp.

template<class Scalar >

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

overridevirtual

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 283 of file Tempus_StepperBackwardEuler_impl.hpp.

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 320 of file Tempus_StepperBackwardEuler_impl.hpp.

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 326 of file Tempus_StepperBackwardEuler_impl.hpp.

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 339 of file Tempus_StepperBackwardEuler_impl.hpp.

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 353 of file Tempus_StepperBackwardEuler_impl.hpp.

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 369 of file Tempus_StepperBackwardEuler_impl.hpp.

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