Stokhos_TensorProductBasis.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                           Stokhos Package
//                 Copyright (2009) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER

#ifndef STOKHOS_TENSOR_PRODUCT_BASIS_HPP
#define STOKHOS_TENSOR_PRODUCT_BASIS_HPP

#include "Teuchos_RCP.hpp"

#include "Stokhos_ProductBasis.hpp"
#include "Stokhos_OneDOrthogPolyBasis.hpp"
#include "Stokhos_ProductBasisUtils.hpp"

namespace Stokhos {

  template <typename ordinal_type, typename value_type,
      typename coeff_compare_type = 
      TotalOrderLess<MultiIndex<ordinal_type> > >
  class TensorProductBasis : 
    public ProductBasis<ordinal_type,value_type> {
  public:


    TensorProductBasis(
      const Teuchos::Array< Teuchos::RCP<const OneDOrthogPolyBasis<ordinal_type,
 value_type> > >& bases,
      const value_type& sparse_tol = 1.0e-12,
      const MultiIndex<ordinal_type>& index = MultiIndex<ordinal_type>(),
      const coeff_compare_type& coeff_compare = coeff_compare_type());

    virtual ~TensorProductBasis();



    ordinal_type order() const;

    ordinal_type dimension() const;

    virtual ordinal_type size() const;


    virtual const Teuchos::Array<value_type>& norm_squared() const;

    virtual const value_type& norm_squared(ordinal_type i) const;


    virtual 
    Teuchos::RCP< Stokhos::Sparse3Tensor<ordinal_type, value_type> > 
    computeTripleProductTensor() const;

    virtual 
    Teuchos::RCP< Stokhos::Sparse3Tensor<ordinal_type, value_type> > 
    computeLinearTripleProductTensor() const;

    virtual value_type evaluateZero(ordinal_type i) const;


    virtual void evaluateBases(
      const Teuchos::ArrayView<const value_type>& point,
      Teuchos::Array<value_type>& basis_vals) const;

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

    virtual const std::string& getName() const;





    virtual const MultiIndex<ordinal_type>& term(ordinal_type i) const;


    virtual ordinal_type index(const MultiIndex<ordinal_type>& term) const;


    Teuchos::Array< Teuchos::RCP<const OneDOrthogPolyBasis<ordinal_type, 
                 value_type> > > 
    getCoordinateBases() const;

    virtual MultiIndex<ordinal_type> getMaxOrders() const;


  private:

    // Prohibit copying
    TensorProductBasis(const TensorProductBasis&);

    // Prohibit Assignment
    TensorProductBasis& operator=(const TensorProductBasis& b);
    
  protected:

    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;

    std::string name;

    ordinal_type p;

    ordinal_type d;

    ordinal_type sz;

    Teuchos::Array< Teuchos::RCP<const OneDOrthogPolyBasis<ordinal_type, value_type> > > bases;

    value_type sparse_tol;

    coeff_type max_orders;

    coeff_set_type basis_set;

    coeff_map_type basis_map;

    Teuchos::Array<value_type> norms;

    mutable Teuchos::Array< Teuchos::Array<value_type> > basis_eval_tmp;

  }; // class TensorProductBasis

} // Namespace Stokhos

// Include template definitions
#include "Stokhos_TensorProductBasisImp.hpp"

#endif