Rythmos::ExplicitRKStepper< Scalar > Class Template Reference

More...

#include <Rythmos_ExplicitRKStepper_decl.hpp>

Inheritance diagram for Rythmos::ExplicitRKStepper< Scalar >:

[legend]List of all members.

Overridden from StepperBase
bool	supportsCloning () const
RCP< StepperBase< Scalar > >	cloneStepperAlgorithm () const
Overridden from RKButcherTableauAcceptingStepperBase
void	setRKButcherTableau (const RCP< const RKButcherTableauBase< Scalar > > &rkbt)
RCP< const RKButcherTableauBase< Scalar > >	getRKButcherTableau () const
Public Types
typedef Teuchos::ScalarTraits< Scalar >	ST
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType	ScalarMag
Public Member Functions
	ExplicitRKStepper ()
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const
void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model)
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getModel () const
	~ExplicitRKStepper ()
void	setInitialCondition (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &initialCondition)
Scalar	takeStep (Scalar dt, StepSizeType flag)
const StepStatus< Scalar >	getStepStatus () const
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) 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< RCP< const VectorBase< Scalar > > > *x_vec, Array< RCP< const VectorBase< Scalar > > > *xdot_vec, Array< ScalarMag > *accuracy_vec) const
	Get values from 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 ()
RCP< const Teuchos::ParameterList >	getValidParameters () const

---

Detailed Description

template<class Scalar>
class Rythmos::ExplicitRKStepper< Scalar >

Definition at line 41 of file Rythmos_ExplicitRKStepper_decl.hpp.

---

Member Typedef Documentation

template<class Scalar>

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

Reimplemented from Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 45 of file Rythmos_ExplicitRKStepper_decl.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Rythmos::ExplicitRKStepper< Scalar >::ExplicitRKStepper

(

)

Definition at line 81 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

Rythmos::ExplicitRKStepper< Scalar >::~ExplicitRKStepper

(

)

Definition at line 165 of file Rythmos_ExplicitRKStepper_def.hpp.

---

Member Function Documentation

template<class Scalar>

bool Rythmos::ExplicitRKStepper< Scalar >::supportsCloning

(

)

const [virtual]

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 436 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

RCP< StepperBase< Scalar > > Rythmos::ExplicitRKStepper< Scalar >::cloneStepperAlgorithm

(

)

const [virtual]

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 442 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

void Rythmos::ExplicitRKStepper< Scalar >::setRKButcherTableau

(

const RCP< const RKButcherTableauBase< Scalar > > &

rkbt

)

[virtual]

Implements Rythmos::RKButcherTableauAcceptingStepperBase< Scalar >.

Definition at line 110 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

RCP< const RKButcherTableauBase< Scalar > > Rythmos::ExplicitRKStepper< Scalar >::getRKButcherTableau

(

)

const [virtual]

Implements Rythmos::RKButcherTableauAcceptingStepperBase< Scalar >.

Definition at line 132 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

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

(

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 170 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

void Rythmos::ExplicitRKStepper< Scalar >::setModel

(

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

model

)

[virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 385 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

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

(

)

const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 395 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

void Rythmos::ExplicitRKStepper< Scalar >::setInitialCondition

(

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

initialCondition

)

[virtual]

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 401 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

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

Implements Rythmos::StepperBase< Scalar >.

Definition at line 177 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

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

(

)

const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 227 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

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

Reimplemented from Teuchos::Describable.

Definition at line 250 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

void Rythmos::ExplicitRKStepper< 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]

Redefined from InterpolationBufferBase Add points to buffer

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 283 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

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

Get values from buffer.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 303 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

TimeRange< Scalar > Rythmos::ExplicitRKStepper< Scalar >::getTimeRange

(

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 293 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

void Rythmos::ExplicitRKStepper< Scalar >::getNodes

(

Array< Scalar > *

time_vec

)

const [virtual]

Get interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 322 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

void Rythmos::ExplicitRKStepper< Scalar >::removeNodes

(

Array< Scalar > &

time_vec

)

[virtual]

Remove interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 336 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

int Rythmos::ExplicitRKStepper< Scalar >::getOrder

(

)

const [virtual]

Get order of interpolation.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 342 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

void Rythmos::ExplicitRKStepper< Scalar >::setParameterList

(

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

paramList

)

[virtual]

Redefined from Teuchos::ParameterListAcceptor .

Implements Teuchos::ParameterListAcceptor.

Definition at line 348 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

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

(

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 357 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

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

(

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 363 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar>

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

(

)

const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 372 of file Rythmos_ExplicitRKStepper_def.hpp.

---

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

• Rythmos_ExplicitRKStepper_decl.hpp
• Rythmos_ExplicitRKStepper_def.hpp

---