concrete class for interpolation buffer functionality. More...

#include <Rythmos_InterpolationBuffer_decl.hpp>

Inheritance diagram for Rythmos::InterpolationBuffer< Scalar >:

Public Types
typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag

Public Member Functions
RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const
	Redefined from Rythmos::InterpolationBufferBase.
	InterpolationBuffer ()

void	initialize (const RCP< InterpolatorBase< Scalar > > &interpolator, int storage)
	Initialize the buffer:
void	setStorage (int storage)
	Set the maximum storage of this buffer.
int	getStorage () const
	Get the maximum storage of this buffer.
IBPolicy	getIBPolicy ()

	~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 >	getNonconstParameterList ()

RCP< Teuchos::ParameterList >	unsetParameterList ()

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< InterpolationBuffer < Scalar > >	interpolationBuffer (const RCP< InterpolatorBase< Scalar > > &interpolator=Teuchos::null, int storage=0)
	Nonmember constructor.
void	setInterpolator (const RCP< InterpolatorBase< Scalar > > &interpolator)
	Redefined from Rythmos::InterpolatorAcceptingObjectBase.
RCP< InterpolatorBase< Scalar > >	getNonconstInterpolator ()

RCP< const InterpolatorBase < Scalar > >	getInterpolator () const

RCP< InterpolatorBase< Scalar > >	unSetInterpolator ()
	Unset the interpolator for this buffer.

Detailed Description

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

concrete class for interpolation buffer functionality.

Definition at line 50 of file Rythmos_InterpolationBuffer_decl.hpp.

Member Typedef Documentation

template<class Scalar >

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

Reimplemented from Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 56 of file Rythmos_InterpolationBuffer_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Rythmos::InterpolationBuffer< Scalar >::InterpolationBuffer ( )

Definition at line 80 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

Rythmos::InterpolationBuffer< Scalar >::~InterpolationBuffer ( ) [inline]

Destructor.

Definition at line 97 of file Rythmos_InterpolationBuffer_decl.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 98 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

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

Initialize the buffer:

Definition at line 110 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

void Rythmos::InterpolationBuffer< Scalar >::setInterpolator ( const RCP< InterpolatorBase< Scalar > > & interpolator ) [virtual]

Redefined from Rythmos::InterpolatorAcceptingObjectBase.

Set the interpolator for this buffer

Implements Rythmos::InterpolatorAcceptingObjectBase< Scalar >.

Definition at line 157 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

RCP< InterpolatorBase< Scalar > > Rythmos::InterpolationBuffer< Scalar >::getNonconstInterpolator ( ) [virtual]

Implements Rythmos::InterpolatorAcceptingObjectBase< Scalar >.

Definition at line 175 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

RCP< const InterpolatorBase< Scalar > > Rythmos::InterpolationBuffer< Scalar >::getInterpolator ( ) const [virtual]

Implements Rythmos::InterpolatorAcceptingObjectBase< Scalar >.

Definition at line 182 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

RCP< InterpolatorBase< Scalar > > Rythmos::InterpolationBuffer< Scalar >::unSetInterpolator ( ) [virtual]

Unset the interpolator for this buffer.

Implements Rythmos::InterpolatorAcceptingObjectBase< Scalar >.

Definition at line 188 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

void Rythmos::InterpolationBuffer< Scalar >::setStorage ( int storage )

Set the maximum storage of this buffer.

Definition at line 131 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

int Rythmos::InterpolationBuffer< Scalar >::getStorage ( ) const

Get the maximum storage of this buffer.

Definition at line 150 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

IBPolicy Rythmos::InterpolationBuffer< Scalar >::getIBPolicy ( )

Definition at line 535 of file Rythmos_InterpolationBuffer_def.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 197 of file Rythmos_InterpolationBuffer_def.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 336 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

TimeRange< Scalar > Rythmos::InterpolationBuffer< Scalar >::getTimeRange ( ) const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 362 of file Rythmos_InterpolationBuffer_def.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 373 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

int Rythmos::InterpolationBuffer< Scalar >::getOrder ( ) const [virtual]

Get order of interpolation.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 426 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

void Rythmos::InterpolationBuffer< Scalar >::removeNodes ( Array< Scalar > & time_vec ) [virtual]

Remove interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 393 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

std::string Rythmos::InterpolationBuffer< Scalar >::description ( ) const

Redefined from Teuchos::Describable.

Definition at line 433 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

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

Definition at line 441 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

void Rythmos::InterpolationBuffer< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const & paramList )

Redefined from Teuchos::ParameterListAcceptor.

Definition at line 465 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

RCP< Teuchos::ParameterList > Rythmos::InterpolationBuffer< Scalar >::getNonconstParameterList ( )

Definition at line 520 of file Rythmos_InterpolationBuffer_def.hpp.

template<class Scalar >

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

Definition at line 527 of file Rythmos_InterpolationBuffer_def.hpp.

Friends And Related Function Documentation

template<class Scalar >

RCP< InterpolationBuffer< Scalar > > interpolationBuffer	(	const RCP< InterpolatorBase< Scalar > > &	interpolator = `Teuchos::null`,
		int	storage = `0`
	)		`[related]`

Nonmember constructor.

Definition at line 169 of file Rythmos_InterpolationBuffer_decl.hpp.

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

Public Types

Public Member Functions

Related Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

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