Stokhos Development
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type > Class Template Reference

Multivariate orthogonal polynomial basis generated from a total order tensor product of univariate polynomials. More...

#include <Stokhos_TotalOrderBasis.hpp>

Inheritance diagram for Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >:
Inheritance graph
[legend]
Collaboration diagram for Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >:
Collaboration graph
[legend]

Public Member Functions

 TotalOrderBasis (const Teuchos::Array< Teuchos::RCP< const OneDOrthogPolyBasis< ordinal_type, value_type > > > &bases, const value_type &sparse_tol=1.0e-12, const coeff_compare_type &coeff_compare=coeff_compare_type())
 Constructor.
virtual ~TotalOrderBasis ()
 Destructor.
Implementation of Stokhos::OrthogPolyBasis methods
ordinal_type order () const
 Return order of basis.
ordinal_type dimension () const
 Return dimension of basis.
virtual ordinal_type size () const
 Return total size of basis.
virtual const Teuchos::Array< value_type > & norm_squared () const
 Return array storing norm-squared of each basis polynomial.
virtual const value_type & norm_squared (ordinal_type i) const
 Return norm squared of basis polynomial i.
virtual Teuchos::RCP< Stokhos::Sparse3Tensor< ordinal_type, value_type > > computeTripleProductTensor () const
 Compute triple product tensor.
virtual Teuchos::RCP< Stokhos::Sparse3Tensor< ordinal_type, value_type > > computeLinearTripleProductTensor () const
 Compute linear triple product tensor where k = 0,1,..,d.
virtual value_type evaluateZero (ordinal_type i) const
 Evaluate basis polynomial i at zero.
virtual void evaluateBases (const Teuchos::ArrayView< const value_type > &point, Teuchos::Array< value_type > &basis_vals) const
 Evaluate basis polynomials at given point point.
virtual void print (std::ostream &os) const
 Print basis to stream os.
virtual const std::string & getName () const
 Return string name of basis.
Public Member Functions inherited from Stokhos::ProductBasis< ordinal_type, value_type >
 ProductBasis ()
 Constructor.
virtual ~ProductBasis ()
 Destructor.
Public Member Functions inherited from Stokhos::OrthogPolyBasis< ordinal_type, value_type >
 OrthogPolyBasis ()
 Constructor.
virtual ~OrthogPolyBasis ()
 Destructor.

Implementation of Stokhos::ProductBasis methods

typedef MultiIndex< ordinal_type > coeff_type
typedef std::map< coeff_type, ordinal_type, coeff_compare_type > coeff_set_type
typedef Teuchos::Array< coeff_type > coeff_map_type
std::string name
 Name of basis.
ordinal_type p
 Total order of basis.
ordinal_type d
 Total dimension of basis.
ordinal_type sz
 Total size of basis.
Teuchos::Array< Teuchos::RCP< const OneDOrthogPolyBasis< ordinal_type, value_type > > > bases
 Array of bases.
value_type sparse_tol
 Tolerance for computing sparse Cijk.
coeff_type max_orders
 Maximum orders for each dimension.
coeff_set_type basis_set
 Basis set.
coeff_map_type basis_map
 Basis map.
Teuchos::Array< value_type > norms
 Norms.
Teuchos::Array< Teuchos::Array< value_type > > basis_eval_tmp
 Temporary array used in basis evaluation.
virtual const MultiIndex< ordinal_type > & term (ordinal_type i) const
 Get orders of each coordinate polynomial given an index i.
virtual ordinal_type index (const MultiIndex< ordinal_type > &term) const
 Get index of the multivariate polynomial given orders of each coordinate.
Teuchos::Array< Teuchos::RCP< const OneDOrthogPolyBasis< ordinal_type, value_type > > > getCoordinateBases () const
 Return coordinate bases.
virtual MultiIndex< ordinal_type > getMaxOrders () const
 Return maximum order allowable for each coordinate basis.

Detailed Description

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>
class Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >

Multivariate orthogonal polynomial basis generated from a total order tensor product of univariate polynomials.

The multivariate polynomials are given by

\‍[ \Psi_i(x) = \psi_{i_1}(x_1)\dots\psi_{i_d}(x_d) \‍]

where $d$ is the dimension of the basis and $i_j\leq p_j$, where $p_j$ is the order of the $j$th basis.

Constructor & Destructor Documentation

◆ TotalOrderBasis()

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>
Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::TotalOrderBasis ( const Teuchos::Array< Teuchos::RCP< const OneDOrthogPolyBasis< ordinal_type, value_type > > > & bases,
const value_type & sparse_tol = 1.0e-12,
const coeff_compare_type & coeff_compare = coeff_compare_type() )

Constructor.

Parameters
basesarray of 1-D coordinate bases
sparse_toltolerance used to drop terms in sparse triple-product tensors

References bases, sparse_tol, term(), and TotalOrderBasis().

Referenced by TotalOrderBasis().

Member Function Documentation

◆ computeLinearTripleProductTensor()

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

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

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References bases, basis_map, basis_set, max_orders, p, and sparse_tol.

◆ computeTripleProductTensor()

template<typename ordinal_type, typename value_type, typename ordering_type>
Teuchos::RCP< Stokhos::Sparse3Tensor< ordinal_type, value_type > > Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::computeTripleProductTensor ( ) const
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.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References bases, basis_map, basis_set, max_orders, p, and sparse_tol.

◆ dimension()

template<typename ordinal_type, typename value_type, typename ordering_type>
ordinal_type Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::dimension ( ) const
virtual

Return dimension of basis.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References d.

◆ evaluateBases()

template<typename ordinal_type, typename value_type, typename ordering_type>
void Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::evaluateBases ( const Teuchos::ArrayView< const value_type > & point,
Teuchos::Array< value_type > & basis_vals ) const
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.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References bases, basis_eval_tmp, basis_map, d, evaluateBases(), and sz.

Referenced by evaluateBases().

◆ evaluateZero()

template<typename ordinal_type, typename value_type, typename ordering_type>
value_type Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::evaluateZero ( ordinal_type i) const
virtual

Evaluate basis polynomial i at zero.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References bases, basis_map, and d.

◆ getCoordinateBases()

template<typename ordinal_type, typename value_type, typename ordering_type>
Teuchos::Array< Teuchos::RCP< const Stokhos::OneDOrthogPolyBasis< ordinal_type, value_type > > > Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::getCoordinateBases ( ) const
virtual

Return coordinate bases.

Array is of size dimension().

Implements Stokhos::ProductBasis< ordinal_type, value_type >.

References bases.

◆ getMaxOrders()

template<typename ordinal_type, typename value_type, typename ordering_type>
Stokhos::MultiIndex< ordinal_type > Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::getMaxOrders ( ) const
virtual

Return maximum order allowable for each coordinate basis.

Implements Stokhos::ProductBasis< ordinal_type, value_type >.

References max_orders.

◆ getName()

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

Return string name of basis.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References name.

◆ index()

template<typename ordinal_type, typename value_type, typename ordering_type>
ordinal_type Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::index ( const MultiIndex< ordinal_type > & term) const
virtual

Get index of the multivariate polynomial given orders of each coordinate.

Given the array term storing $i_1,\dots,\i_d$, returns the index $i$ such that $\Psi_i(x) = \psi_{i_1}(x_1)\dots\psi_{i_d}(x_d)$.

Implements Stokhos::ProductBasis< ordinal_type, value_type >.

References basis_set, and term().

◆ norm_squared() [1/2]

template<typename ordinal_type, typename value_type, typename ordering_type>
const Teuchos::Array< value_type > & Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::norm_squared ( ) const
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.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References norms.

◆ norm_squared() [2/2]

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

Return norm squared of basis polynomial i.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References norms.

◆ order()

template<typename ordinal_type, typename value_type, typename ordering_type>
ordinal_type Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::order ( ) const
virtual

Return order of basis.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References p.

◆ print()

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

Print basis to stream os.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References bases, d, norms, p, and sz.

◆ size()

template<typename ordinal_type, typename value_type, typename ordering_type>
ordinal_type Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::size ( ) const
virtual

Return total size of basis.

Implements Stokhos::OrthogPolyBasis< ordinal_type, value_type >.

References sz.

◆ term()

template<typename ordinal_type, typename value_type, typename ordering_type>
const Stokhos::MultiIndex< ordinal_type > & Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::term ( ordinal_type i) const
virtual

Get orders of each coordinate polynomial given an index i.

The returned array is of size $d$, where $d$ is the dimension of the basis, and entry $l$ is given by $i_l$ where $\Psi_i(x) = \psi_{i_1}(x_1)\dots\psi_{i_d}(x_d)$.

Implements Stokhos::ProductBasis< ordinal_type, value_type >.

References basis_map.

Referenced by index(), and TotalOrderBasis().

The documentation for this class was generated from the following files:
Generated on for Stokhos by doxygen 1.15.0