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

Mix-in interface for integrator objects that accept a trailing interpolation buffer object to be used for storing the results of integration. More...

#include <Rythmos_TrailingInterpolationBufferAcceptingIntegratorBase.hpp>

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

Public Member Functions

virtual void setTrailingInterpolationBuffer (const RCP< InterpolationBufferBase< Scalar > > &trailingInterpBuffer)=0
 
virtual RCP< InterpolationBufferBase< Scalar > > getNonconstTrailingInterpolationBuffer ()=0
 
virtual RCP< const InterpolationBufferBase< Scalar > > getTrailingInterpolationBuffer () const =0
 
virtual RCP< InterpolationBufferBase< Scalar > > unSetTrailingInterpolationBuffer ()=0
 
- Public Member Functions inherited from Rythmos::IntegratorBase< Scalar >
virtual RCP< IntegratorBase< Scalar > > cloneIntegrator () const
 
virtual void setStepper (const RCP< StepperBase< Scalar > > &stepper, const Scalar &finalTime, const bool landOnFinalTime=true)=0
 Specify the stepper to use for integration which effectively reinitializes the intergrator.
 
virtual Teuchos::RCP< const StepperBase< Scalar > > getStepper () const =0
 Get the current stepper that is set.
 
virtual Teuchos::RCP< StepperBase< Scalar > > getNonconstStepper () const =0
 Get the current stepper that is set.
 
virtual RCP< StepperBase< Scalar > > unSetStepper ()=0
 Remove the stepper and set *this to an unitilaized state.
 
virtual void getFwdPoints (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)=0
 Get values at time points both inside and outside (forward) of current TimeRange.
 
virtual TimeRange< Scalar > getFwdTimeRange () const =0
 Return the valid range of points that the integrator can integrate over.
 
- Public Member Functions inherited from Rythmos::InterpolationBufferBase< Scalar >
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.
 

Additional Inherited Members

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

Detailed Description

template<class Scalar>
class Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >

Mix-in interface for integrator objects that accept a trailing interpolation buffer object to be used for storing the results of integration.

ToDo: Finish documentation!

Definition at line 48 of file Rythmos_TrailingInterpolationBufferAcceptingIntegratorBase.hpp.

Member Function Documentation

◆ setTrailingInterpolationBuffer()

template<class Scalar >
virtual void Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >::setTrailingInterpolationBuffer ( const RCP< InterpolationBufferBase< Scalar > > &  trailingInterpBuffer)
pure virtual

◆ getNonconstTrailingInterpolationBuffer()

template<class Scalar >
virtual RCP< InterpolationBufferBase< Scalar > > Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >::getNonconstTrailingInterpolationBuffer ( )
pure virtual

◆ getTrailingInterpolationBuffer()

template<class Scalar >
virtual RCP< const InterpolationBufferBase< Scalar > > Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >::getTrailingInterpolationBuffer ( ) const
pure virtual

◆ unSetTrailingInterpolationBuffer()

template<class Scalar >
virtual RCP< InterpolationBufferBase< Scalar > > Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >::unSetTrailingInterpolationBuffer ( )
pure virtual

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