Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Related Functions | List of all members
Rythmos::InterpolationBuffer< Scalar > Class Template Reference

concrete class for interpolation buffer functionality. More...

#include <Rythmos_InterpolationBuffer_decl.hpp>

Inheritance diagram for Rythmos::InterpolationBuffer< Scalar >:
Inheritance graph
[legend]

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)
 Redefined from Rythmos::InterpolatorAcceptingObjectBase.
 
RCP< InterpolatorBase< Scalar > > getNonconstInterpolator ()
 
RCP< const InterpolatorBase< Scalar > > getInterpolator () const
 
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.
 
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 ()
 
virtual RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space () const =0
 Return the space for x and x_dot.
 
virtual 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)=0
 Add points to the buffer.
 
virtual TimeRange< Scalar > getTimeRange () const =0
 Return the range of time values where interpolation calls can be performed.
 
virtual 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 =0
 Get values from the buffer at different time points.
 
virtual void getNodes (Array< Scalar > *time_vec) const =0
 Get interpolation nodes.
 
virtual void removeNodes (Array< Scalar > &time_vec)=0
 Remove nodes from the interpolation buffer.
 
virtual int getOrder () const =0
 Get order of interpolation.
 
- Public Member Functions inherited from Rythmos::InterpolatorAcceptingObjectBase< Scalar >
virtual ~InterpolatorAcceptingObjectBase ()
 
virtual void setInterpolator (const RCP< InterpolatorBase< Scalar > > &interpolator)=0
 
virtual RCP< InterpolatorBase< Scalar > > getNonconstInterpolator ()=0
 
virtual RCP< const InterpolatorBase< Scalar > > getInterpolator () const =0
 
virtual RCP< InterpolatorBase< Scalar > > unSetInterpolator ()=0
 

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.
 

Additional Inherited Members

- Public Types inherited from Rythmos::InterpolationBufferBase< Scalar >
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType ScalarMag
 

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.

Constructor & Destructor Documentation

◆ InterpolationBuffer()

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

Definition at line 80 of file Rythmos_InterpolationBuffer_def.hpp.

◆ ~InterpolationBuffer()

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

Destructor.

Definition at line 97 of file Rythmos_InterpolationBuffer_decl.hpp.

Member Function Documentation

◆ get_x_space()

template<class Scalar >
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::InterpolationBuffer< Scalar >::get_x_space
virtual

◆ initialize()

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.

◆ setInterpolator()

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.

◆ getNonconstInterpolator()

template<class Scalar >
RCP< InterpolatorBase< Scalar > > Rythmos::InterpolationBuffer< Scalar >::getNonconstInterpolator
virtual

◆ getInterpolator()

template<class Scalar >
RCP< const InterpolatorBase< Scalar > > Rythmos::InterpolationBuffer< Scalar >::getInterpolator
virtual

◆ unSetInterpolator()

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.

◆ setStorage()

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.

◆ getStorage()

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

Get the maximum storage of this buffer.

Definition at line 150 of file Rythmos_InterpolationBuffer_def.hpp.

◆ getIBPolicy()

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

Definition at line 535 of file Rythmos_InterpolationBuffer_def.hpp.

◆ addPoints()

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.

◆ getPoints()

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.

◆ getTimeRange()

template<class Scalar >
TimeRange< Scalar > Rythmos::InterpolationBuffer< Scalar >::getTimeRange
virtual

◆ getNodes()

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.

◆ getOrder()

template<class Scalar >
int Rythmos::InterpolationBuffer< Scalar >::getOrder
virtual

Get order of interpolation.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 426 of file Rythmos_InterpolationBuffer_def.hpp.

◆ removeNodes()

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.

◆ description()

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

Redefined from Teuchos::Describable.

Definition at line 433 of file Rythmos_InterpolationBuffer_def.hpp.

◆ describe()

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.

◆ setParameterList()

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.

◆ getNonconstParameterList()

template<class Scalar >
RCP< Teuchos::ParameterList > Rythmos::InterpolationBuffer< Scalar >::getNonconstParameterList

Definition at line 520 of file Rythmos_InterpolationBuffer_def.hpp.

◆ unsetParameterList()

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

◆ interpolationBuffer()

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: