Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Tempus::InterpolatorLagrange< Scalar > Class Template Reference

Concrete implemenation of Interpolator that does simple lagrange interpolation. More...

#include <Tempus_InterpolatorLagrange_decl.hpp>

Inheritance diagram for Tempus::InterpolatorLagrange< Scalar >:
Tempus::Interpolator< Scalar >

Public Member Functions

 InterpolatorLagrange ()
 Contructor.
 
 ~InterpolatorLagrange ()
 Destructor.
 

Overridden from Teuchos::ParameterListAcceptor

Teuchos::RCP< const std::vector< Teuchos::RCP< SolutionState< Scalar > > > > nodes_
 
Teuchos::RCP< Teuchos::ParameterList > pl_
 
int order_
 
void setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &paramList)
 
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList ()
 
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList ()
 
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const
 
void lagrange (const int p, const Scalar &t, SolutionState< Scalar > *state_out) const
 

Overridden from Tempus::Interpolator

void setNodes (const Teuchos::RCP< const std::vector< Teuchos::RCP< SolutionState< Scalar > > > > &nodes)
 Store pointer to interpolation nodes.
 
void interpolate (const Scalar &t, SolutionState< Scalar > *state_out) const
 Perform an interpolation.
 
int order () const
 Return the order of the interpolation.
 

Overridden from Teuchos::Describable

std::string description () const
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel) const
 

Detailed Description

template<class Scalar>
class Tempus::InterpolatorLagrange< Scalar >

Concrete implemenation of Interpolator that does simple lagrange interpolation.

Definition at line 21 of file Tempus_InterpolatorLagrange_decl.hpp.

Constructor & Destructor Documentation

◆ InterpolatorLagrange()

template<class Scalar >
Tempus::InterpolatorLagrange< Scalar >::InterpolatorLagrange ( )
inline

Contructor.

Definition at line 26 of file Tempus_InterpolatorLagrange_decl.hpp.

◆ ~InterpolatorLagrange()

template<class Scalar >
Tempus::InterpolatorLagrange< Scalar >::~InterpolatorLagrange ( )
inline

Destructor.

Definition at line 29 of file Tempus_InterpolatorLagrange_decl.hpp.

Member Function Documentation

◆ setNodes()

template<class Scalar >
void Tempus::InterpolatorLagrange< Scalar >::setNodes ( const Teuchos::RCP< const std::vector< Teuchos::RCP< SolutionState< Scalar > > > > & nodes)
inlinevirtual

Store pointer to interpolation nodes.

Implements Tempus::Interpolator< Scalar >.

Definition at line 35 of file Tempus_InterpolatorLagrange_decl.hpp.

◆ interpolate()

template<class Scalar >
void Tempus::InterpolatorLagrange< Scalar >::interpolate ( const Scalar & t,
SolutionState< Scalar > * state_out ) const
virtual

Perform an interpolation.

Implements Tempus::Interpolator< Scalar >.

Definition at line 21 of file Tempus_InterpolatorLagrange_impl.hpp.

◆ order()

template<class Scalar >
int Tempus::InterpolatorLagrange< Scalar >::order ( ) const
inlinevirtual

Return the order of the interpolation.

Implements Tempus::Interpolator< Scalar >.

Definition at line 42 of file Tempus_InterpolatorLagrange_decl.hpp.

◆ description()

template<class Scalar >
std::string Tempus::InterpolatorLagrange< Scalar >::description ( ) const
inline

Definition at line 48 of file Tempus_InterpolatorLagrange_decl.hpp.

◆ describe()

template<class Scalar >
void Tempus::InterpolatorLagrange< Scalar >::describe ( Teuchos::FancyOStream & out,
const Teuchos::EVerbosityLevel  ) const
inline

Definition at line 49 of file Tempus_InterpolatorLagrange_decl.hpp.

◆ setParameterList()

template<class Scalar >
void Tempus::InterpolatorLagrange< Scalar >::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > & paramList)

Definition at line 33 of file Tempus_InterpolatorLagrange_impl.hpp.

◆ getNonconstParameterList()

template<class Scalar >
Teuchos::RCP< Teuchos::ParameterList > Tempus::InterpolatorLagrange< Scalar >::getNonconstParameterList ( )

Definition at line 47 of file Tempus_InterpolatorLagrange_impl.hpp.

◆ unsetParameterList()

template<class Scalar >
Teuchos::RCP< Teuchos::ParameterList > Tempus::InterpolatorLagrange< Scalar >::unsetParameterList ( )

Definition at line 55 of file Tempus_InterpolatorLagrange_impl.hpp.

◆ getValidParameters()

template<class Scalar >
Teuchos::RCP< const Teuchos::ParameterList > Tempus::InterpolatorLagrange< Scalar >::getValidParameters ( ) const

Definition at line 65 of file Tempus_InterpolatorLagrange_impl.hpp.

◆ lagrange()

template<class Scalar >
void Tempus::InterpolatorLagrange< Scalar >::lagrange ( const int p,
const Scalar & t,
SolutionState< Scalar > * state_out ) const
private

Definition at line 76 of file Tempus_InterpolatorLagrange_impl.hpp.

Member Data Documentation

◆ nodes_

template<class Scalar >
Teuchos::RCP<const std::vector<Teuchos::RCP<SolutionState<Scalar> > > > Tempus::InterpolatorLagrange< Scalar >::nodes_
private

Definition at line 70 of file Tempus_InterpolatorLagrange_decl.hpp.

◆ pl_

template<class Scalar >
Teuchos::RCP<Teuchos::ParameterList> Tempus::InterpolatorLagrange< Scalar >::pl_
private

Definition at line 71 of file Tempus_InterpolatorLagrange_decl.hpp.

◆ order_

template<class Scalar >
int Tempus::InterpolatorLagrange< Scalar >::order_
private

Definition at line 72 of file Tempus_InterpolatorLagrange_decl.hpp.


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