Stokhos_OneDOrthogPolyBasis.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_ONEDORTHOGPOLYBASIS_HPP
#define STOKHOS_ONEDORTHOGPOLYBASIS_HPP

#include <ostream>
#include <string>
#include "Stokhos_Dense3Tensor.hpp"
#include "Stokhos_Sparse3Tensor.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_SerialDenseMatrix.hpp"

#include "Stokhos_ConfigDefs.h"
#ifdef HAVE_STOKHOS_DAKOTA
#include "sandia_rules.hpp"
#endif

namespace Stokhos {


  template <typename ordinal_type, typename value_type>
  class OneDOrthogPolyBasis {
  public:

    OneDOrthogPolyBasis() {};

    virtual ~OneDOrthogPolyBasis() {};

    virtual ordinal_type order() const = 0;

    virtual ordinal_type size() const = 0;


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

    virtual const value_type& norm_squared(ordinal_type i) const = 0;


    virtual
    Teuchos::RCP< Stokhos::Dense3Tensor<ordinal_type, value_type> >
    computeTripleProductTensor() const = 0;


    virtual
    Teuchos::RCP< Stokhos::Sparse3Tensor<ordinal_type, value_type> >
    computeSparseTripleProductTensor(ordinal_type order) const = 0;


    virtual
    Teuchos::RCP< Teuchos::SerialDenseMatrix<ordinal_type, value_type> >
    computeDerivDoubleProductTensor() const = 0;


    virtual void evaluateBases(const value_type& point,
                               Teuchos::Array<value_type>& basis_pts) const = 0;

    virtual value_type evaluate(const value_type& point,
                                ordinal_type order) const = 0;

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

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

    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;

    virtual ordinal_type quadDegreeOfExactness(ordinal_type n) const = 0;

    virtual Teuchos::RCP<OneDOrthogPolyBasis<ordinal_type,value_type> > cloneWithOrder(ordinal_type p) const = 0;

    virtual ordinal_type coefficientGrowth(ordinal_type n) const = 0;

    virtual ordinal_type pointGrowth(ordinal_type n) const = 0;

    typedef int ( *LevelToOrderFnPtr ) ( int level, int growth );


    virtual LevelToOrderFnPtr getSparseGridGrowthRule() const = 0;

    virtual void setSparseGridGrowthRule(LevelToOrderFnPtr ptr) = 0;

  private:

    // Prohibit copying
    OneDOrthogPolyBasis(const OneDOrthogPolyBasis&);

    // Prohibit Assignment
    OneDOrthogPolyBasis& operator=(const OneDOrthogPolyBasis& b);


  }; // class OrthogPolyBasis

  template <typename ordinal_type, typename value_type>
  std::ostream&
  operator << (std::ostream& os,
               const OneDOrthogPolyBasis<ordinal_type, value_type>& b) {
    b.print(os);
    return os;
  }

} // Namespace Stokhos

#endif