Rythmos::BackwardEulerStepper< Scalar > Class Template Reference

Simple concrete stepper subclass implementing an implicit backward Euler method. More...

#include <Rythmos_BackwardEulerStepper.hpp>

Inheritance diagram for Rythmos::BackwardEulerStepper< Scalar >:

Public Types
typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< BackwardEulerStepper < Scalar > >	backwardEulerStepper (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)
	Nonmember constructor.
Constructors, intializers, Misc.

	BackwardEulerStepper ()

	BackwardEulerStepper (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)

void	setInterpolator (RCP< InterpolatorBase< Scalar > > interpolator)

RCP< InterpolatorBase< Scalar > >	unsetInterpolator ()

Overridden from SolverAcceptingStepperBase

void	setSolver (const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)

RCP < Thyra::NonlinearSolverBase < Scalar > >	getNonconstSolver ()

RCP< const Thyra::NonlinearSolverBase < Scalar > >	getSolver () const

Overridden from StepperBase

bool	supportsCloning () const
	Returns true.
RCP< StepperBase< Scalar > >	cloneStepperAlgorithm () const
	Creates copies of all internal data (including the parameter list) except the model which is assumed to stateless.
void	setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model)

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

void	setInitialCondition (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &initialCondition)

Scalar	takeStep (Scalar dt, StepSizeType flag)

const StepStatus< Scalar >	getStepStatus () const

Overridden from InterpolationBufferBase

RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const

void	addPoints (const Array< Scalar > &time_vec, const Array< RCP< const Thyra::VectorBase< Scalar > > > &x_vec, const Array< RCP< const Thyra::VectorBase< Scalar > > > &xdot_vec)

TimeRange< Scalar >	getTimeRange () const

void	getPoints (const Array< Scalar > &time_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > x_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > xdot_vec, Array< ScalarMag > *accuracy_vec) const

void	getNodes (Array< Scalar > *time_vec) const

void	removeNodes (Array< Scalar > &time_vec)

int	getOrder () const

Overridden from Teuchos::ParameterListAcceptor

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

RCP< Teuchos::ParameterList >	getNonconstParameterList ()

RCP< Teuchos::ParameterList >	unsetParameterList ()

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

Overridden from Teuchos::Describable

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

Detailed Description

template<class Scalar>
class Rythmos::BackwardEulerStepper< Scalar >

Simple concrete stepper subclass implementing an implicit backward Euler method.

This class exists primarily as a simple example of an implicit time stepper and as a vehicle for experimentation. The ImplicitBDFStepper also implements backward Euler and is a more powerful stepper class. This class does not implement a local truncation error test and therefore also does not handle the automatic step size selection. Therefore, if you need these features, you should really use the ImplicitBDFStepper class.

Definition at line 64 of file Rythmos_BackwardEulerStepper.hpp.

Member Typedef Documentation

template<class Scalar >

typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Rythmos::BackwardEulerStepper< Scalar >::ScalarMag

Reimplemented from Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 69 of file Rythmos_BackwardEulerStepper.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Rythmos::BackwardEulerStepper< Scalar >::BackwardEulerStepper ( ) [inline]

Definition at line 267 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

Rythmos::BackwardEulerStepper< Scalar >::BackwardEulerStepper	(	const RCP< const Thyra::ModelEvaluator< Scalar > > &	model,
		const RCP< Thyra::NonlinearSolverBase< Scalar > > &	solver
	)			`[inline]`

Definition at line 278 of file Rythmos_BackwardEulerStepper.hpp.

Member Function Documentation

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::setInterpolator ( RCP< InterpolatorBase< Scalar > > interpolator ) [inline]

Definition at line 295 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

RCP< InterpolatorBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::unsetInterpolator ( ) [inline]

