Stokhos Development
Public Types | Public Member Functions | Protected Attributes
Stokhos::VectorOrthogPoly< coeff_type > Class Template Reference

A container class storing an orthogonal polynomial whose coefficients are vectors, operators, or in general any type that would have an expensive copy constructor. More...

#include <Stokhos_VectorOrthogPoly.hpp>

Inheritance diagram for Stokhos::VectorOrthogPoly< coeff_type >:
Inheritance graph
[legend]
Collaboration diagram for Stokhos::VectorOrthogPoly< coeff_type >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef ProductContainer
< coeff_type >::traits_type 
traits_type
 Typename of traits.
typedef ProductContainer
< coeff_type >::value_type 
value_type
 Typename of values.
typedef ProductContainer
< coeff_type >::ordinal_type 
ordinal_type
 Typename of ordinals.

Public Member Functions

 VectorOrthogPoly ()
 Constructor with no basis.
 VectorOrthogPoly (const Teuchos::RCP< const Stokhos::OrthogPolyBasis< ordinal_type, value_type > > &basis, const Teuchos::RCP< const Epetra_BlockMap > &map)
 Create a polynomial for basis basis with empty coefficients.
 VectorOrthogPoly (const Teuchos::RCP< const Stokhos::OrthogPolyBasis< ordinal_type, value_type > > &basis, const Teuchos::RCP< const Epetra_BlockMap > &map, const typename traits_type::cloner_type &cloner)
 Create a polynomial for basis basis where each coefficient is generated through a clone operation as implemented by the traits class for the coefficient.
 VectorOrthogPoly (const VectorOrthogPoly &)
 Copy constructor.
virtual ~VectorOrthogPoly ()
 Destructor.
VectorOrthogPolyoperator= (const VectorOrthogPoly &)
 Assignment.
void reset (const Teuchos::RCP< const Stokhos::OrthogPolyBasis< ordinal_type, value_type > > &new_basis, const Teuchos::RCP< const Epetra_BlockMap > &new_map, const typename traits_type::cloner_type &cloner)
 Reset to a new basis.
Teuchos::RCP< const
Stokhos::OrthogPolyBasis
< ordinal_type, value_type > > 
basis () const
 Get basis.
coeff_type & term (ordinal_type dimension, ordinal_type order)
 Get term for dimension dimension and order order.
const coeff_type & term (ordinal_type dimension, ordinal_type order) const
 Get term for dimension dimension and order order.
void evaluate (const Teuchos::Array< value_type > &basis_values, coeff_type &result) const
 Evaluate polynomial at supplied basis values.
void sumIntoAllTerms (const value_type &weight, const Teuchos::Array< value_type > &basis_values, const Teuchos::Array< value_type > &basis_norms, const coeff_type &vec)
 Evaluate polynomial at supplied basis values.
std::ostream & print (std::ostream &os) const
 Print polynomial.

Protected Attributes

Teuchos::RCP< const
Stokhos::OrthogPolyBasis
< ordinal_type, value_type > > 
basis_
 Basis.

Detailed Description

template<typename coeff_type>
class Stokhos::VectorOrthogPoly< coeff_type >

A container class storing an orthogonal polynomial whose coefficients are vectors, operators, or in general any type that would have an expensive copy constructor.


Constructor & Destructor Documentation

template<typename coeff_type >
Stokhos::VectorOrthogPoly< coeff_type >::VectorOrthogPoly ( )

Constructor with no basis.

Use with care! Generally you will want to call reset() before using any of the methods on this class.

template<typename coeff_type >
Stokhos::VectorOrthogPoly< coeff_type >::VectorOrthogPoly ( const VectorOrthogPoly< coeff_type > &  v)

Copy constructor.

NOTE: This is a shallow copy


Member Function Documentation

template<typename coeff_type>
void Stokhos::VectorOrthogPoly< coeff_type >::evaluate ( const Teuchos::Array< value_type > &  basis_values,
coeff_type &  result 
) const

Evaluate polynomial at supplied basis values.

Currently doesn't work with parallel map.

template<typename coeff_type >
Stokhos::VectorOrthogPoly< coeff_type > & Stokhos::VectorOrthogPoly< coeff_type >::operator= ( const VectorOrthogPoly< coeff_type > &  v)

Assignment.

NOTE: This is a shallow copy

template<typename coeff_type >
void Stokhos::VectorOrthogPoly< coeff_type >::reset ( const Teuchos::RCP< const Stokhos::OrthogPolyBasis< ordinal_type, value_type > > &  new_basis,
const Teuchos::RCP< const Epetra_BlockMap > &  new_map,
const typename traits_type::cloner_type &  cloner 
)

Reset to a new basis.

This resizes array to fit new basis.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator