Forward Euler time stepper. More...

#include <Tempus_StepperForwardEuler_decl.hpp>

Inheritance diagram for Tempus::StepperForwardEuler< Scalar >:

Public Member Functions
	StepperForwardEuler (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
	Constructor. More...

Basic stepper methods
virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)

virtual void	setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &appModel)

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getModel ()

virtual void	setSolver (std::string solverName)
	Set solver via ParameterList solver name. More...

virtual void	setSolver (Teuchos::RCP< Teuchos::ParameterList > solverPL=Teuchos::null)
	Set solver via solver ParameterList. More...

virtual void	setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver)
	Set solver. More...

virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > >	getSolver () const
	Get solver. More...

virtual void	setObserver (Teuchos::RCP< StepperObserver< Scalar > > obs=Teuchos::null)
	Set Observer. More...

virtual void	initialize ()
	Initialize during construction and after changing input parameters. More...

virtual void	takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
	Take the specified timestep, dt, and return true if successful. More...

virtual std::string	getStepperType () const

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 Scalar	getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const

virtual bool	isExplicit () const

virtual bool	isImplicit () const

virtual bool	isExplicitImplicit () const

virtual bool	isOneStepMethod () const

virtual bool	isMultiStepMethod () const

virtual void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess)
	Pass initial guess to Newton solver (only relevant for implicit solvers) More...

virtual Teuchos::RCP< Thyra::VectorBase< Scalar > >	getXDotTemp (Teuchos::RCP< Thyra::VectorBase< Scalar > > x)
	Provide temporary xDot memory for Stepper if SolutionState doesn't. More...

ParameterList methods
void	setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &pl)

Teuchos::RCP< Teuchos::ParameterList >	getNonconstParameterList ()

Teuchos::RCP< Teuchos::ParameterList >	unsetParameterList ()

Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const

Teuchos::RCP< Teuchos::ParameterList >	getDefaultParameters () const

Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual void	createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > models)

void	validExplicitODE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
	Validate that the model supports explicit ODE evaluation, f(x,t) [=xdot]. More...

void	validSecondOrderExplicitODE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
	Validate that the model supports explicit second order ODE evaluation, f(x,xdot,t) [=xdotdot]. More...

void	validImplicitODE_DAE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
	Validate ME supports implicit ODE/DAE evaluation, f(xdot,x,t) [= 0]. More...

void	validSecondOrderODE_DAE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
	Validate ME supports 2nd order implicit ODE/DAE evaluation, f(xdotdot,xdot,x,t) [= 0]. More...

Teuchos::RCP< Teuchos::ParameterList >	defaultSolverParameters () const

Overridden from Teuchos::Describable
Teuchos::RCP< Teuchos::ParameterList >	stepperPL_

Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	appModel_
	Explicit ODE ModelEvaluator. More...

Thyra::ModelEvaluatorBase::InArgs< Scalar >	inArgs_

Thyra::ModelEvaluatorBase::OutArgs< Scalar >	outArgs_

Teuchos::RCP< StepperObserver< Scalar > >	stepperObserver_

Teuchos::RCP< StepperForwardEulerObserver< Scalar > >	stepperFEObserver_

Teuchos::RCP< Thyra::VectorBase< Scalar > >	xDotTemp_

Teuchos::RCP< const Thyra::VectorBase< Scalar > >	initial_guess_

virtual std::string	description () const

virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

	StepperForwardEuler ()
	Default Constructor – not allowed. More...

Detailed Description

template<class Scalar>
class Tempus::StepperForwardEuler< Scalar >

Forward Euler time stepper.

For the explicit ODE system,

$\dot{x} = \bar{f}(x,t),$

the Forward Euler stepper can be written as

$x_{n} = x_{n-1} + \Delta t\, \bar{f}(x_{n-1},t_{n-1})$

Forward Euler is an explicit time stepper (i.e., no solver used). Note that the time derivative by definition is

$\dot{x}_{n} = \bar{f}(x_{n},t_{n}),$

Algorithm The single-timestep algorithm for Forward Euler is simply,

Evaluate $\bar{f}(x_{n-1},t_{n-1})$
$x_{n} \leftarrow x_{n-1} + \Delta t\, \bar{f}(x_{n-1},t_{n-1})$
$\dot{x}_n \leftarrow \bar{f}(x_{n},t_{n})$ [Optional]

Definition at line 42 of file Tempus_StepperForwardEuler_decl.hpp.

Constructor & Destructor Documentation

◆ StepperForwardEuler() [1/2]

template<class Scalar >

Tempus::StepperForwardEuler< Scalar >::StepperForwardEuler	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	appModel,
		Teuchos::RCP< Teuchos::ParameterList >	pList = `Teuchos::null`
	)

Constructor.

Definition at line 20 of file Tempus_StepperForwardEuler_impl.hpp.

