Rythmos::ForwardEulerStepper< Scalar > Class Template Reference

More...

#include <Rythmos_ForwardEulerStepper.hpp>

Inheritance diagram for Rythmos::ForwardEulerStepper< Scalar >:

[legend]

List of all members.

Public Types
typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag
Public Member Functions
	ForwardEulerStepper ()
void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model)
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getModel () const
RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const
	~ForwardEulerStepper ()
Scalar	takeStep (Scalar dt, StepSizeType flag)
const StepStatus< Scalar >	getStepStatus () const
std::string	description () const
std::ostream &	describe (std::ostream &out, const Teuchos::EVerbosityLevel verbLevel, const std::string leadingIndent, const std::string indentSpacer) 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)
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
	Get values from buffer.
void	setRange (const TimeRange< Scalar > &range, const InterpolationBufferBase< Scalar > &IB)
	Fill data in from another interpolation buffer.
TimeRange< Scalar >	getTimeRange () const
void	getNodes (Array< Scalar > *time_vec) const
	Get interpolation nodes.
void	removeNodes (Array< Scalar > &time_vec)
	Remove interpolation nodes.
int	getOrder () const
	Get order of interpolation.
void	setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
	Redefined from Teuchos::ParameterListAcceptor.
Teuchos::RCP < Teuchos::ParameterList >	getNonconstParameterList ()
Teuchos::RCP < Teuchos::ParameterList >	unsetParameterList ()

---

Detailed Description

template<class Scalar>
class Rythmos::ForwardEulerStepper< Scalar >

Definition at line 42 of file Rythmos_ForwardEulerStepper.hpp.

---

Member Typedef Documentation

template<class Scalar >

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

Reimplemented from Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 47 of file Rythmos_ForwardEulerStepper.hpp.

---

Constructor & Destructor Documentation

template<class Scalar >

Rythmos::ForwardEulerStepper< Scalar >::ForwardEulerStepper

(

)

[inline]

Definition at line 161 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

Rythmos::ForwardEulerStepper< Scalar >::~ForwardEulerStepper

(

)

[inline]

Definition at line 167 of file Rythmos_ForwardEulerStepper.hpp.

---

Member Function Documentation

template<class Scalar >

void Rythmos::ForwardEulerStepper< Scalar >::setModel

(

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

model

)

[inline, virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 325 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

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

(

)

const [inline, virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 333 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::ForwardEulerStepper< Scalar >::get_x_space

(

)

const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 172 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

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

Implements Rythmos::StepperBase< Scalar >.

Definition at line 179 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

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

(

)

const [inline, virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 209 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

std::string Rythmos::ForwardEulerStepper< Scalar >::description

(

)

const [inline, virtual]

Reimplemented from Teuchos::Describable.

Definition at line 225 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

std::ostream & Rythmos::ForwardEulerStepper< Scalar >::describe	(	std::ostream &	out,
		const Teuchos::EVerbosityLevel	verbLevel,
		const std::string	leadingIndent,
		const std::string	indentSpacer
	)			const [inline]

Definition at line 232 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::ForwardEulerStepper< 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
	)			[inline, virtual]

Redefined from InterpolationBufferBase Add points to buffer

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 258 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::ForwardEulerStepper< 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 [inline, virtual]

Get values from buffer.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 268 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::ForwardEulerStepper< Scalar >::setRange	(	const TimeRange< Scalar > &	range,
		const InterpolationBufferBase< Scalar > &	IB
	)

Fill data in from another interpolation buffer.

template<class Scalar >

TimeRange< Scalar > Rythmos::ForwardEulerStepper< Scalar >::getTimeRange

(

)

const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 278 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::ForwardEulerStepper< Scalar >::getNodes

(

Array< Scalar > *

time_vec

)

const [inline, virtual]

Get interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 284 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::ForwardEulerStepper< Scalar >::removeNodes

(

Array< Scalar > &

time_vec

)

[inline, virtual]

Remove interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 290 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

int Rythmos::ForwardEulerStepper< Scalar >::getOrder

(

)

const [inline, virtual]

Get order of interpolation.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 296 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

void Rythmos::ForwardEulerStepper< Scalar >::setParameterList

(

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

paramList

)

[inline, virtual]

Redefined from Teuchos::ParameterListAcceptor.

Implements Teuchos::ParameterListAcceptor.

Definition at line 302 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Rythmos::ForwardEulerStepper< Scalar >::getNonconstParameterList

(

)

[inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 311 of file Rythmos_ForwardEulerStepper.hpp.

template<class Scalar >

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

(

)

[inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 317 of file Rythmos_ForwardEulerStepper.hpp.

---

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

• Rythmos_ForwardEulerStepper.hpp