Rys polynomial basis. More...

#include <Stokhos_RysBasis.hpp>

Inheritance diagram for Stokhos::RysBasis< ordinal_type, value_type >:

Collaboration diagram for Stokhos::RysBasis< ordinal_type, value_type >:

Public Member Functions
	RysBasis (ordinal_type p, value_type c, bool normalize, GrowthPolicy growth=SLOW_GROWTH)
	Constructor. More...

	~RysBasis ()
	Destructor.

virtual Teuchos::RCP < OneDOrthogPolyBasis < ordinal_type, value_type > >	cloneWithOrder (ordinal_type p) const
	Clone this object with the option of building a higher order basis. More...

Public Member Functions inherited from Stokhos::DiscretizedStieltjesBasis< ordinal_type, value_type >
	DiscretizedStieltjesBasis (const std::string &name, const ordinal_type &p, value_type(*weightFn)(const value_type &), const value_type &leftEndPt, const value_type &rightEndPt, bool normalize, GrowthPolicy growth=SLOW_GROWTH)
	Constructor. More...

	~DiscretizedStieltjesBasis ()
	Destructor.

value_type	eval_inner_product (const ordinal_type &order1, const ordinal_type &order2) const
	Evaluate inner product of two basis functions to test orthogonality.

Public Member Functions inherited from Stokhos::RecurrenceBasis< ordinal_type, value_type >
virtual	~RecurrenceBasis ()
	Destructor.

virtual void	getRecurrenceCoefficients (Teuchos::Array< value_type > &alpha, Teuchos::Array< value_type > &beta, Teuchos::Array< value_type > &delta, Teuchos::Array< value_type > &gamma) const
	Return recurrence coefficients defined by above formula.

virtual void	evaluateBasesAndDerivatives (const value_type &point, Teuchos::Array< value_type > &vals, Teuchos::Array< value_type > &derivs) const
	Evaluate basis polynomials and their derivatives at given point `point`.

virtual void	setQuadZeroTol (value_type tol)
	Set tolerance for zero in quad point generation.

virtual ordinal_type	order () const
	Return order of basis (largest monomial degree ).

virtual ordinal_type	size () const
	Return total size of basis (given by order() + 1).

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

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

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

virtual Teuchos::RCP < Teuchos::SerialDenseMatrix < ordinal_type, value_type > >	computeDerivDoubleProductTensor () const
	Compute derivative double product tensor. More...

virtual void	evaluateBases (const value_type &point, Teuchos::Array< value_type > &basis_pts) const
	Evaluate each basis polynomial at given point `point`. More...

virtual value_type	evaluate (const value_type &point, ordinal_type order) const
	Evaluate basis polynomial given by order `order` 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.

virtual void	getQuadPoints (ordinal_type quad_order, Teuchos::Array< value_type > &points, Teuchos::Array< value_type > &weights, Teuchos::Array< Teuchos::Array< value_type > > &values) const
	Compute quadrature points, weights, and values of basis polynomials at given set of points `points`. More...

virtual ordinal_type	quadDegreeOfExactness (ordinal_type n) const

virtual ordinal_type	coefficientGrowth (ordinal_type n) const
	Evaluate coefficient growth rule for Smolyak-type bases.

virtual ordinal_type	pointGrowth (ordinal_type n) const
	Evaluate point growth rule for Smolyak-type bases.

virtual LevelToOrderFnPtr	getSparseGridGrowthRule () const
	Get sparse grid level_to_order mapping function. More...

virtual void	setSparseGridGrowthRule (LevelToOrderFnPtr ptr)
	Set sparse grid rule.

Public Member Functions inherited from Stokhos::OneDOrthogPolyBasis< ordinal_type, value_type >
	OneDOrthogPolyBasis ()
	Default constructor.

virtual	~OneDOrthogPolyBasis ()
	Destructor.

virtual void	setSparseGridGrowthRule (LevelToOrderFnPtr ptr)=0
	Set sparse grid rule.

Static Public Member Functions
static value_type	rysWeight (const value_type &x)
	The Rys weight function.

Protected Member Functions
	RysBasis (ordinal_type p, const RysBasis &basis)
	Copy constructor with specified order.

Protected Member Functions inherited from Stokhos::DiscretizedStieltjesBasis< ordinal_type, value_type >
value_type	evaluateRecurrence (const value_type &point, ordinal_type order, const Teuchos::Array< value_type > &alpha, const Teuchos::Array< value_type > &beta) const
	Evaluate 3-term recurrence formula using supplied coefficients.

value_type	evaluateWeight (const value_type &x) const
	Evaluates the scaled weight function.

value_type	expectedValue_tJ_nsquared (const ordinal_type &order, const Teuchos::Array< value_type > &alpha, const Teuchos::Array< value_type > &beta) const
	Approximates $\langle t\psi_k(t) \rangle$ where = `order`.

