Stokhos_VectorOrthogPoly.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                           Stokhos Package
//
// Copyright 2009 NTESS and the Stokhos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef STOKHOS_VECTORORTHOGPOLY_HPP
#define STOKHOS_VECTORORTHOGPOLY_HPP

#include "Stokhos_ProductContainer.hpp"
#include "Stokhos_OrthogPolyBasis.hpp"

namespace Stokhos {

  template <typename coeff_type>
  class VectorOrthogPoly : public virtual ProductContainer<coeff_type> {
  public:

    typedef typename ProductContainer<coeff_type>::traits_type traits_type;

    typedef typename ProductContainer<coeff_type>::value_type value_type;

    typedef typename ProductContainer<coeff_type>::ordinal_type ordinal_type;


    VectorOrthogPoly();

    VectorOrthogPoly(
      const Teuchos::RCP<const Stokhos::OrthogPolyBasis<ordinal_type, value_type> >& basis,
      const Teuchos::RCP<const Epetra_BlockMap>& map);

    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);


    VectorOrthogPoly(const VectorOrthogPoly&);

    virtual ~VectorOrthogPoly();


    VectorOrthogPoly& operator=(const VectorOrthogPoly&);


    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);

    Teuchos::RCP<const Stokhos::OrthogPolyBasis<ordinal_type, value_type> > 
    basis() const;

    coeff_type& term(ordinal_type dimension, ordinal_type order);

    const coeff_type& term(ordinal_type dimension, ordinal_type order) const;


    void evaluate(const Teuchos::Array<value_type>& basis_values, 
      coeff_type& result) const;

    void sumIntoAllTerms(const value_type& weight,
       const Teuchos::Array<value_type>& basis_values, 
       const Teuchos::Array<value_type>& basis_norms,
       const coeff_type& vec);

    std::ostream& print(std::ostream& os) const;

  protected:

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

  }; // class VectorOrthogPoly

  template <typename coeff_type>
  std::ostream& operator << (std::ostream& os, 
           const VectorOrthogPoly<coeff_type>& vec) {
    return vec.print(os);
  }

} // end namespace Stokhos

// include template definitions
#include "Stokhos_VectorOrthogPolyImp.hpp"

#endif  // STOKHOS_VECTORORTHOGPOLY_HPP