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 >:

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. More...

virtual	~TotalOrderBasis ()
	Destructor. More...

Public Member Functions inherited from Stokhos::ProductBasis< ordinal_type, value_type >
	ProductBasis ()
	Constructor. More...

virtual	~ProductBasis ()
	Destructor. More...

Public Member Functions inherited from Stokhos::OrthogPolyBasis< ordinal_type, value_type >
	OrthogPolyBasis ()
	Constructor. More...

virtual	~OrthogPolyBasis ()
	Destructor. More...

Protected Types
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

Protected Attributes
std::string	name
	Name of basis. More...

ordinal_type	p
	Total order of basis. More...

ordinal_type	d
	Total dimension of basis. More...

ordinal_type	sz
	Total size of basis. More...

Teuchos::Array< Teuchos::RCP < const OneDOrthogPolyBasis < ordinal_type, value_type > > >	bases
	Array of bases. More...

value_type	sparse_tol
	Tolerance for computing sparse Cijk. More...

coeff_type	max_orders
	Maximum orders for each dimension. More...

coeff_set_type	basis_set
	Basis set. More...

coeff_map_type	basis_map
	Basis map. More...

Teuchos::Array< value_type >	norms
	Norms. More...

Teuchos::Array< Teuchos::Array < value_type > >	basis_eval_tmp
	Temporary array used in basis evaluation. More...

Private Member Functions
	TotalOrderBasis (const TotalOrderBasis &)

TotalOrderBasis &	operator= (const TotalOrderBasis &b)

Implementation of Stokhos::OrthogPolyBasis methods
ordinal_type	order () const
	Return order of basis. More...

ordinal_type	dimension () const
	Return dimension of basis. More...

virtual ordinal_type	size () const
	Return total size of basis. More...

virtual const Teuchos::Array < value_type > &	norm_squared () const
	Return array storing norm-squared of each basis polynomial. More...

virtual const value_type &	norm_squared (ordinal_type i) const
	Return norm squared of basis polynomial `i`. More...

virtual Teuchos::RCP < Stokhos::Sparse3Tensor < ordinal_type, value_type > >	computeTripleProductTensor () const
	Compute triple product tensor. More...

virtual Teuchos::RCP < Stokhos::Sparse3Tensor < ordinal_type, value_type > >	computeLinearTripleProductTensor () const
	Compute linear triple product tensor where k = 0,1,..,d. More...

virtual value_type	evaluateZero (ordinal_type i) const
	Evaluate basis polynomial `i` at zero. More...

virtual void	evaluateBases (const Teuchos::ArrayView< const value_type > &point, Teuchos::Array< value_type > &basis_vals) const
	Evaluate basis polynomials at given point `point`. More...

virtual void	print (std::ostream &os) const
	Print basis to stream `os`. More...

virtual const std::string &	getName () const
	Return string name of basis. More...

Implementation of Stokhos::ProductBasis methods
virtual const MultiIndex < ordinal_type > &	term (ordinal_type i) const
	Get orders of each coordinate polynomial given an index `i`. More...

virtual ordinal_type	index (const MultiIndex< ordinal_type > &term) const
	Get index of the multivariate polynomial given orders of each coordinate. More...

Teuchos::Array< Teuchos::RCP < const OneDOrthogPolyBasis < ordinal_type, value_type > > >	getCoordinateBases () const
	Return coordinate bases. More...

virtual MultiIndex< ordinal_type >	getMaxOrders () const
	Return maximum order allowable for each coordinate basis. More...

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.

Definition at line 36 of file Stokhos_TotalOrderBasis.hpp.

Member Typedef Documentation

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

typedef MultiIndex<ordinal_type> Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::coeff_type

protected

Definition at line 154 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

typedef std::map<coeff_type,ordinal_type,coeff_compare_type> Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::coeff_set_type

protected

Definition at line 155 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

typedef Teuchos::Array<coeff_type> Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::coeff_map_type

protected

Definition at line 156 of file Stokhos_TotalOrderBasis.hpp.

Constructor & Destructor Documentation

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

bases	array of 1-D coordinate bases
sparse_tol	tolerance used to drop terms in sparse triple-product tensors

template<typename ordinal_type , typename value_type , typename ordering_type >

Stokhos::TotalOrderBasis< ordinal_type, value_type, ordering_type >::~TotalOrderBasis ( )

virtual

Destructor.

Definition at line 68 of file Stokhos_TotalOrderBasisImp.hpp.

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 TotalOrderBasis< ordinal_type, value_type, coeff_compare_type > & )

private

Member Function Documentation

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 >.

Definition at line 75 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 83 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 91 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 99 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 107 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 115 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 130 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 146 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 160 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 178 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 212 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 193 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 201 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 220 of file Stokhos_TotalOrderBasisImp.hpp.

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 >.

Definition at line 228 of file Stokhos_TotalOrderBasisImp.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

TotalOrderBasis& Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::operator= ( const TotalOrderBasis< ordinal_type, value_type, coeff_compare_type > & b )

private

Member Data Documentation

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

std::string Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::name

protected

Name of basis.

Definition at line 159 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

ordinal_type Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::p

protected

Total order of basis.

Definition at line 162 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

ordinal_type Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::d

protected

Total dimension of basis.

Definition at line 165 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

ordinal_type Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::sz

protected

Total size of basis.

Definition at line 168 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

Teuchos::Array< Teuchos::RCP<const OneDOrthogPolyBasis<ordinal_type, value_type> > > Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::bases

protected

Array of bases.

Definition at line 171 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

value_type Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::sparse_tol

protected

Tolerance for computing sparse Cijk.

Definition at line 174 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

coeff_type Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::max_orders

protected

Maximum orders for each dimension.

Definition at line 177 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

coeff_set_type Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::basis_set

protected

Basis set.

Definition at line 180 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

coeff_map_type Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::basis_map

protected

Basis map.

Definition at line 183 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

Teuchos::Array<value_type> Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::norms

protected

Norms.

Definition at line 186 of file Stokhos_TotalOrderBasis.hpp.

template<typename ordinal_type, typename value_type, typename coeff_compare_type = TotalOrderLess<MultiIndex<ordinal_type> >>

Teuchos::Array< Teuchos::Array<value_type> > Stokhos::TotalOrderBasis< ordinal_type, value_type, coeff_compare_type >::basis_eval_tmp

mutableprotected

Temporary array used in basis evaluation.

Definition at line 189 of file Stokhos_TotalOrderBasis.hpp.

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

Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Implementation of Stokhos::OrthogPolyBasis methods

Implementation of Stokhos::ProductBasis methods

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 >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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 >