value_type	expectedValue_J_nsquared (const ordinal_type &order, const Teuchos::Array< value_type > &alpha, const Teuchos::Array< value_type > &beta) const
	Approximates $\langle \psi_k(t) \rangle$ where = `order`.

	DiscretizedStieltjesBasis (const ordinal_type &p, const DiscretizedStieltjesBasis &basis)
	Copy constructor with specified order.

virtual bool	computeRecurrenceCoefficients (ordinal_type n, Teuchos::Array< value_type > &alpha, Teuchos::Array< value_type > &beta, Teuchos::Array< value_type > &delta, Teuchos::Array< value_type > &gamma) const
	Compute recurrence coefficients.

Protected Member Functions inherited from Stokhos::RecurrenceBasis< ordinal_type, value_type >
	RecurrenceBasis (const std::string &name, ordinal_type p, bool normalize, GrowthPolicy growth=SLOW_GROWTH)
	Constructor to be called by derived classes. More...

	RecurrenceBasis (ordinal_type p, const RecurrenceBasis &basis)
	Copy constructor with specified order.

virtual void	setup ()
	Setup basis after computing recurrence coefficients. More...

void	normalizeRecurrenceCoefficients (Teuchos::Array< value_type > &alpha, Teuchos::Array< value_type > &beta, Teuchos::Array< value_type > &delta, Teuchos::Array< value_type > &gamma) const
	Normalize coefficients.

Additional Inherited Members
Public Types inherited from Stokhos::RecurrenceBasis< ordinal_type, value_type >
typedef OneDOrthogPolyBasis < ordinal_type, value_type > ::LevelToOrderFnPtr	LevelToOrderFnPtr
	Function pointer needed for level_to_order mappings.

Public Types inherited from Stokhos::OneDOrthogPolyBasis< ordinal_type, value_type >
typedef int(*	LevelToOrderFnPtr )(int level, int growth)
	Function pointer needed for level_to_order mappings.

Protected Attributes inherited from Stokhos::DiscretizedStieltjesBasis< ordinal_type, value_type >
value_type	scaleFactor
	Scale for the weight.

const value_type	leftEndPt_
	Left end point of domain.

const value_type	rightEndPt_
	Right end point of domain.

value_type(*	weightFn_ )(const value_type &)
	Weight function.

Teuchos::Array< value_type >	quad_points
	Quadrature points for discretized stieltjes procedure.

Teuchos::Array< value_type >	quad_weights
	Quadrature points for discretized stieltjes procedure.

Teuchos::Array< Teuchos::Array < value_type > >	quad_values
	Quadrature values for discretized stieltjes procedure.

Protected Attributes inherited from Stokhos::RecurrenceBasis< ordinal_type, value_type >
std::string	name
	Name of basis.

ordinal_type	p
	Order of basis.

bool	normalize
	Normalize basis.

GrowthPolicy	growth
	Smolyak growth policy.

value_type	quad_zero_tol
	Tolerance for quadrature points near zero.

LevelToOrderFnPtr	sparse_grid_growth_rule
	Sparse grid growth rule (as determined by Pecos)

Teuchos::Array< value_type >	alpha
	Recurrence $\alpha$ coefficients.

Teuchos::Array< value_type >	beta
	Recurrence $\beta$ coefficients.

Teuchos::Array< value_type >	delta
	Recurrence $\delta$ coefficients.

Teuchos::Array< value_type >	gamma
	Recurrence $\gamma$ coefficients.

Teuchos::Array< value_type >	norms
	Norms.

Detailed Description

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

Rys polynomial basis.

Rys polynomials are polynomials orthogonal with respect to the weight function

$w(x) = e^{\frac{-x^2}{2}}$

defined on the interval $[-c,c]$ , for a given choice of $c$ . The corresponding density $\rho(x)$ is obtained by scaling $w(x)$ to unit probability.

The coefficients of the corresponding three-term recursion are generated using the Discretized Stieltjes procedure implemented by Stokhos::DiscretizedStieltjesBasis.

Constructor & Destructor Documentation

template<typename ordinal_type , typename value_type >

Stokhos::RysBasis< ordinal_type, value_type >::RysBasis	(	ordinal_type	p,
		value_type	c,
		bool	normalize,
		GrowthPolicy	growth = `SLOW_GROWTH`
	)

inline

Constructor.

Parameters

p	order of the basis
c	defines domain of support of weight function
normalize	whether polynomials should be given unit norm

Member Function Documentation

template<typename ordinal_type , typename value_type >

virtual Teuchos::RCP<OneDOrthogPolyBasis<ordinal_type,value_type> > Stokhos::RysBasis< ordinal_type, value_type >::cloneWithOrder ( ordinal_type p ) const

inlinevirtual

Clone this object with the option of building a higher order basis.

This method is following the Prototype pattern (see Design Pattern's textbook). The slight variation is that it allows the order of the polynomial to be modified, otherwise an exact copy is formed. The use case for this is creating basis functions for column indices in a spatially varying adaptive refinement context.

Reimplemented from Stokhos::DiscretizedStieltjesBasis< ordinal_type, value_type >.

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

Stokhos_RysBasis.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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