parallel_grid_layout.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-2015:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * 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.
 */
 
#ifndef __H__LIB_GRID__PARALLEL_GRID_LAYOUT__
#define __H__LIB_GRID__PARALLEL_GRID_LAYOUT__
 
#include <vector>
#include <list>
#include <map>
#include <algorithm>
#include "pcl/pcl_communication_structs.h"
#include "lib_grid/grid/grid_base_objects.h"
#include "grid_object_id.h"
 
//  specialize pcl::type_traits for Vertex, Edge, Face and Volume
namespace pcl
{
template <>
struct type_traits<ug::Vertex>
{
  typedef ug::Vertex* Elem;
};
 
template <>
struct type_traits<ug::Edge>
{
  typedef ug::Edge* Elem;
};
 
template <>
struct type_traits<ug::Face>
{
  typedef ug::Face* Elem;
};
 
template <>
struct type_traits<ug::Volume>
{
  typedef ug::Volume* Elem;
};
 
}// end of namespace pcl
 
namespace ug
{
 
 
enum InterfaceNodeTypes
{
  INT_NONE =  0,
  INT_H_MASTER = 1,   
  INT_H_SLAVE = 1<<1,   
  INT_V_MASTER = 1<<2,  
  INT_V_SLAVE = 1<<3,   
};
 
//  declare vertex-, edge-, face- and volume-layouts
//  we're using std::list as interface-element container, since we
//  require interface-element-iterators that stay valid even if the
//  interface is altered.
//  Make sure that those layouts match the ones in GridLayoutMap.
typedef pcl::MultiLevelLayout<
    pcl::OrderedInterface<Vertex, std::list> >  VertexLayout;
typedef pcl::MultiLevelLayout<
    pcl::OrderedInterface<Edge, std::list> >  EdgeLayout;
typedef pcl::MultiLevelLayout<
    pcl::OrderedInterface<Face, std::list> >    FaceLayout;
typedef pcl::MultiLevelLayout<
    pcl::OrderedInterface<Volume, std::list> >    VolumeLayout;
 
 
//  GridLayoutMap
 
class GridLayoutMap
{
  public:
    typedef int Key;
 
    template <class TType>
    struct Types
    {
      typedef pcl::OrderedInterface<TType, std::list>   Interface;
      typedef typename pcl::MultiLevelLayout<Interface> Layout;
      typedef typename Interface::Element         Element;
      typedef std::map<Key, Layout>           Map;
    };
 
  public:
    template <class TType>
    bool
    has_layout(const Key& key) const;
 
    template <class TType>
    typename Types<TType>::Layout&
    get_layout(const Key& key);
 
    template <class TType>
    const typename Types<TType>::Layout&
    get_layout(const Key& key) const;
 
 
    template <class TType>
    typename Types<TType>::Map::iterator
    layouts_begin();
 
    template <class TType>
    typename Types<TType>::Map::const_iterator
    layouts_begin() const;
 
    template <class TType>
    typename Types<TType>::Map::iterator
    layouts_end();
 
    template <class TType>
    typename Types<TType>::Map::const_iterator
    layouts_end() const;
 
    template <class TType>
    typename Types<TType>::Map::iterator
    erase_layout(typename Types<TType>::Map::iterator iter);
                
    template <class TType>
    void erase_layout(const Key& key);
 
    void clear();
 
    void remove_empty_interfaces();
 
  private:
    template <class TType>
    inline typename Types<TType>::Map&
    get_layout_map();
    
    template <class TType>
    inline const typename Types<TType>::Map&
    get_layout_map() const;
 
  // \{
    inline Types<Vertex>::Map&
    get_layout_map(Vertex*);
 
    inline const Types<Vertex>::Map&
    get_layout_map(Vertex*) const;
 
    inline Types<Edge>::Map&
    get_layout_map(Edge*);
 
    inline const Types<Edge>::Map&
    get_layout_map(Edge*) const;
 
    inline Types<Face>::Map&
    get_layout_map(Face*);
 
    inline const Types<Face>::Map&
    get_layout_map(Face*) const;
 
    inline Types<Volume>::Map&
    get_layout_map(Volume*);
 
    inline const Types<Volume>::Map&
    get_layout_map(Volume*) const;
  // \}
  
  private:
    Types<Vertex>::Map  m_vertexLayoutMap;
    Types<Edge>::Map  m_edgeLayoutMap;
    Types<Face>::Map    m_faceLayoutMap;
    Types<Volume>::Map    m_volumeLayoutMap;
};
 
}// end of namespace
 
//  include implementation
#include "parallel_grid_layout_impl.hpp"
 
#endif