QUESO::InterpolationSurrogateData< V, M > Class Template Reference

#include <InterpolationSurrogateBase.h>

Public Member Functions
	InterpolationSurrogateData (const BoxSubset< V, M > &domain, const std::vector< unsigned int > &n_points)
	~InterpolationSurrogateData ()
const BoxSubset< V, M > &	get_paramDomain () const
const std::vector< unsigned int > &	get_n_points () const
const std::vector< double > &	get_values () const
std::vector< double > &	get_values ()
double	get_value (unsigned int n) const
unsigned int	n_values () const
void	set_values (std::vector< double > &values)
	Set all values. Dimension must be consistent with internal m_values. More...
void	set_value (unsigned int n, double value)
unsigned int	dim () const
	Dimension of parameter space. More...
double	x_min (unsigned int dim) const
	Lower bound of domain along dimension dim. More...
double	x_max (unsigned int dim) const
	Upper bound of domain along dimension dim. More...
double	spacing (unsigned int dim) const
	Spacing between points along dimension dim. More...
double	get_x (unsigned int dim, unsigned int index) const
	Get spatial coordinate value at the node index along coordinate direction dim. More...
void	sync_values (unsigned int root)
	Sync values across all processors from root processor. More...

Private Member Functions
	InterpolationSurrogateData ()
void	check_dim_consistency () const
	Helper function for constructor. More...
void	init_values (const std::vector< unsigned int > &n_points)
	Helper function for sizing m_values. More...
void	check_domain_bounds () const
	Helper function for checking domain extent. More...

Private Attributes
const BoxSubset< V, M > &	m_domain
	Parameter domain over which we use surrogate. More...
const std::vector< unsigned int > &	m_n_points
	vector to store number of points in each coordinate direction More...
std::vector< double >	m_values
	vector to store values to be interpolated More...

Detailed Description

template<typename V, typename M>
class QUESO::InterpolationSurrogateData< V, M >

Definition at line 34 of file InterpolationSurrogateBase.h.

Constructor & Destructor Documentation

template<class V , class M >

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

Definition at line 40 of file InterpolationSurrogateData.C.

References QUESO::InterpolationSurrogateData< V, M >::check_dim_consistency(), QUESO::InterpolationSurrogateData< V, M >::check_domain_bounds(), QUESO::InterpolationSurrogateData< V, M >::init_values(), and QUESO::InterpolationSurrogateData< V, M >::m_n_points.

    : m_domain(domain),
      m_n_points(n_points)
  {
    // This checks that the dimension of n_points and the domain are consistent
    this->check_dim_consistency();

    // Size m_values
    this->init_values(this->m_n_points);

    // Check the domain is bounded
    this->check_domain_bounds();
  }

template<typename V, typename M>

QUESO::InterpolationSurrogateData< V, M >::~InterpolationSurrogateData ( )

inline

Definition at line 43 of file InterpolationSurrogateData.h.

{};

template<typename V, typename M>

QUESO::InterpolationSurrogateData< V, M >::InterpolationSurrogateData ( )

private

Member Function Documentation

template<class V , class M >

void QUESO::InterpolationSurrogateData< V, M >::check_dim_consistency ( ) const

private

Helper function for constructor.

Definition at line 56 of file InterpolationSurrogateData.C.

References dim.

Referenced by QUESO::InterpolationSurrogateData< V, M >::InterpolationSurrogateData().

  {
    if( this->dim() != this->m_n_points.size() )
      {
        std::stringstream vspace_dim;
        vspace_dim << this->m_domain.vectorSpace().dimGlobal();

        std::stringstream n_points_dim;
        n_points_dim << this->m_n_points.size();

        std::string error = "ERROR: Mismatch between dimension of parameter space and number of points\n.";
        error += "        domain dimension = " + vspace_dim.str() + "\n";
        error += "        points dimension = " + n_points_dim.str() + "\n";

        queso_error_msg(error);
      }
  }

template<class V , class M >

void QUESO::InterpolationSurrogateData< V, M >::check_domain_bounds ( ) const

private

Helper function for checking domain extent.

Definition at line 88 of file InterpolationSurrogateData.C.

References QUESO::queso_isfinite().

Referenced by QUESO::InterpolationSurrogateData< V, M >::InterpolationSurrogateData().

  {
    for (unsigned int i = 0; i < m_domain.vectorSpace().dimLocal(); i++) {
      queso_require_msg(queso_isfinite(m_domain.minValues()[i]),
          "Interpolation with an unbounded domain is unsupported");
      queso_require_msg(queso_isfinite(m_domain.maxValues()[i]),
          "Interpolation with an unbounded domain is unsupported");
    }
  }

