invdist_user_data.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015:  G-CSC, Goethe University Frankfurt
 * Author: Dmitry Logashenko
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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.
 */
 
/*
 * Inverse Distance Weighting (IDW) interpolation for data sets
 */
#ifndef __H__UG__LIB_DISC__SPATIAL_DISC__USER_DATA__IDW_USER_DATA__
#define __H__UG__LIB_DISC__SPATIAL_DISC__USER_DATA__IDW_USER_DATA__
 
#include <vector>
 
// ug4 headers
#include "common/common.h"
#include "common/math/ugmath.h"
#include "lib_disc/spatial_disc/user_data/std_glob_pos_data.h"
 
namespace ug {
 
 
template <int WDim, typename TPntIterator, typename TData = number>
class IDWInterpolation
{
public:
 
  static const int dim = WDim;
  
  typedef TPntIterator t_pnt_iter;
  
  typedef TData data_type;
  
public:
 
  static void compute
  (
    data_type & res, 
    const MathVector<dim> & pos, 
    t_pnt_iter pnt_beg, 
    t_pnt_iter pnt_end, 
    number order, 
    number small_dist = 1e-7 
  );
 
  static void compute
  (
    data_type & res, 
    const MathVector<dim> & pos, 
    number R, 
    t_pnt_iter pnt_beg, 
    t_pnt_iter pnt_end, 
    number order, 
    number small_dist = 1e-7 
  );
};
 
 
template <int WDim, typename TData = number>
class IDWUserData
: public StdGlobPosData<IDWUserData<WDim, TData>, TData, WDim>
{
public:
 
  static const int dim = WDim;
  
  typedef TData data_type;
  
private:
  
  struct data_item
  {
    MathVector<dim> pos; 
    data_type value; 
    
    data_item (const MathVector<dim> & x, const data_type & v) : pos (x), value (v) {};
    data_item (const data_item & dat) : pos (dat.pos), value (dat.value) {};
  };
  
public:
 
  IDWUserData ()
  : m_order (dim + 1), m_R (0)
  {}
  
  IDWUserData (number order, number R)
  : m_order (order), m_R (R)
  {}
 
  ~IDWUserData () {}
 
public:
 
  void set_radius (number R) {m_R = R;}
  
  void set_order (number order) {m_order = order;}
  
  void clear () {m_data.clear ();}
  
  void load_data_from (std::istream & in);
  
  void load_data_from (const char * file_name);
  
  void append (const MathVector<dim> & x, const data_type & val) {m_data.push_back (data_item (x, val));}
  
public:
 
  inline void evaluate (data_type & value, const MathVector<dim> & x, number time, int si) const
  {
    typedef typename std::vector<data_item>::const_iterator pnt_iter_type;
    IDWInterpolation<dim, pnt_iter_type, data_type>::compute (value, x, m_R,
                    m_data.begin (), m_data.end (), m_order);
  }
 
private:
 
  std::vector<data_item> m_data; 
  number m_order; 
  number m_R; 
};
 
} // end namespace ug
 
#include "invdist_user_data_impl.h"
 
#endif // __H__UG__LIB_DISC__SPATIAL_DISC__USER_DATA__IDW_USER_DATA__
 
/* End of File */