fv1_sss.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015:  G-CSC, Goethe University Frankfurt
 * Author: Michael Lampe
 * 
 * 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.
 */
 
/*
 * Singular sources and sinks for the FV discretizations:
 */
 
#ifndef __H__UG__LIB_DISC__SPATIAL_DISC__FV_SINGULAR_SOURCES_AND_SINKS__
#define __H__UG__LIB_DISC__SPATIAL_DISC__FV_SINGULAR_SOURCES_AND_SINKS__
 
#include <vector>
 
// ug4 headers
#include "lib_grid/algorithms/bounding_box_util.h"
#include "lib_grid/algorithms/geom_obj_util/geom_obj_util.h"
 
namespace ug {
 
template <int dim, typename TData>
class FVPointSourceOrSink : public TData
{
private:
  MathVector<dim> point; 
  
public:
 
  FVPointSourceOrSink
  (
    const MathVector<dim>& _point 
  )
  : point(_point) {}
 
  FVPointSourceOrSink
  (
    const MathVector<dim>& _point, 
    const TData& _data 
  )
  : TData(_data), point(_point) {}
 
  FVPointSourceOrSink
  (
    const std::vector<number>& _point 
  )
  {
    if (_point.size () != dim)
      UG_THROW ("FVPointSourceOrSink: Number of coordinates does not match the dimension.");
    for (size_t i = 0; i < dim; i++) point[i] = _point[i];
  }
 
  const MathVector<dim>& position () {return point;}
  
    template <typename TElem, typename TAAPos, typename TFVGeom>
    bool corresponds_to
    (
    TElem* elem, 
    Grid& grid, 
    TAAPos& aaPos, 
    const TFVGeom& geo, 
    size_t co 
  );
};
 
template<int dim, typename TData>
class FVLineSourceOrSink : public TData
{
private:
    MathVector<dim> point1; 
    MathVector<dim> point2; 
 
public:
  
    FVLineSourceOrSink
    (
      const MathVector<dim>& _point1, 
    const MathVector<dim>& _point2 
  )
  : point1(_point1), point2(_point2) {}
 
    FVLineSourceOrSink
    (
      const MathVector<dim>& _point1, 
    const MathVector<dim>& _point2, 
    const TData& _data 
  )
  : TData(_data), point1(_point1), point2(_point2) {}
 
    FVLineSourceOrSink
    (
      const std::vector<number>& _point1, 
    const std::vector<number>& _point2 
  )
  {
    if (_point1.size () != dim || _point2.size () != dim)
      UG_THROW ("FVLineSourceOrSink: Number of coordinates does not match the dimension.");
    for (size_t i = 0; i < dim; i++)
    {
      point1[i] = _point1[i]; point2[i] = _point2[i];
    }
  }
 
  const MathVector<dim>& from_position () {return point1;}
  
  const MathVector<dim>& to_position () {return point2;}
  
    template <typename TElem, typename TAAPos, typename TFVGeom>
    bool corresponds_to
    (
    TElem* elem, 
    Grid& grid, 
    TAAPos& aaPos, 
    const TFVGeom& geo, 
    size_t co, 
    MathVector<dim>& ls, 
    MathVector<dim>& le 
  );
};
 
template<typename TData>
class FVLineSourceOrSink<1, TData> : public TData
{
private:
  static const int dim = 1;
    MathVector<dim> point1; 
    MathVector<dim> point2; 
 
public:
  
    FVLineSourceOrSink
    (
      const MathVector<dim>& _point1, 
    const MathVector<dim>& _point2 
  )
  : point1(_point1), point2(_point2) {}
 
    FVLineSourceOrSink
    (
      const MathVector<dim>& _point1, 
    const MathVector<dim>& _point2, 
    const TData& _data 
  )
  : TData(_data), point1(_point1), point2(_point2) {}
 
    FVLineSourceOrSink
    (
      const std::vector<number>& _point1, 
    const std::vector<number>& _point2 
  )
  {
    UG_THROW ("FVLineSourceOrSink: Line sources and sinks are not supported in 1d.");
  }
 
  const MathVector<dim>& from_position () {return point1;}
  
  const MathVector<dim>& to_position () {return point2;}
  
    template <typename TElem, typename TAAPos, typename TFVGeom>
    bool corresponds_to
    (
    TElem* elem, 
    Grid& grid, 
    TAAPos& aaPos, 
    const TFVGeom& geo, 
    size_t co, 
    MathVector<dim>& ls, 
    MathVector<dim>& le 
  )
  {
    UG_THROW ("FVLineSourceOrSink: Line sources and sinks are not supported in 1d.");
    return false;
  }
};
 
template <int dim, typename TPointData, typename TLineData = TPointData>
class FVSingularSourcesAndSinks
{
public:
  typedef FVPointSourceOrSink<dim, TPointData> point_sss_type;
  typedef FVLineSourceOrSink<dim, TLineData> line_sss_type;
 
private:
  typename std::vector<SmartPtr<point_sss_type> > ListP;
  typename std::vector<SmartPtr<line_sss_type> > ListL;
  
public:
 