template<typename V, typename M>

unsigned int QUESO::InterpolationSurrogateData< V, M >::dim ( ) const

inline

Dimension of parameter space.

Definition at line 72 of file InterpolationSurrogateData.h.

References QUESO::InterpolationSurrogateData< V, M >::m_domain.

Referenced by QUESO::InterpolationSurrogateData< V, M >::x_max(), and QUESO::InterpolationSurrogateData< V, M >::x_min().

    { return this->m_domain.vectorSpace().dimGlobal(); };

template<typename V, typename M>

const std::vector<unsigned int>& QUESO::InterpolationSurrogateData< V, M >::get_n_points ( ) const

inline

Definition at line 48 of file InterpolationSurrogateData.h.

References QUESO::InterpolationSurrogateData< V, M >::m_n_points.

Referenced by QUESO::InterpolationSurrogateIOASCII< V, M >::write().

    { return this->m_n_points; };

template<typename V, typename M>

const BoxSubset<V,M>& QUESO::InterpolationSurrogateData< V, M >::get_paramDomain ( ) const

inline

Definition at line 45 of file InterpolationSurrogateData.h.

References QUESO::InterpolationSurrogateData< V, M >::m_domain.

Referenced by QUESO::InterpolationSurrogateBuilder< V, M >::sync_data(), and QUESO::InterpolationSurrogateIOASCII< V, M >::write().

    { return this->m_domain; };

template<typename V, typename M>

double QUESO::InterpolationSurrogateData< V, M >::get_value ( unsigned int  n ) const

inline

Definition at line 57 of file InterpolationSurrogateData.h.

References QUESO::InterpolationSurrogateData< V, M >::m_values.

Referenced by QUESO::InterpolationSurrogateIOASCII< V, M >::write().

    { queso_assert_less(n,this->m_values.size());
      return this->m_values[n]; };

template<typename V, typename M>

const std::vector<double>& QUESO::InterpolationSurrogateData< V, M >::get_values ( ) const

inline

Definition at line 51 of file InterpolationSurrogateData.h.

References QUESO::InterpolationSurrogateData< V, M >::m_values.

    { return this->m_values; };

template<typename V, typename M>

std::vector<double>& QUESO::InterpolationSurrogateData< V, M >::get_values ( )

inline

Definition at line 54 of file InterpolationSurrogateData.h.

References QUESO::InterpolationSurrogateData< V, M >::m_values.

    { return this->m_values; };

template<class V , class M >

double QUESO::InterpolationSurrogateData< V, M >::get_x	(	unsigned int	dim,
		unsigned int	index
	)		const

Get spatial coordinate value at the node index along coordinate direction dim.

Definition at line 125 of file InterpolationSurrogateData.C.

  {
    double x_min = this->x_min(dim);
    double spacing = this->spacing(dim);

    return x_min + spacing*index;
  }

template<class V , class M >

void QUESO::InterpolationSurrogateData< V, M >::init_values ( const std::vector< unsigned int > &  n_points )

private

Helper function for sizing m_values.

Definition at line 75 of file InterpolationSurrogateData.C.

Referenced by QUESO::InterpolationSurrogateData< V, M >::InterpolationSurrogateData().

  {
    unsigned int n_total_points = 1.0;
    for( std::vector<unsigned int>::const_iterator it = n_points.begin();
         it != n_points.end(); ++it )
      {
        n_total_points *= *it;
      }

    this->m_values.resize(n_total_points);
  }

template<typename V, typename M>

unsigned int QUESO::InterpolationSurrogateData< V, M >::n_values ( ) const

inline

Definition at line 61 of file InterpolationSurrogateData.h.

References QUESO::InterpolationSurrogateData< V, M >::m_values.

Referenced by QUESO::InterpolationSurrogateBuilder< V, M >::sync_data(), and QUESO::InterpolationSurrogateIOASCII< V, M >::write().

    { return this->m_values.size(); };

template<class V , class M >

void QUESO::InterpolationSurrogateData< V, M >::set_value	(	unsigned int	n,
		double	value
	)

Definition at line 107 of file InterpolationSurrogateData.C.

Referenced by QUESO::InterpolationSurrogateBuilder< V, M >::sync_data().

  {
    queso_assert_less( n, m_values.size() );

    this->m_values[n] = value;
  }

template<class V , class M >

void QUESO::InterpolationSurrogateData< V, M >::set_values

(

std::vector< double > &

values

)

Set all values. Dimension must be consistent with internal m_values.