◆ StepperForwardEuler() [2/2]

template<class Scalar>

Tempus::StepperForwardEuler< Scalar >::StepperForwardEuler ( )

private

Default Constructor – not allowed.

Member Function Documentation

◆ describe()

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)		const

virtual

Definition at line 205 of file Tempus_StepperForwardEuler_impl.hpp.

◆ description()

template<class Scalar >

std::string Tempus::StepperForwardEuler< Scalar >::description ( ) const

virtual

Definition at line 197 of file Tempus_StepperForwardEuler_impl.hpp.

◆ getDefaultParameters()

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperForwardEuler< Scalar >::getDefaultParameters ( ) const

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 249 of file Tempus_StepperForwardEuler_impl.hpp.

◆ getDefaultStepperState()

template<class Scalar >

Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperForwardEuler< Scalar >::getDefaultStepperState ( )

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 188 of file Tempus_StepperForwardEuler_impl.hpp.

◆ getInitTimeStep()

template<class Scalar>

virtual Scalar Tempus::StepperForwardEuler< Scalar >::getInitTimeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > & solutionHistory ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 85 of file Tempus_StepperForwardEuler_decl.hpp.

◆ getModel()

template<class Scalar>

virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::StepperForwardEuler< Scalar >::getModel ( )

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 58 of file Tempus_StepperForwardEuler_decl.hpp.

◆ getNonconstParameterList()

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperForwardEuler< Scalar >::getNonconstParameterList ( )

Definition at line 259 of file Tempus_StepperForwardEuler_impl.hpp.

◆ getOrder()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 82 of file Tempus_StepperForwardEuler_decl.hpp.

◆ getOrderMax()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 84 of file Tempus_StepperForwardEuler_decl.hpp.

◆ getOrderMin()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 83 of file Tempus_StepperForwardEuler_decl.hpp.

◆ getSolver()

template<class Scalar>

virtual Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > Tempus::StepperForwardEuler< Scalar >::getSolver ( ) const

inlinevirtual

Get solver.

Implements Tempus::Stepper< Scalar >.

Definition at line 65 of file Tempus_StepperForwardEuler_decl.hpp.

◆ getStepperType()

template<class Scalar>

virtual std::string Tempus::StepperForwardEuler< Scalar >::getStepperType ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 77 of file Tempus_StepperForwardEuler_decl.hpp.

◆ getValidParameters()

template<class Scalar >

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

Definition at line 236 of file Tempus_StepperForwardEuler_impl.hpp.

◆ getXDotTemp()

template<class Scalar >

Teuchos::RCP< Thyra::VectorBase< Scalar > > Tempus::StepperForwardEuler< Scalar >::getXDotTemp ( Teuchos::RCP< Thyra::VectorBase< Scalar > > x )

virtual

Provide temporary xDot memory for Stepper if SolutionState doesn't.

Definition at line 170 of file Tempus_StepperForwardEuler_impl.hpp.

◆ initialize()

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::initialize ( )

virtual

Initialize during construction and after changing input parameters.

Implements Tempus::Stepper< Scalar >.

Definition at line 101 of file Tempus_StepperForwardEuler_impl.hpp.

◆ isExplicit()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 89 of file Tempus_StepperForwardEuler_decl.hpp.

◆ isExplicitImplicit()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 91 of file Tempus_StepperForwardEuler_decl.hpp.

◆ isImplicit()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 90 of file Tempus_StepperForwardEuler_decl.hpp.

◆ isMultiStepMethod()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 94 of file Tempus_StepperForwardEuler_decl.hpp.

◆ isOneStepMethod()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 93 of file Tempus_StepperForwardEuler_decl.hpp.

◆ setInitialGuess()

template<class Scalar>

virtual void Tempus::StepperForwardEuler< Scalar >::setInitialGuess ( Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess )

inlinevirtual

Pass initial guess to Newton solver (only relevant for implicit solvers)

Implements Tempus::Stepper< Scalar >.

Definition at line 98 of file Tempus_StepperForwardEuler_decl.hpp.

◆ setModel()

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::setModel ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & appModel )

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 31 of file Tempus_StepperForwardEuler_impl.hpp.

◆ setNonConstModel()

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::setNonConstModel ( const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > & appModel )

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 42 of file Tempus_StepperForwardEuler_impl.hpp.

◆ setObserver()

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::setObserver ( Teuchos::RCP< StepperObserver< Scalar > > obs = Teuchos::null )

virtual

Set Observer.

Implements Tempus::Stepper< Scalar >.

Definition at line 81 of file Tempus_StepperForwardEuler_impl.hpp.

◆ setParameterList()

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > & pl )

Definition at line 215 of file Tempus_StepperForwardEuler_impl.hpp.

◆ setSolver() [1/3]

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::setSolver ( std::string solverName )

