grid_base_object_traits.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-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__UG__grid_base_object_traits__
#define __H__UG__grid_base_object_traits__
 
#include "element_storage.h"
#include "generic_grid_object_iterator.h"
 
namespace ug
{
 
//  The geometry_traits. This class can be specialized by each element-type.
template <class TElem>
class geometry_traits
{};
 
 
typedef ElementStorage<Vertex>::SectionContainer::iterator      VertexIterator;
typedef ElementStorage<Vertex>::SectionContainer::const_iterator  ConstVertexIterator;
 
typedef ElementStorage<Edge>::SectionContainer::iterator      EdgeIterator;
typedef ElementStorage<Edge>::SectionContainer::const_iterator    ConstEdgeIterator;
 
typedef ElementStorage<Face>::SectionContainer::iterator        FaceIterator;
typedef ElementStorage<Face>::SectionContainer::const_iterator      ConstFaceIterator;
 
typedef ElementStorage<Volume>::SectionContainer::iterator        VolumeIterator;
typedef ElementStorage<Volume>::SectionContainer::const_iterator    ConstVolumeIterator;
 
 
 
template <>
class geometry_traits<GridObject>
{
  public:
 
    enum
    {
      CONTAINER_SECTION = -1,
      BASE_OBJECT_ID = -1
    };
};
 
 
template <>
class geometry_traits<Vertex>
{
  public:
    typedef VertexIterator    iterator;
    typedef ConstVertexIterator const_iterator;
 
    typedef Vertex  grid_base_object;
    typedef VertexDescriptor GeneralDescriptor;
    
    enum
    {
      CONTAINER_SECTION = -1,
      BASE_OBJECT_ID = VERTEX
    };
    static const ReferenceObjectID REFERENCE_OBJECT_ID = ROID_VERTEX;
};
 
 
template <>
class geometry_traits<Edge>
{
  public:
    typedef EdgeIterator    iterator;
    typedef ConstEdgeIterator const_iterator;
 
    typedef Edge  grid_base_object;
    typedef EdgeDescriptor GeneralDescriptor;
 
    enum
    {
      CONTAINER_SECTION = -1,
      BASE_OBJECT_ID = EDGE
    };
    static const ReferenceObjectID REFERENCE_OBJECT_ID = ROID_EDGE;
};
 
 
template <>
class geometry_traits<Face>
{
  public:
    typedef FaceIterator    iterator;
    typedef ConstFaceIterator const_iterator;
 
    typedef Face  grid_base_object;
    typedef FaceDescriptor GeneralDescriptor;
 
    enum
    {
      CONTAINER_SECTION = -1,
      BASE_OBJECT_ID = FACE
    };
    static const ReferenceObjectID REFERENCE_OBJECT_ID = ROID_UNKNOWN;
};
 
template <>
class geometry_traits<Volume>
{
  public:
    typedef VolumeIterator      iterator;
    typedef ConstVolumeIterator   const_iterator;
 
    typedef Volume    grid_base_object;
    typedef VolumeDescriptor GeneralDescriptor;
 
    enum
    {
      CONTAINER_SECTION = -1,
      BASE_OBJECT_ID = VOLUME
    };
    static const ReferenceObjectID REFERENCE_OBJECT_ID = ROID_UNKNOWN;
};
 
}// end of namespace
 
#endif