  FVSingularSourcesAndSinks () {}
 
  void add_point
  (
    SmartPtr<point_sss_type> point_sss 
  )
  {
    ListP.push_back (point_sss);
  }
  
  void add_line
  (
    SmartPtr<line_sss_type> line_sss 
  )
  {
    ListL.push_back (line_sss);
  }
  
  size_t num_points () {return ListP.size ();}
  
  point_sss_type * point (size_t i) {return ListP[i].get();}
  
  void init_all_point_sss ()
  {
    for (size_t i = 0; i < ListP.size (); i++)
      ((TPointData *) ListP[i].get())->init ();
  }
  
  template <typename TElem, typename TAAPos, typename TFVGeom>
  class point_iterator
  {
    typedef point_iterator<TElem, TAAPos, TFVGeom> this_type;
    typedef FVSingularSourcesAndSinks<dim, TPointData, TLineData> master_type;
    
    master_type * m_sss;
    TElem * m_elem;
    Grid & m_grid;
    TAAPos & m_aaPos;
    const TFVGeom & m_geo;
    size_t m_co;
    AABox<MathVector<dim> > m_elem_bbox;
    size_t m_index; 
    
  public:
  
    point_iterator
    (
      master_type* sss, 
      TElem* elem, 
      Grid& grid, 
      TAAPos& aaPos, 
      const TFVGeom& geo, 
      size_t co 
    )
    : m_sss (sss), m_elem (elem), m_grid (grid), m_aaPos (aaPos), m_geo (geo), m_co (co)
    {
      m_elem_bbox = CalculateBoundingBox(m_elem, m_aaPos);
      next_sss (0);
    }
    
    point_iterator (this_type& op)
    : m_elem (op.m_elem), m_grid (op.m_grid), m_aaPos (op.m_aaPos),
      m_geo (op.m_geo), m_co (op.m_co), m_elem_bbox (op.m_elem_bbox),
      m_index (op.m_index)
    {}
    
    this_type& rewind () {m_index = 0; return * this;}
  
    point_sss_type * operator * () {return m_sss->ListP[m_index].get();}
    
    bool is_over () {return m_index >= m_sss->num_points ();}
    
    this_type & operator++ ()
    {
      next_sss (m_index + 1);
      return * this;
    }
    
  private:
    void next_sss (size_t index);
  };
  
  size_t num_lines () {return ListL.size ();}
  
  line_sss_type * line (size_t i) {return ListL[i].get();}
  
  void init_all_line_sss ()
  {
    for (size_t i = 0; i < ListL.size (); i++)
      ((TLineData *) ListL[i].get())->init ();
  }
  
  template <typename TElem, typename TAAPos, typename TFVGeom>
  class line_iterator
  {
    typedef line_iterator<TElem, TAAPos, TFVGeom> this_type;
    typedef FVSingularSourcesAndSinks<dim, TPointData, TLineData> master_type;
    
    master_type * m_sss;
    TElem * m_elem;
    Grid & m_grid;
    TAAPos & m_aaPos;
    const TFVGeom & m_geo;
    size_t m_co;
    AABox<MathVector<dim> > m_elem_bbox;
    
    size_t m_index; 
    MathVector<dim> m_ls; 
    MathVector<dim> m_le; 
    
  public:
  
    line_iterator
    (
      master_type* sss, 
      TElem* elem, 
      Grid& grid, 
      TAAPos& aaPos, 
      const TFVGeom& geo, 
      size_t co 
    )
    : m_sss (sss), m_elem (elem), m_grid (grid), m_aaPos (aaPos), m_geo (geo), m_co (co)
    {
      m_elem_bbox = CalculateBoundingBox(m_elem, m_aaPos);
      next_sss (0, m_ls, m_le);
    }
    
    line_iterator (this_type& op)
    : m_elem (op.m_elem), m_grid (op.m_grid), m_aaPos (op.m_aaPos),
      m_geo (op.m_geo), m_co (op.m_co), m_elem_bbox (op.m_elem_bbox),
      m_index (op.m_index)
    {}
    
    this_type& rewind () {m_index = 0; return * this;}
  
    line_sss_type * operator * () {return m_sss->ListL[m_index].get();}
    
    const MathVector<dim>& seg_start () {return m_ls;}
    
    const MathVector<dim>& seg_end () {return m_le;}
    
    bool is_over () {return m_index >= m_sss->num_lines ();}
    
    this_type & operator++ ()
    {
      next_sss (m_index + 1, m_ls, m_le);
      return * this;
    }
    
  private:
    void next_sss (size_t index, MathVector<dim>& ls, MathVector<dim>& le);
  };
};
 
} // namespace ug
 
#include "fv1_sss_impl.h"
 
#endif // __H__UG__LIB_DISC__SPATIAL_DISC__FV_SINGULAR_SOURCES_AND_SINKS__
 
/* End of File */