Stokhos_KL_ExponentialRandomField.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_KL_EXPONENTIAL_RANDOM_FIELD_HPP
#define STOKHOS_KL_EXPONENTIAL_RANDOM_FIELD_HPP

#include "Teuchos_ParameterList.hpp"
#include "Teuchos_PromotionTraits.hpp"
#include "Kokkos_Core.hpp"
#include "Kokkos_View.hpp"

#include "Stokhos_KL_OneDExponentialEigenPair.hpp"
#include "Stokhos_KL_ProductEigenPair.hpp"

namespace Stokhos {

  namespace KL {


    template <typename value_type,
              typename execution_space = Kokkos::DefaultExecutionSpace>
    class ExponentialRandomField {
    public:

      typedef ExponentialOneDEigenFunction<value_type> one_d_eigen_func_type;
      typedef OneDEigenPair<one_d_eigen_func_type> one_d_eigen_pair_type;
      typedef ProductEigenPair<one_d_eigen_func_type,execution_space> product_eigen_pair_type;
      typedef Kokkos::View<one_d_eigen_func_type**,execution_space> eigen_func_array_type;
      typedef Kokkos::View<value_type*,execution_space> eigen_value_array_type;

      ExponentialRandomField() : num_KL(0), mean(0), std_dev(0) {}

      ExponentialRandomField(Teuchos::ParameterList& solverParams);

      KOKKOS_INLINE_FUNCTION
      ~ExponentialRandomField() {}

      KOKKOS_INLINE_FUNCTION
      int spatialDimension() const { return dim; }

      KOKKOS_INLINE_FUNCTION
      int stochasticDimension() const { return num_KL; }

      template <typename point_type, typename rv_type>
      KOKKOS_INLINE_FUNCTION
      typename Teuchos::PromotionTraits<typename rv_type::value_type,
                                        value_type>::promote
      evaluate(const point_type& point,
               const rv_type& random_variables) const;

      template <typename point_type>
      KOKKOS_INLINE_FUNCTION
      value_type evaluate_mean(const point_type& point) const { return mean; }

      template <typename point_type>
      KOKKOS_INLINE_FUNCTION
      typename Teuchos::PromotionTraits<typename point_type::value_type,
                                        value_type>::promote
      evaluate_standard_deviation(const point_type& point) const;

      template <typename point_type>
      KOKKOS_INLINE_FUNCTION
      typename Teuchos::PromotionTraits<typename point_type::value_type, value_type>::promote
      evaluate_eigenfunction(const point_type& point, int i) const;

      value_type
      KOKKOS_INLINE_FUNCTION
      eigenvalue(int i) const { return product_eigen_values(i); }

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

    protected:

      int num_KL;

      int dim;

      value_type mean;

      value_type std_dev;

      eigen_func_array_type product_eigen_funcs;

      eigen_value_array_type product_eigen_values;

    }; // class ExponentialRandomField

  } // namespace KL

} // namespace Stokhos

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

#endif // STOKHOS_KL_EXPONENTIAL_RANDOM_FIELD_HPP