virtual

Set solver via ParameterList solver name.

Implements Tempus::Stepper< Scalar >.

Definition at line 49 of file Tempus_StepperForwardEuler_impl.hpp.

◆ setSolver() [2/3]

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::setSolver ( Teuchos::RCP< Teuchos::ParameterList > solverPL = Teuchos::null )

virtual

Set solver via solver ParameterList.

Implements Tempus::Stepper< Scalar >.

Definition at line 59 of file Tempus_StepperForwardEuler_impl.hpp.

◆ setSolver() [3/3]

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::setSolver ( Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver )

virtual

Set solver.

Implements Tempus::Stepper< Scalar >.

Definition at line 70 of file Tempus_StepperForwardEuler_impl.hpp.

◆ takeStep()

template<class Scalar >

void Tempus::StepperForwardEuler< Scalar >::takeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > & solutionHistory )

virtual

Take the specified timestep, dt, and return true if successful.

Implements Tempus::Stepper< Scalar >.

Definition at line 113 of file Tempus_StepperForwardEuler_impl.hpp.

◆ unsetParameterList()

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperForwardEuler< Scalar >::unsetParameterList ( )

Definition at line 267 of file Tempus_StepperForwardEuler_impl.hpp.

Member Data Documentation

◆ appModel_

template<class Scalar>

Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::StepperForwardEuler< Scalar >::appModel_

protected

Explicit ODE ModelEvaluator.

Definition at line 130 of file Tempus_StepperForwardEuler_decl.hpp.

◆ inArgs_

template<class Scalar>

Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::StepperForwardEuler< Scalar >::inArgs_

protected

Definition at line 132 of file Tempus_StepperForwardEuler_decl.hpp.

◆ initial_guess_

template<class Scalar>

Teuchos::RCP<const Thyra::VectorBase<Scalar> > Tempus::StepperForwardEuler< Scalar >::initial_guess_

protected

Definition at line 139 of file Tempus_StepperForwardEuler_decl.hpp.

◆ outArgs_

template<class Scalar>

Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus::StepperForwardEuler< Scalar >::outArgs_

protected

Definition at line 133 of file Tempus_StepperForwardEuler_decl.hpp.

◆ stepperFEObserver_

template<class Scalar>

Teuchos::RCP<StepperForwardEulerObserver<Scalar> > Tempus::StepperForwardEuler< Scalar >::stepperFEObserver_

protected

Definition at line 136 of file Tempus_StepperForwardEuler_decl.hpp.

◆ stepperObserver_

template<class Scalar>

Teuchos::RCP<StepperObserver<Scalar> > Tempus::StepperForwardEuler< Scalar >::stepperObserver_

protected

Definition at line 135 of file Tempus_StepperForwardEuler_decl.hpp.

◆ stepperPL_

template<class Scalar>

Teuchos::RCP<Teuchos::ParameterList> Tempus::StepperForwardEuler< Scalar >::stepperPL_

protected

Definition at line 128 of file Tempus_StepperForwardEuler_decl.hpp.

◆ xDotTemp_

template<class Scalar>

Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::StepperForwardEuler< Scalar >::xDotTemp_

protected

Definition at line 138 of file Tempus_StepperForwardEuler_decl.hpp.

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

/home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Tempus_StepperForwardEuler_decl.hpp
/home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Tempus_StepperForwardEuler_impl.hpp

Public Member Functions

Overridden from Teuchos::Describable

Detailed Description

template<class Scalar> class Tempus::StepperForwardEuler< Scalar >

Constructor & Destructor Documentation

◆ StepperForwardEuler() [1/2]

◆ StepperForwardEuler() [2/2]

Member Function Documentation

◆ describe()

◆ description()

◆ getDefaultParameters()

◆ getDefaultStepperState()

◆ getInitTimeStep()

◆ getModel()

◆ getNonconstParameterList()

◆ getOrder()

◆ getOrderMax()

◆ getOrderMin()

◆ getSolver()

◆ getStepperType()

◆ getValidParameters()

◆ getXDotTemp()

◆ initialize()

◆ isExplicit()

◆ isExplicitImplicit()

◆ isImplicit()

◆ isMultiStepMethod()

◆ isOneStepMethod()

◆ setInitialGuess()

◆ setModel()

◆ setNonConstModel()

◆ setObserver()

◆ setParameterList()

◆ setSolver() [1/3]

◆ setSolver() [2/3]

◆ setSolver() [3/3]

◆ takeStep()

◆ unsetParameterList()

Member Data Documentation

◆ appModel_

◆ inArgs_

◆ initial_guess_

◆ outArgs_

◆ stepperFEObserver_

◆ stepperObserver_

◆ stepperPL_

◆ xDotTemp_

template<class Scalar>
class Tempus::StepperForwardEuler< Scalar >