InterpolationSurrogateData.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-2017 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_INTERPOLATION_SURROGATE_DATA_H
#define UQ_INTERPOLATION_SURROGATE_DATA_H

#include <queso/BoxSubset.h>

namespace QUESO
{
  class GslVector;
  class GslMatrix;

  template<class V = GslVector, class M = GslMatrix>
  class InterpolationSurrogateData
  {
  public:

    InterpolationSurrogateData( const BoxSubset<V,M>& domain,
                                const std::vector<unsigned int>& n_points );

    ~InterpolationSurrogateData(){};

    const BoxSubset<V,M>& get_paramDomain() const
    { return this->m_domain; };

    const std::vector<unsigned int>& get_n_points() const
    { return this->m_n_points; };

    const std::vector<double>& get_values() const
    { return this->m_values; };

    std::vector<double>& get_values()
    { return this->m_values; };

    double get_value( unsigned int n ) const
    { queso_assert_less(n,this->m_values.size());
      return this->m_values[n]; };

    unsigned int n_values() const
    { return this->m_values.size(); };


    void set_values( std::vector<double>& values );

    void set_value( unsigned int n, double value );

    unsigned int dim() const
    { return this->m_domain.vectorSpace().dimGlobal(); };

    double x_min( unsigned int dim ) const
    { return this->m_domain.minValues()[dim]; };

    double x_max( unsigned int dim ) const
    { return this->m_domain.maxValues()[dim]; };

    double spacing( unsigned int dim ) const;

    double get_x( unsigned int dim, unsigned int index ) const;


    void sync_values( unsigned int root );

  private:

    InterpolationSurrogateData();

    void check_dim_consistency() const;

    void init_values( const std::vector<unsigned int>& n_points );

    void check_domain_bounds() const;

    const BoxSubset<V,M>& m_domain;


    const std::vector<unsigned int>& m_n_points;


    std::vector<double> m_values;
  };

} // end namespace QUESO

#endif // UQ_INTERPOLATION_SURROGATE_DATA_H