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 >:

[legend]List of all members.

Constructors, intializers, Misc.
	BackwardEulerStepper ()
	BackwardEulerStepper (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)
void	setInterpolator (Teuchos::RCP< InterpolatorBase< Scalar > > interpolator)
Teuchos::RCP< InterpolatorBase< Scalar > >	unsetInterpolator ()
Overridden from SolverAcceptingStepperBase
void	setSolver (const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)
Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > >	getNonconstSolver ()
Teuchos::RCP< const Thyra::NonlinearSolverBase< Scalar > >	getSolver () const
Overridden from StepperBase
bool	supportsCloning () const
	Returns true.
Teuchos::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 Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model)
Teuchos::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
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const
void	addPoints (const Array< Scalar > &time_vec, const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &x_vec, const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &xdot_vec)
TimeRange< Scalar >	getTimeRange () const
void	getPoints (const Array< Scalar > &time_vec, Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > *x_vec, Array< Teuchos::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 (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
Teuchos::RCP< Teuchos::ParameterList >	getParameterList ()
Teuchos::RCP< Teuchos::ParameterList >	unsetParameterList ()
Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const
Overridden from Teuchos::Describable
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
Public Types
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType	ScalarMag

---

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 63 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 68 of file Rythmos_BackwardEulerStepper.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Rythmos::BackwardEulerStepper< Scalar >::BackwardEulerStepper

(

)

Definition at line 248 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

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

Definition at line 258 of file Rythmos_BackwardEulerStepper.hpp.

---

Member Function Documentation

template<class Scalar>

void Rythmos::BackwardEulerStepper< Scalar >::setInterpolator

(

Teuchos::RCP< InterpolatorBase< Scalar > >

interpolator

)

Definition at line 273 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

Teuchos::RCP< InterpolatorBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::unsetInterpolator

(

)

Definition at line 287 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

void Rythmos::BackwardEulerStepper< Scalar >::setSolver

(

const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &

solver

)

[virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 300 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getNonconstSolver

(

)

[virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 324 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

Teuchos::RCP< const Thyra::NonlinearSolverBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getSolver

(

)

const [virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 332 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

bool Rythmos::BackwardEulerStepper< Scalar >::supportsCloning

(

)

const [virtual]

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 342 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

Teuchos::RCP< StepperBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::cloneStepperAlgorithm

(

)

const [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 350 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

void Rythmos::BackwardEulerStepper< Scalar >::setModel

(

const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &

model

)

[virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 379 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getModel

(

)

const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 410 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

void Rythmos::BackwardEulerStepper< Scalar >::setInitialCondition

(

const Thyra::ModelEvaluatorBase::InArgs< Scalar > &

initialCondition

)

[virtual]

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 417 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

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

Implements Rythmos::StepperBase< Scalar >.

Definition at line 471 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

const StepStatus< Scalar > Rythmos::BackwardEulerStepper< Scalar >::getStepStatus

(

)

const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 639 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::get_x_space

(

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 680 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 687 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

TimeRange< Scalar > Rythmos::BackwardEulerStepper< Scalar >::getTimeRange

(

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 727 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 734 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

void Rythmos::BackwardEulerStepper< Scalar >::getNodes

(

Array< Scalar > *

time_vec

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 839 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

void Rythmos::BackwardEulerStepper< Scalar >::removeNodes

(

Array< Scalar > &

time_vec

)

[virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 863 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

int Rythmos::BackwardEulerStepper< Scalar >::getOrder

(

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 887 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

void Rythmos::BackwardEulerStepper< Scalar >::setParameterList

(

Teuchos::RCP< Teuchos::ParameterList > const &

paramList

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 897 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

Teuchos::RCP< Teuchos::ParameterList > Rythmos::BackwardEulerStepper< Scalar >::getParameterList

(

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 910 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

Teuchos::RCP< Teuchos::ParameterList > Rythmos::BackwardEulerStepper< Scalar >::unsetParameterList

(

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 918 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

Teuchos::RCP< const Teuchos::ParameterList > Rythmos::BackwardEulerStepper< Scalar >::getValidParameters

(

)

const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 929 of file Rythmos_BackwardEulerStepper.hpp.

template<class Scalar>

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

Reimplemented from Teuchos::Describable.

Definition at line 947 of file Rythmos_BackwardEulerStepper.hpp.

---

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

• Rythmos_BackwardEulerStepper.hpp

---