ScalarGaussianRandomField.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// QUESO - a library to support the Quantification of Uncertainty
// for Estimation, Simulation and Optimization
//
// Copyright (C) 2008-2015 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#ifndef UQ_SCALAR_GAUSSIAN_RANDOM_FIELD_H
#define UQ_SCALAR_GAUSSIAN_RANDOM_FIELD_H

#include <queso/ScalarCovarianceFunction.h>
#include <queso/ScalarFunction.h>
#include <queso/GaussianVectorRV.h>

namespace QUESO {

template <class V, class M>
class ScalarGaussianRandomField
{
 public:


  ScalarGaussianRandomField(const char*                                     prefix,
                                   const VectorSet<V,M>&                    indexSet,
                                   const BaseScalarFunction<V,M>&           meanFunction,
                                   const BaseScalarCovarianceFunction<V,M>& covarianceFunction);


  ScalarGaussianRandomField(const ScalarGaussianRandomField&         obj);

  ~ScalarGaussianRandomField();



  ScalarGaussianRandomField& operator=(const ScalarGaussianRandomField& rhs);


  const VectorSet<V,M>&           indexSet          () const;

  const BaseScalarFunction<V,M>&  meanFunction      () const;

  const BaseScalarCovarianceFunction<V,M>& covarianceFunction() const;


  void                                  sampleFunction(const std::vector<V*>& fieldPositions, V& sampleValues);

protected:
  void                                  copy          (const ScalarGaussianRandomField& src);

  const BaseEnvironment&         m_env;

  std::string                           m_prefix;

  const VectorSet<V,M>&          m_indexSet;

  const BaseScalarFunction<V,M>& m_meanFunction;

  const BaseScalarCovarianceFunction<V,M>& m_covarianceFunction;

  std::vector<V*>                       m_savedPositions;

  VectorSpace<V,M>*              m_savedRvImageSpace;

  V*                                    m_savedRvLawExpVector;

  M*                                    m_savedRvLawCovMatrix;

  GaussianVectorRV<V,M>*         m_savedRv;
};

}  // End namespace QUESO

#endif // UQ_SCALAR_GAUSSIAN_RANDOM_FIELD_H