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

Generates three-term recurrence using the Discretized Stieltjes procedure applied to a functional mapping another basis. More...

#include <Stokhos_StieltjesBasis.hpp>

Inheritance diagram for Stokhos::StieltjesBasis< ordinal_type, value_type, func_type >:
Inheritance graph
[legend]
Collaboration diagram for Stokhos::StieltjesBasis< ordinal_type, value_type, func_type >:
Collaboration graph
[legend]

Public Member Functions

 StieltjesBasis (ordinal_type p, const Teuchos::RCP< const func_type > &func, const Teuchos::RCP< const Stokhos::Quadrature< ordinal_type, value_type > > &quad, bool use_pce_quad_points, bool normalize=false)
 Constructor.
 
 ~StieltjesBasis ()
 Destructor.
 
Implementation of Stokhos::OneDOrthogPolyBasis methods
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
 Get Gauss quadrature points, weights, and values of basis at points.
 
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.
 
- Public Member Functions inherited from Stokhos::RecurrenceBasis< ordinal_type, value_type >
virtual ~RecurrenceBasis ()
 Destructor.
 
virtual ordinal_type order () const
 Return order of basis (largest monomial degree $P$).
 
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.
 
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.
 
virtual Teuchos::RCP< Stokhos::Sparse3Tensor< ordinal_type, value_type > > computeSparseTripleProductTensor (ordinal_type order) const
 Compute triple product tensor.
 
virtual Teuchos::RCP< Teuchos::SerialDenseMatrix< ordinal_type, value_type > > computeDerivDoubleProductTensor () const
 Compute derivative double product tensor.
 
virtual void evaluateBases (const value_type &point, Teuchos::Array< value_type > &basis_pts) const
 Evaluate each basis polynomial at given point point.
 
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 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.
 
virtual void setSparseGridGrowthRule (LevelToOrderFnPtr ptr)
 Set sparse grid rule.
 
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.
 
- Public Member Functions inherited from Stokhos::OneDOrthogPolyBasis< ordinal_type, value_type >
 OneDOrthogPolyBasis ()
 Default constructor.
 
virtual ~OneDOrthogPolyBasis ()
 Destructor.
 
virtual ordinal_type order () const =0
 Return order of basis (largest monomial degree $P$).
 
virtual ordinal_type size () const =0
 Return total size of basis (given by order() + 1).
 
virtual const Teuchos::Array< value_type > & norm_squared () const =0
 Return array storing norm-squared of each basis polynomial.
 
virtual const value_type & norm_squared (ordinal_type i) const =0
 Return norm squared of basis polynomial i.
 
virtual Teuchos::RCP< Stokhos::Dense3Tensor< ordinal_type, value_type > > computeTripleProductTensor () const =0
 Compute triple product tensor.
 
virtual Teuchos::RCP< Stokhos::Sparse3Tensor< ordinal_type, value_type > > computeSparseTripleProductTensor (ordinal_type order) const =0
 Compute triple product tensor.
 
virtual Teuchos::RCP< Teuchos::SerialDenseMatrix< ordinal_type, value_type > > computeDerivDoubleProductTensor () const =0
 Compute derivative double product tensor.
 
virtual void evaluateBases (const value_type &point, Teuchos::Array< value_type > &basis_pts) const =0
 Evaluate each basis polynomial at given point point.
 
virtual value_type evaluate (const value_type &point, ordinal_type order) const =0
 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 =0
 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 =0
 Compute quadrature points, weights, and values of basis polynomials at given set of points points.
 
virtual ordinal_type quadDegreeOfExactness (ordinal_type n) const =0
 
virtual Teuchos::RCP< OneDOrthogPolyBasis< ordinal_type, value_type > > cloneWithOrder (ordinal_type p) const =0
 Clone this object with the option of building a higher order basis.
 
virtual ordinal_type coefficientGrowth (ordinal_type n) const =0
 Evaluate coefficient growth rule for Smolyak-type bases.
 
virtual ordinal_type pointGrowth (ordinal_type n) const =0
 Evaluate point growth rule for Smolyak-type bases.
 
virtual LevelToOrderFnPtr getSparseGridGrowthRule () const =0
 Get sparse grid level_to_order mapping function.
 
virtual void setSparseGridGrowthRule (LevelToOrderFnPtr ptr)=0
 Set sparse grid rule.
 

Implementation of Stokhos::RecurrenceBasis methods

Teuchos::RCP< const func_type > func
 PC expansion.
 
Teuchos::RCP< const Stokhos::Quadrature< ordinal_type, value_type > > quad
 Quadrature object.
 
const Teuchos::Array< value_type > & pce_weights
 PCE quadrature weights.
 
