Rythmos::InterpolationBuffer< Scalar > Class Template Reference

concrete class for interpolation buffer functionality. More...

#include <Rythmos_InterpolationBuffer.hpp>

Inheritance diagram for Rythmos::InterpolationBuffer< Scalar >:

[legend]List of all members.

Public Types
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType	ScalarMag
enum	IBPolicy
Public Member Functions
RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const
	Redefined from Rythmos::InterpolationBufferBase .
	InterpolationBuffer ()
	InterpolationBuffer (const RCP< InterpolatorBase< Scalar > > &interpolator_, int storage_)
void	initialize (const RCP< InterpolatorBase< Scalar > > &interpolator_, int storage_)
	Initialize the buffer:.
void	setInterpolator (const RCP< InterpolatorBase< Scalar > > &interpolator_)
	Set the interpolator for this buffer.
RCP< InterpolatorBase< Scalar > > &	unSetInterpolator ()
	Unset the interpolator for this buffer.
void	setStorage (int storage)
	Set the maximum storage of this buffer.
int	getStorage () const
	Get the maximum storage of this buffer.
	~InterpolationBuffer ()
	Destructor.
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)
	Add point to buffer.
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
	Get value from buffer.
TimeRange< Scalar >	getTimeRange () const
void	getNodes (Array< Scalar > *time_vec) const
	Get interpolation nodes.
int	getOrder () const
	Get order of interpolation.
void	removeNodes (Array< Scalar > &time_vec)
	Remove interpolation nodes.
std::string	description () const
	Redefined from Teuchos::Describable .
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
void	setParameterList (RCP< Teuchos::ParameterList > const &paramList)
	Redefined from Teuchos::ParameterListAcceptor .
RCP< Teuchos::ParameterList >	getParameterList ()
RCP< Teuchos::ParameterList >	unsetParameterList ()

---

Detailed Description

template<class Scalar>
class Rythmos::InterpolationBuffer< Scalar >

concrete class for interpolation buffer functionality.

Definition at line 44 of file Rythmos_InterpolationBuffer.hpp.

---

Member Typedef Documentation

template<class Scalar>

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

Reimplemented from Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 48 of file Rythmos_InterpolationBuffer.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Rythmos::InterpolationBuffer< Scalar >::InterpolationBuffer

(

)

Definition at line 142 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

Rythmos::InterpolationBuffer< Scalar >::~InterpolationBuffer

(

)

[inline]

Destructor.

Definition at line 74 of file Rythmos_InterpolationBuffer.hpp.

---

Member Function Documentation

template<class Scalar>

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

(

)

const [virtual]

Redefined from Rythmos::InterpolationBufferBase .

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 157 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

void Rythmos::InterpolationBuffer< Scalar >::initialize	(	const RCP< InterpolatorBase< Scalar > > &	interpolator_,
		int	storage_
	)

Initialize the buffer:.

Definition at line 168 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

void Rythmos::InterpolationBuffer< Scalar >::setInterpolator

(

const RCP< InterpolatorBase< Scalar > > &

interpolator_

)

Set the interpolator for this buffer.

Definition at line 210 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

RCP<InterpolatorBase<Scalar> >& Rythmos::InterpolationBuffer< Scalar >::unSetInterpolator

(

)

Unset the interpolator for this buffer.

template<class Scalar>

void Rythmos::InterpolationBuffer< Scalar >::setStorage

(

int

storage

)

Set the maximum storage of this buffer.

Definition at line 188 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

int Rythmos::InterpolationBuffer< Scalar >::getStorage

(

)

const

Get the maximum storage of this buffer.

Definition at line 204 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

void Rythmos::InterpolationBuffer< 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
	)			[virtual]

Add point to buffer.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 227 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

void Rythmos::InterpolationBuffer< 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 [virtual]

Get value from buffer.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 346 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

TimeRange< Scalar > Rythmos::InterpolationBuffer< Scalar >::getTimeRange

(

)

const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 372 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

void Rythmos::InterpolationBuffer< Scalar >::getNodes

(

Array< Scalar > *

time_vec

)

const [virtual]

Get interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 379 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

int Rythmos::InterpolationBuffer< Scalar >::getOrder

(

)

const [virtual]

Get order of interpolation.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 430 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

void Rythmos::InterpolationBuffer< Scalar >::removeNodes

(

Array< Scalar > &

time_vec

)

[virtual]

Remove interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 398 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

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

(

)

const [virtual]

Redefined from Teuchos::Describable .

Reimplemented from Teuchos::Describable.

Definition at line 436 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

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

Reimplemented from Teuchos::Describable.

Definition at line 443 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

void Rythmos::InterpolationBuffer< Scalar >::setParameterList

(

RCP< Teuchos::ParameterList > const &

paramList

)

[virtual]

Redefined from Teuchos::ParameterListAcceptor .

Implements Teuchos::ParameterListAcceptor.

Definition at line 466 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

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

(

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 482 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar>

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

(

)

[virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 488 of file Rythmos_InterpolationBuffer.hpp.

---

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

• Rythmos_InterpolationBuffer.hpp

---