Rythmos::IntegratorDefault< Scalar > Class Template Reference

Concrete subclass of InterpolationBufferBase implemented in terms of a StepperBase object and a trailing InterpolationBufferBase object. More...

#include <Rythmos_IntegratorDefault.hpp>

Inheritance diagram for Rythmos::IntegratorDefault< Scalar >:

[legend]List of all members.

Constructors, Initializers, Misc
	~IntegratorDefault ()
	IntegratorDefault ()
	IntegratorDefault (const Teuchos::RCP< StepperBase< Scalar > > &stepper, const Teuchos::RCP< InterpolationBufferBase< Scalar > > &trailingInterpBuffer, const Teuchos::RCP< Teuchos::ParameterList > &paramList=Teuchos::null)
void	setTrailingInterpolationBuffer (const Teuchos::RCP< InterpolationBufferBase< Scalar > > &trailingInterpBuffer)
bool	acceptsTrailingInterpolationBuffer () const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const
Teuchos::RCP< const InterpolationBufferBase< Scalar > >	getInterpolationBuffer ()
Teuchos::RCP< InterpolationBufferBase< Scalar > >	unSetInterpolationBuffer ()
void	setInterpolationBufferAppender (const Teuchos::RCP< InterpolationBufferAppenderBase< Scalar > > &interpolationBufferAppender)
Teuchos::RCP< const InterpolationBufferAppenderBase< Scalar > >	getInterpolationBufferAppender ()
Teuchos::RCP< InterpolationBufferAppenderBase< Scalar > >	unSetInterpolationBufferAppender ()
void	setStepper (const Teuchos::RCP< StepperBase< Scalar > > &stepper, const Scalar &finalTime, const bool landOnFinalTime)
Teuchos::RCP< const Rythmos::StepperBase< Scalar > >	getStepper () const
Teuchos::RCP< StepperBase< Scalar > >	unSetStepper ()
void	setBreakPointInformer (Teuchos::RCP< BreakPointInformerBase< Scalar > > &breakPointInformer)
Teuchos::RCP< const BreakPointInformerBase< Scalar > >	getBreakPointInformer ()
Teuchos::RCP< BreakPointInformerBase< Scalar > >	unSetBreakPointInformer ()
void	setObserver (Teuchos::RCP< IntegrationObserverBase< Scalar > > &observer)
Teuchos::RCP< const IntegrationObserverBase< Scalar > >	getObserver ()
Teuchos::RCP< IntegrationObserverBase< Scalar > >	unSetObserver ()
Overridden from InterpolationBufferBase
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
TimeRange< Scalar >	getTimeRange () const
void	getNodes (Array< Scalar > *time_vec) const
int	getOrder () const
Overridden from Teuchos::Describable
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) 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
Public Types
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType	ScalarMag
Public Member Functions
void	getFwdPoints (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)
	Get values at time points both inside and outside (forward) of current TimeRange.
TimeRange< Scalar >	getFwdTimeRange () const
virtual void	removeNodes (Array< Scalar > &time_vec)

---

Detailed Description

template<class Scalar>
class Rythmos::IntegratorDefault< Scalar >

Concrete subclass of InterpolationBufferBase implemented in terms of a StepperBase object and a trailing InterpolationBufferBase object.

Definition at line 51 of file Rythmos_IntegratorDefault.hpp.

---

Member Typedef Documentation

template<class Scalar>

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

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 56 of file Rythmos_IntegratorDefault.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Rythmos::IntegratorDefault< Scalar >::~IntegratorDefault

(

)

[inline]

Definition at line 62 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Rythmos::IntegratorDefault< Scalar >::IntegratorDefault

(

)

Definition at line 257 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Rythmos::IntegratorDefault< Scalar >::IntegratorDefault	(	const Teuchos::RCP< StepperBase< Scalar > > &	stepper,
		const Teuchos::RCP< InterpolationBufferBase< Scalar > > &	trailingInterpBuffer,
		const Teuchos::RCP< Teuchos::ParameterList > &	paramList = Teuchos::null
	)

Definition at line 263 of file Rythmos_IntegratorDefault.hpp.

---

Member Function Documentation

template<class Scalar>

void Rythmos::IntegratorDefault< Scalar >::setTrailingInterpolationBuffer

(

const Teuchos::RCP< InterpolationBufferBase< Scalar > > &

trailingInterpBuffer

)

[virtual]

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 322 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

