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
 

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 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::ParameterListgetNonconstParameterList ()
 
RCP< Teuchos::ParameterListunsetParameterList ()
 

Detailed Description

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

concrete class for interpolation buffer functionality.

Definition at line 45 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 49 of file Rythmos_InterpolationBuffer.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Rythmos::InterpolationBuffer< Scalar >::InterpolationBuffer (  )  [inline]

Definition at line 146 of file Rythmos_InterpolationBuffer.hpp.

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

Destructor.

Definition at line 75 of file Rythmos_InterpolationBuffer.hpp.


Member Function Documentation

template<class Scalar >
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::InterpolationBuffer< Scalar >::get_x_space (  )  const [inline, virtual]
template<class Scalar >
void Rythmos::InterpolationBuffer< Scalar >::initialize ( const RCP< InterpolatorBase< Scalar > > &  interpolator_,
int  storage_ 
) [inline]

Initialize the buffer:.

Definition at line 176 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar >
void Rythmos::InterpolationBuffer< Scalar >::setInterpolator ( const RCP< InterpolatorBase< Scalar > > &  interpolator_  )  [inline]

Set the interpolator for this buffer.

Definition at line 222 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  )  [inline]

Set the maximum storage of this buffer.

Definition at line 196 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar >
int Rythmos::InterpolationBuffer< Scalar >::getStorage (  )  const [inline]

Get the maximum storage of this buffer.

Definition at line 215 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 
) [inline, virtual]

Add point to buffer.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 240 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 [inline, virtual]

Get value from buffer.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 360 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar >
TimeRange< Scalar > Rythmos::InterpolationBuffer< Scalar >::getTimeRange (  )  const [inline, virtual]
template<class Scalar >
void Rythmos::InterpolationBuffer< Scalar >::getNodes ( Array< Scalar > *  time_vec  )  const [inline, virtual]

Get interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 397 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar >
int Rythmos::InterpolationBuffer< Scalar >::getOrder (  )  const [inline, virtual]

Get order of interpolation.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 450 of file Rythmos_InterpolationBuffer.hpp.

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

Remove interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 417 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar >
std::string Rythmos::InterpolationBuffer< Scalar >::description (  )  const [inline, virtual]

Redefined from Teuchos::Describable.

Reimplemented from Teuchos::Describable.

Definition at line 457 of file Rythmos_InterpolationBuffer.hpp.

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

Reimplemented from Teuchos::Describable.

Definition at line 465 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar >
void Rythmos::InterpolationBuffer< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const &  paramList  )  [inline, virtual]
template<class Scalar >
RCP< Teuchos::ParameterList > Rythmos::InterpolationBuffer< Scalar >::getNonconstParameterList (  )  [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 508 of file Rythmos_InterpolationBuffer.hpp.

template<class Scalar >
RCP< Teuchos::ParameterList > Rythmos::InterpolationBuffer< Scalar >::unsetParameterList (  )  [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 515 of file Rythmos_InterpolationBuffer.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends

Generated on Tue Oct 20 10:24:10 2009 for Rythmos - Transient Integration for Differential Equations by  doxygen 1.6.1