This does a full copy of the values vector. This is mainly for testing, users are encouraged to use the InterpolationSurrogateBuilder.

Definition at line 99 of file InterpolationSurrogateData.C.

  {
    queso_assert_equal_to( values.size(), m_values.size() );

    this->m_values = values;
  }

template<class V , class M >

double QUESO::InterpolationSurrogateData< V, M >::spacing

(

unsigned int

dim

)

const

Spacing between points along dimension dim.

Definition at line 115 of file InterpolationSurrogateData.C.

References dim.

  {
    unsigned int n_intervals = this->m_n_points[dim]-1;
    double x_min = this->x_min(dim);
    double x_max = this->x_max(dim);

    return (x_max-x_min)/n_intervals;
  }

template<class V , class M >

void QUESO::InterpolationSurrogateData< V, M >::sync_values

(

unsigned int

root

)

Sync values across all processors from root processor.

m_values may only be set on one processor, so this method is used for MPI_Bcast'ing those values to all processors. This calls MPI_Bcast, which is collective, so this MUST be called from all processors in env.fullComm().

Definition at line 134 of file InterpolationSurrogateData.C.

References QUESO::MpiComm::Bcast().

Referenced by QUESO::InterpolationSurrogateBuilder< V, M >::sync_data().

  {
    MpiComm full_comm = this->m_domain.env().fullComm();

    full_comm.Bcast( &this->m_values[0], this->n_values(),
                     RawValue_MPI_DOUBLE, root,
                     "InterpolationSurrogateData::sync_values()",
                     "MpiComm::Bcast() failed!" );
  }

template<typename V, typename M>

double QUESO::InterpolationSurrogateData< V, M >::x_max ( unsigned int  dim ) const

inline

Upper bound of domain along dimension dim.

Definition at line 80 of file InterpolationSurrogateData.h.

References QUESO::InterpolationSurrogateData< V, M >::dim(), and QUESO::InterpolationSurrogateData< V, M >::m_domain.

Referenced by QUESO::InterpolationSurrogateIOASCII< V, M >::write().

    { return this->m_domain.maxValues()[dim]; };

template<typename V, typename M>

double QUESO::InterpolationSurrogateData< V, M >::x_min ( unsigned int  dim ) const

inline

Lower bound of domain along dimension dim.

Definition at line 76 of file InterpolationSurrogateData.h.

References QUESO::InterpolationSurrogateData< V, M >::dim(), and QUESO::InterpolationSurrogateData< V, M >::m_domain.

Referenced by QUESO::InterpolationSurrogateIOASCII< V, M >::write().

    { return this->m_domain.minValues()[dim]; };

Member Data Documentation

template<typename V, typename M>

const BoxSubset<V,M>& QUESO::InterpolationSurrogateData< V, M >::m_domain

private

Parameter domain over which we use surrogate.

Definition at line 110 of file InterpolationSurrogateData.h.

Referenced by QUESO::InterpolationSurrogateData< V, M >::dim(), QUESO::InterpolationSurrogateData< V, M >::get_paramDomain(), QUESO::InterpolationSurrogateData< V, M >::x_max(), and QUESO::InterpolationSurrogateData< V, M >::x_min().

template<typename V, typename M>

const std::vector<unsigned int>& QUESO::InterpolationSurrogateData< V, M >::m_n_points

private

vector to store number of points in each coordinate direction

We assume that the spacing in each coordinate direction is constant so we only need to know the number of points.

Definition at line 115 of file InterpolationSurrogateData.h.

Referenced by QUESO::InterpolationSurrogateData< V, M >::get_n_points(), and QUESO::InterpolationSurrogateData< V, M >::InterpolationSurrogateData().

template<typename V, typename M>

std::vector<double> QUESO::InterpolationSurrogateData< V, M >::m_values

private

vector to store values to be interpolated

These will be stored in a particular ordering. Helper functions will provide mapping between grid coordinates and a global coordinate; the global coordinate will be used to index into the values.

Todo:

We currently store all values reside on all processes. Generalization would be to partition values across processes allocated for the subenvironment.

Definition at line 123 of file InterpolationSurrogateData.h.

Referenced by QUESO::InterpolationSurrogateData< V, M >::get_value(), QUESO::InterpolationSurrogateData< V, M >::get_values(), and QUESO::InterpolationSurrogateData< V, M >::n_values().

---

The documentation for this class was generated from the following files:

• src/surrogates/inc/InterpolationSurrogateBase.h
• src/surrogates/inc/InterpolationSurrogateData.h
• src/surrogates/src/InterpolationSurrogateData.C