Stokhos_ProductLanczosPCEBasis.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_PRODUCT_LANCZOS_PCE_BASIS_HPP
#define STOKHOS_PRODUCT_LANCZOS_PCE_BASIS_HPP
 
#include "Teuchos_RCP.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_SerialDenseMatrix.hpp"
#include "Teuchos_SerialDenseVector.hpp"
#include "Teuchos_ParameterList.hpp"
 
#include "Stokhos_ProductBasis.hpp"
#include "Stokhos_ReducedPCEBasis.hpp"
#include "Stokhos_OrthogPolyApprox.hpp"
#include "Stokhos_Quadrature.hpp"
#include "Stokhos_Sparse3Tensor.hpp"
#include "Stokhos_CompletePolynomialBasis.hpp"
 
namespace Stokhos {

  template <typename ordinal_type, typename value_type>
  class ProductLanczosPCEBasis : 
    public ProductBasis<ordinal_type,value_type>,
    public ReducedPCEBasis<ordinal_type,value_type> {
  public:


    ProductLanczosPCEBasis(
     ordinal_type p,
     const Teuchos::Array< Stokhos::OrthogPolyApprox<ordinal_type, value_type> >& pce,
     const Teuchos::RCP<const Stokhos::Quadrature<ordinal_type, value_type> >& quad,
     const Teuchos::RCP< const Stokhos::Sparse3Tensor<ordinal_type, value_type> >& Cijk,
     const Teuchos::ParameterList& params = Teuchos::ParameterList());

    virtual ~ProductLanczosPCEBasis();



    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;




    virtual void 
    transformToOriginalBasis(const value_type *in, 
           value_type *out,
           ordinal_type ncol = 1, 
           bool transpose = false) const;

    virtual void 
    transformFromOriginalBasis(const value_type *in, 
             value_type *out,
             ordinal_type ncol = 1, 
             bool transpose = false) const;

    virtual Teuchos::RCP<const Stokhos::Quadrature<ordinal_type, value_type> >
    getReducedQuadrature() const;

 
  protected:
 
    // Determine if a pce is linear, in that it has a total degree of at
    // most 1.  If the pce is nonlinear, return -2, or if it is constant, 
    // return -1, otherwise return the index of the variable the pce is
    // linear in, ie, if return value is i, the pce = a_{i+1}*\xi_i
    ordinal_type
    isInvariant(const Stokhos::OrthogPolyApprox<ordinal_type, value_type>& pce) const;
 
  private:
 
    // Prohibit copying
    ProductLanczosPCEBasis(const ProductLanczosPCEBasis&);
 
    // Prohibit Assignment
    ProductLanczosPCEBasis& operator=(const ProductLanczosPCEBasis&);
    
  protected:
 
    typedef Teuchos::SerialDenseVector<ordinal_type,value_type> SDV;
    typedef Teuchos::SerialDenseMatrix<ordinal_type,value_type> SDM;

    std::string name;

    Teuchos::ParameterList params;

    Teuchos::RCP< Stokhos::CompletePolynomialBasis<ordinal_type,value_type> > tensor_lanczos_basis;

    SDM Phi;

    SDM A;

    SDM Ainv;

    Teuchos::RCP<const Stokhos::Quadrature<ordinal_type, value_type> > reduced_quad;

    mutable Stokhos::OrthogPolyApprox<ordinal_type, value_type> tmp_pce;
 
  }; // class ProductLanczosPCEBasis
 
} // Namespace Stokhos
 
// Include template definitions
#include "Stokhos_ProductLanczosPCEBasisImp.hpp"
 
#endif