Stokhos_RecurrenceBasis.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_RECURRENCEBASIS_HPP
#define STOKHOS_RECURRENCEBASIS_HPP

#include "Stokhos_OneDOrthogPolyBasis.hpp"

namespace Stokhos {

  enum GrowthPolicy {
    SLOW_GROWTH,
    MODERATE_GROWTH
  };

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

    virtual ~RecurrenceBasis();



    virtual ordinal_type order() 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::Dense3Tensor<ordinal_type, value_type> >
    computeTripleProductTensor() const;


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


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


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

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

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

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

    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;

    virtual ordinal_type quadDegreeOfExactness(ordinal_type n) const;

    virtual ordinal_type coefficientGrowth(ordinal_type n) const;

    virtual ordinal_type pointGrowth(ordinal_type n) const;

    typedef typename OneDOrthogPolyBasis<ordinal_type,value_type>::LevelToOrderFnPtr LevelToOrderFnPtr;


    virtual LevelToOrderFnPtr getSparseGridGrowthRule() const {
      return sparse_grid_growth_rule; }

    virtual void setSparseGridGrowthRule(LevelToOrderFnPtr ptr) {
      sparse_grid_growth_rule = ptr; }


    virtual void getRecurrenceCoefficients(Teuchos::Array<value_type>& alpha,
                                           Teuchos::Array<value_type>& beta,
                                           Teuchos::Array<value_type>& delta,
                                           Teuchos::Array<value_type>& gamma) const;

    virtual void evaluateBasesAndDerivatives(const value_type& point,
                                             Teuchos::Array<value_type>& vals,
                                             Teuchos::Array<value_type>& derivs) const;

    virtual void setQuadZeroTol(value_type tol) {
      quad_zero_tol = tol; }

  protected:


    RecurrenceBasis(const std::string& name, ordinal_type p, bool normalize,
                    GrowthPolicy growth = SLOW_GROWTH);

    RecurrenceBasis(ordinal_type p, const RecurrenceBasis& basis);


    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 = 0;


    virtual void setup();

    void normalizeRecurrenceCoefficients(
      Teuchos::Array<value_type>& alpha,
      Teuchos::Array<value_type>& beta,
      Teuchos::Array<value_type>& delta,
      Teuchos::Array<value_type>& gamma) const;

  private:

    // Prohibit copying
    RecurrenceBasis(const RecurrenceBasis&);

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

  protected:

    std::string name;

    ordinal_type p;

    bool normalize;

    GrowthPolicy growth;

    value_type quad_zero_tol;

    LevelToOrderFnPtr sparse_grid_growth_rule;

    Teuchos::Array<value_type> alpha;

    Teuchos::Array<value_type> beta;

    Teuchos::Array<value_type> delta;

    Teuchos::Array<value_type> gamma;

    Teuchos::Array<value_type> norms;

  }; // class RecurrenceBasis

} // Namespace Stokhos

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

#endif