Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | List of all members
Stokhos::OrthogPolyBasis< ordinal_type, value_type > Class Template Referenceabstract

Abstract base class for multivariate orthogonal polynomials. More...

#include <Stokhos_OrthogPolyBasis.hpp>

Inheritance diagram for Stokhos::OrthogPolyBasis< ordinal_type, value_type >:
Inheritance graph
[legend]

Public Member Functions

 OrthogPolyBasis ()
 Constructor. More...
 
virtual ~OrthogPolyBasis ()
 Destructor. More...
 
virtual ordinal_type order () const =0
 Return order of basis. More...
 
virtual ordinal_type dimension () const =0
 Return dimension of basis. More...
 
virtual ordinal_type size () const =0
 Return total size of basis. More...
 
virtual const Teuchos::Array
< value_type > & 		norm_squared () const =0
 Return array storing norm-squared of each basis polynomial. More...
 
virtual const value_type & norm_squared (ordinal_type i) const =0
 Return norm squared of basis polynomial i. More...
 
virtual Teuchos::RCP
< Stokhos::Sparse3Tensor
< ordinal_type, value_type > > 		computeTripleProductTensor () const =0
 Compute triple product tensor. More...
 
virtual Teuchos::RCP
< Stokhos::Sparse3Tensor
< ordinal_type, value_type > > 		computeLinearTripleProductTensor () const =0
 Compute linear triple product tensor where k = 0,1. More...
 
virtual value_type evaluateZero (ordinal_type i) const =0
 Evaluate basis polynomial i at zero. More...
 
virtual void evaluateBases (const Teuchos::ArrayView< const value_type > &point, Teuchos::Array< value_type > &basis_vals) const =0
 Evaluate basis polynomials at given point point. More...
 
virtual void print (std::ostream &os) const =0
 Print basis to stream os. More...
 
virtual const std::string & getName () const =0
 Return string name of basis. More...
 

Private Member Functions

 OrthogPolyBasis (const OrthogPolyBasis &)
 
OrthogPolyBasis & operator= (const OrthogPolyBasis &b)
 

Detailed Description

template<typename ordinal_type, typename value_type>
class Stokhos::OrthogPolyBasis< ordinal_type, value_type >

Abstract base class for multivariate orthogonal polynomials.

This class provides an abstract interface for multivariate orthogonal polynomials. Orthogonality is defined by the inner product

\[ (f,g) = \langle fg \rangle = \int_{R^d} f(x)g(x) \rho(x) dx \]

where $\rho$ is the density function of the measure associated with the orthogonal polynomials and $d$ is the dimension of the domain.

Like most classes in Stokhos, the class is templated on the ordinal and value types. Typically ordinal_type = int and value_type = double.

Definition at line 74 of file Stokhos_OrthogPolyBasis.hpp.

Constructor & Destructor Documentation

template<typename ordinal_type, typename value_type>
Stokhos::OrthogPolyBasis< ordinal_type, value_type >::OrthogPolyBasis ( )
inline

Constructor.

Definition at line 78 of file Stokhos_OrthogPolyBasis.hpp.

template<typename ordinal_type, typename value_type>
virtual Stokhos::OrthogPolyBasis< ordinal_type, value_type >::~OrthogPolyBasis ( )
inlinevirtual

Destructor.

Definition at line 81 of file Stokhos_OrthogPolyBasis.hpp.

template<typename ordinal_type, typename value_type>
Stokhos::OrthogPolyBasis< ordinal_type, value_type >::OrthogPolyBasis ( const OrthogPolyBasis< ordinal_type, value_type > &  )
private

Member Function Documentation

template<typename ordinal_type, typename value_type>
virtual ordinal_type Stokhos::OrthogPolyBasis< ordinal_type, value_type >::order ( ) const
pure virtual

Return order of basis.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual ordinal_type Stokhos::OrthogPolyBasis< ordinal_type, value_type >::dimension ( ) const
pure virtual

Return dimension of basis.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual ordinal_type Stokhos::OrthogPolyBasis< ordinal_type, value_type >::size ( ) const
pure virtual

Return total size of basis.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual const Teuchos::Array<value_type>& Stokhos::OrthogPolyBasis< ordinal_type, value_type >::norm_squared ( ) const
pure virtual

Return array storing norm-squared of each basis polynomial.

Entry $l$ of returned array is given by $\langle\Psi_l^2\rangle$ for $l=0,\dots,P$ where $P$ is size()-1.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual const value_type& Stokhos::OrthogPolyBasis< ordinal_type, value_type >::norm_squared ( ordinal_type  i) const
pure virtual

Return norm squared of basis polynomial i.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual Teuchos::RCP< Stokhos::Sparse3Tensor<ordinal_type, value_type> > Stokhos::OrthogPolyBasis< ordinal_type, value_type >::computeTripleProductTensor ( ) const
pure virtual

Compute triple product tensor.

The $(i,j,k)$ entry of the tensor $C_{ijk}$ is given by $C_{ijk} = \langle\Psi_i\Psi_j\Psi_k\rangle$ where $\Psi_l$ represents basis polynomial $l$ and $i,j,k=0,\dots,P$ where $P$ is size()-1.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual Teuchos::RCP< Stokhos::Sparse3Tensor<ordinal_type, value_type> > Stokhos::OrthogPolyBasis< ordinal_type, value_type >::computeLinearTripleProductTensor ( ) const
pure virtual

Compute linear triple product tensor where k = 0,1.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual value_type Stokhos::OrthogPolyBasis< ordinal_type, value_type >::evaluateZero ( ordinal_type  i) const
pure virtual

Evaluate basis polynomial i at zero.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual void Stokhos::OrthogPolyBasis< ordinal_type, value_type >::evaluateBases ( const Teuchos::ArrayView< const value_type > &  point,
Teuchos::Array< value_type > &  basis_vals 
) const
pure virtual

Evaluate basis polynomials at given point point.

Size of returned array is given by size(), and coefficients are ordered from order 0 up to size size()-1.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual void Stokhos::OrthogPolyBasis< ordinal_type, value_type >::print ( std::ostream &  os) const
pure virtual

Print basis to stream os.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::GSReducedPCEBasisBase< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, and Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >.

template<typename ordinal_type, typename value_type>
virtual const std::string& Stokhos::OrthogPolyBasis< ordinal_type, value_type >::getName ( ) const
pure virtual

Return string name of basis.

Implemented in Stokhos::CompletePolynomialBasis< ordinal_type, value_type >, Stokhos::CompletePolynomialBasis< OrdinalType, ValueType >, Stokhos::CompletePolynomialBasis< int, double >, Stokhos::ProductLanczosPCEBasis< ordinal_type, value_type >, Stokhos::ProductLanczosGramSchmidtPCEBasis< ordinal_type, value_type >, Stokhos::TensorProductBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::MonomialProjGramSchmidtPCEBasis2< ordinal_type, value_type >, Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::SmolyakBasis< ordinal_type, value_type, coeff_compare_type >, Stokhos::MonomialGramSchmidtPCEBasis< ordinal_type, value_type >, and Stokhos::MonomialProjGramSchmidtPCEBasis< ordinal_type, value_type >.

template<typename ordinal_type, typename value_type>
OrthogPolyBasis& Stokhos::OrthogPolyBasis< ordinal_type, value_type >::operator= ( const OrthogPolyBasis< ordinal_type, value_type > &  b)
private
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5