Definition at line 309 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::setSolver ( const RCP< Thyra::NonlinearSolverBase< Scalar > > & solver ) [inline, virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 322 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

RCP< Thyra::NonlinearSolverBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getNonconstSolver ( ) [inline, virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 346 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

RCP< const Thyra::NonlinearSolverBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getSolver ( ) const [inline, virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 354 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

bool Rythmos::BackwardEulerStepper< Scalar >::supportsCloning ( ) const [inline, virtual]

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 364 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

RCP< StepperBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::cloneStepperAlgorithm ( ) const [inline, virtual]

Creates copies of all internal data (including the parameter list) except the model which is assumed to stateless.

If a shallow copy of the model is not appropirate for some reasone, then the client can simply reset the model using returnVal->setModel().

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 372 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::setModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > & model ) [inline, virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 401 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getModel ( ) const [inline, virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 435 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::setInitialCondition ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > & initialCondition ) [inline, virtual]

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 442 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

Scalar Rythmos::BackwardEulerStepper< Scalar >::takeStep	(	Scalar	dt,
		StepSizeType	flag
	)			`[inline, virtual]`

Implements Rythmos::StepperBase< Scalar >.

Definition at line 495 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

const StepStatus< Scalar > Rythmos::BackwardEulerStepper< Scalar >::getStepStatus ( ) const [inline, virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 661 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::get_x_space ( ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 692 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::addPoints	(	const Array< Scalar > &	time_vec,
		const Array< RCP< const Thyra::VectorBase< Scalar > > > &	x_vec,
		const Array< RCP< const Thyra::VectorBase< Scalar > > > &	xdot_vec
	)			`[inline, virtual]`

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 699 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

TimeRange< Scalar > Rythmos::BackwardEulerStepper< Scalar >::getTimeRange ( ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 747 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::getPoints	(	const Array< Scalar > &	time_vec,
		Array< RCP< const Thyra::VectorBase< Scalar > > > *	x_vec,
		Array< RCP< const Thyra::VectorBase< Scalar > > > *	xdot_vec,
		Array< ScalarMag > *	accuracy_vec
	)			const `[inline, virtual]`

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 758 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::getNodes ( Array< Scalar > * time_vec ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 866 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::removeNodes ( Array< Scalar > & time_vec ) [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 893 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

int Rythmos::BackwardEulerStepper< Scalar >::getOrder ( ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 915 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const & paramList ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 925 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

RCP< Teuchos::ParameterList > Rythmos::BackwardEulerStepper< Scalar >::getNonconstParameterList ( ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 938 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

RCP< Teuchos::ParameterList > Rythmos::BackwardEulerStepper< Scalar >::unsetParameterList ( ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 946 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

RCP< const Teuchos::ParameterList > Rythmos::BackwardEulerStepper< Scalar >::getValidParameters ( ) const [inline, virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 957 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::BackwardEulerStepper< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)			const `[inline, virtual]`

Reimplemented from Teuchos::Describable.

Definition at line 974 of file Rythmos_BackwardEulerStepper.hpp.

Friends And Related Function Documentation

template<class Scalar >

RCP< BackwardEulerStepper< Scalar > > backwardEulerStepper	(	const RCP< const Thyra::ModelEvaluator< Scalar > > &	model,
		const RCP< Thyra::NonlinearSolverBase< Scalar > > &	solver
	)			`[related]`

Nonmember constructor.

Definition at line 250 of file Rythmos_BackwardEulerStepper.hpp.

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

Rythmos_BackwardEulerStepper.hpp

Rythmos::BackwardEulerStepper< Scalar > Class Template Reference

Public Types

Related Functions

Constructors, intializers, Misc.

Overridden from SolverAcceptingStepperBase

Overridden from StepperBase

Overridden from InterpolationBufferBase

Overridden from Teuchos::ParameterListAcceptor

Overridden from Teuchos::Describable

Detailed Description

template<class Scalar> class Rythmos::BackwardEulerStepper< Scalar >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<class Scalar>
class Rythmos::BackwardEulerStepper< Scalar >