const Teuchos::Array< Teuchos::Array< value_type > > & basis_values
 Values of PCE basis functions at quadrature points.
 
Teuchos::Array< value_type > func_vals
 Values of func at quadrature points.
 
Teuchos::Array< Teuchos::Array< value_type > > phi_vals
 Values of generated polynomials at PCE quadrature points.
 
bool use_pce_quad_points
 Use underlying pce's quadrature data.
 
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.
 
virtual void setup ()
 Setup basis after computing recurrence coefficients.
 
void stieltjes (ordinal_type nstart, ordinal_type nfinish, const Teuchos::Array< value_type > &weights, const Teuchos::Array< value_type > &points, Teuchos::Array< value_type > &a, Teuchos::Array< value_type > &b, Teuchos::Array< value_type > &nrm, Teuchos::Array< Teuchos::Array< value_type > > &phi_vals) const
 Compute 3-term recurrence using Stieljtes procedure.
 
void integrateBasisSquared (ordinal_type k, const Teuchos::Array< value_type > &a, const Teuchos::Array< value_type > &b, const Teuchos::Array< value_type > &weights, const Teuchos::Array< value_type > &points, Teuchos::Array< Teuchos::Array< value_type > > &phi_vals, value_type &val1, value_type &val2) const
 Compute $\int\psi^2_k(t) d\lambda(t)$ and $\int t\psi^2_k(t) d\lambda(t)$.
 
void evaluateRecurrence (ordinal_type k, const Teuchos::Array< value_type > &a, const Teuchos::Array< value_type > &b, const Teuchos::Array< value_type > &points, Teuchos::Array< Teuchos::Array< value_type > > &values) const
 Evaluate polynomials via 3-term recurrence.
 
 StieltjesBasis (ordinal_type p, const StieltjesBasis &basis)
 Copy constructor with specified order.
 

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 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.
 
 RecurrenceBasis (ordinal_type p, const RecurrenceBasis &basis)
 Copy constructor with specified order.
 
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.
 
- 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, typename func_type>
class Stokhos::StieltjesBasis< ordinal_type, value_type, func_type >

Generates three-term recurrence using the Discretized Stieltjes procedure applied to a functional mapping another basis.

Constructor & Destructor Documentation

◆ StieltjesBasis()

template<typename ordinal_type , typename value_type , typename func_type >
Stokhos::StieltjesBasis< ordinal_type, value_type, func_type >::StieltjesBasis ( ordinal_type  p,
const Teuchos::RCP< const func_type > &  func,
const Teuchos::RCP< const Stokhos::Quadrature< ordinal_type, value_type > > &  quad,
bool  use_pce_quad_points,
bool  normalize = false 
)

Constructor.

Parameters
porder of the basis
funcmapping defining new density function
quadquadrature data for basis of PC expansion
use_pce_quad_pointswhether to use quad to define quadrature points for the new basis, or whether to use the Golub-Welsch system.
normalizewhether polynomials should be given unit norm

References Stokhos::StieltjesBasis< ordinal_type, value_type, func_type >::setup().

Member Function Documentation

◆ cloneWithOrder()

template<typename ordinal_type , typename value_type , typename func_type >
Teuchos::RCP< Stokhos::OneDOrthogPolyBasis< ordinal_type, value_type > > Stokhos::StieltjesBasis< ordinal_type, value_type, func_type >::cloneWithOrder ( ordinal_type  p) const
virtual

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.

Implements Stokhos::OneDOrthogPolyBasis< ordinal_type, value_type >.

◆ computeRecurrenceCoefficients()

template<typename ordinal_type , typename value_type , typename func_type >
bool Stokhos::StieltjesBasis< ordinal_type, value_type, func_type >::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
protectedvirtual

Compute recurrence coefficients.

Implements Stokhos::RecurrenceBasis< ordinal_type, value_type >.

◆ getQuadPoints()

template<typename ordinal_type , typename value_type , typename func_type >
void Stokhos::StieltjesBasis< ordinal_type, value_type, func_type >::getQuadPoints ( ordinal_type  quad_order,
Teuchos::Array< value_type > &  points,
Teuchos::Array< value_type > &  weights,
Teuchos::Array< Teuchos::Array< value_type > > &  values 
) const
virtual

Get Gauss quadrature points, weights, and values of basis at points.

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

References Stokhos::RecurrenceBasis< ordinal_type, value_type >::getQuadPoints().

◆ setup()

template<typename ordinal_type , typename value_type , typename func_type >
void Stokhos::StieltjesBasis< ordinal_type, value_type, func_type >::setup
protectedvirtual

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