bool Rythmos::IntegratorDefault< Scalar >::acceptsTrailingInterpolationBuffer

(

)

const [virtual]

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 354 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

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

(

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 289 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< const InterpolationBufferBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::getInterpolationBuffer

(

)

Definition at line 433 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< InterpolationBufferBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::unSetInterpolationBuffer

(

)

Definition at line 439 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< Scalar >::setInterpolationBufferAppender

(

const Teuchos::RCP< InterpolationBufferAppenderBase< Scalar > > &

interpolationBufferAppender

)

Definition at line 448 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< const InterpolationBufferAppenderBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::getInterpolationBufferAppender

(

)

Definition at line 463 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< InterpolationBufferAppenderBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::unSetInterpolationBufferAppender

(

)

Definition at line 469 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< Scalar >::setStepper	(	const Teuchos::RCP< StepperBase< Scalar > > &	stepper,
		const Scalar &	finalTime,
		const bool	landOnFinalTime
	)			[virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 360 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< const Rythmos::StepperBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::getStepper

(

)

const [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 427 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< StepperBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::unSetStepper

(

)

[virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 394 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< Scalar >::setBreakPointInformer

(

Teuchos::RCP< BreakPointInformerBase< Scalar > > &

breakPointInformer

)

Definition at line 403 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< const BreakPointInformerBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::getBreakPointInformer

(

)

Definition at line 412 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< BreakPointInformerBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::unSetBreakPointInformer

(

)

Definition at line 419 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< Scalar >::setObserver

(

Teuchos::RCP< IntegrationObserverBase< Scalar > > &

observer

)

Definition at line 478 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< const IntegrationObserverBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::getObserver

(

)

Definition at line 484 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

Teuchos::RCP< IntegrationObserverBase< Scalar > > Rythmos::IntegratorDefault< Scalar >::unSetObserver

(

)

Definition at line 490 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< Scalar >::getFwdPoints	(	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
	)			[virtual]

Get values at time points both inside and outside (forward) of current TimeRange.

Parameters:

	time_vec	[in] Array (length n) of time points to get.
	x_vec	[out] On output, if x_vec != 0, *x_vec will be resized to n = time_vec.size() and (*x_vec)[i] will be the state vector at time time_vec[i], for i=0...n-1. This argument can be left NULL in which case it will not be filled.
	xdot_vec	[out] On output, if xdot_vec != 0, *xdot_vec will be resized to n = time_vec.size() and (*xdot_vec)[i] will be the state derivative vector at time time_vec[i], for i=0...n-1. This argument can be left NULL in which case it will not be filled.
	accuracy_vec	[out] This contains an estimate of the accuracy of the interpolation. This argument can be left NULL in which case it will not be filled. If you asked for a node, this should be zero.

Preconditions:

• range.lower() <= time_vec[i] <= range.upper(), for i=0...n-1, where range = this->getFwdTimeRange().
• time_vec must have unique and sorted values in ascending order

Postconditions:

• Returns all of requested time points if no exception is thrown.
• Note that this->getTimeRange().lower() may be greater after this function returns than before this function was called! That is why this is a non-const function!

Exceptions:

Throwns

Exceptions::GetFwdPointsFailed if all of the time points could not be reached for some reason (e.g. the max number of time-step iterations was exceeded).

This is a non-const version of the const function getPoints() which allows the integrator class to step forward to get the points asked for.

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 876 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

TimeRange< Scalar > Rythmos::IntegratorDefault< Scalar >::getFwdTimeRange

(

)

const [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 995 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< 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 502 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< 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 516 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

TimeRange< Scalar > Rythmos::IntegratorDefault< Scalar >::getTimeRange

(

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 674 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< Scalar >::getNodes

(

Array< Scalar > *

time_vec

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 686 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

int Rythmos::IntegratorDefault< Scalar >::getOrder

(

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 713 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< Scalar >::removeNodes

(

Array< Scalar > &

time_vec

)

[virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 703 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

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

Reimplemented from Teuchos::Describable.

Definition at line 724 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

void Rythmos::IntegratorDefault< Scalar >::setParameterList

(

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

paramList

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 784 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

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

(

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 826 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

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

(

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 834 of file Rythmos_IntegratorDefault.hpp.

template<class Scalar>

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

(

)

const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 844 of file Rythmos_IntegratorDefault.hpp.

---

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

• Rythmos_IntegratorDefault.hpp

---