Line data    Source code

       1              : /*
       2              :  * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
       3              :  * Author: Sebastian Reiter
       4              :  * 
       5              :  * This file is part of UG4.
       6              :  * 
       7              :  * UG4 is free software: you can redistribute it and/or modify it under the
       8              :  * terms of the GNU Lesser General Public License version 3 (as published by the
       9              :  * Free Software Foundation) with the following additional attribution
      10              :  * requirements (according to LGPL/GPL v3 §7):
      11              :  * 
      12              :  * (1) The following notice must be displayed in the Appropriate Legal Notices
      13              :  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
      14              :  * 
      15              :  * (2) The following notice must be displayed at a prominent place in the
      16              :  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
      17              :  * 
      18              :  * (3) The following bibliography is recommended for citation and must be
      19              :  * preserved in all covered files:
      20              :  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
      21              :  *   parallel geometric multigrid solver on hierarchically distributed grids.
      22              :  *   Computing and visualization in science 16, 4 (2013), 151-164"
      23              :  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
      24              :  *   flexible software system for simulating pde based models on high performance
      25              :  *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
      26              :  * 
      27              :  * This program is distributed in the hope that it will be useful,
      28              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      29              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
      30              :  * GNU Lesser General Public License for more details.
      31              :  */
      32              : 
      33              : #ifndef __H__UG__generic_grid_object_iterator__
      34              : #define __H__UG__generic_grid_object_iterator__
      35              : 
      36              : namespace ug
      37              : {
      38              : 
      39              : ////////////////////////////////////////////////////////////////////////////////////////////////
      40              : //      GenericGridObjectIterator
      41              : ///     Use this class as a tool to create iterators to your own geometric objects.
      42              : template <class TValue, class TBaseIterator>
      43              : class GenericGridObjectIterator : public TBaseIterator
      44              : {
      45              :         friend class Grid;
      46              :         template <class TIterDest, class TIterSrc> friend TIterDest iterator_cast(const TIterSrc& iter);
      47              : 
      48              :         public:
      49              :                 typedef TValue  value_type;
      50              : 
      51              :         public:
      52              :                 GenericGridObjectIterator()     {}
      53              : 
      54              :                 GenericGridObjectIterator(const GenericGridObjectIterator& iter) :
      55            0 :                         TBaseIterator(iter)     {}
      56              : 
      57              :         ///     note that the * operator is read only.
      58              :                 inline TValue operator* () const        {return static_cast<TValue>(TBaseIterator::operator*());}
      59              : 
      60              :         protected:
      61              :                 GenericGridObjectIterator(const TBaseIterator& iter) :
      62              :                         TBaseIterator(iter)     {}
      63              : };
      64              : 
      65              : ////////////////////////////////////////////////////////////////////////////////////////////////
      66              : //      ConstGenericGridObjectIterator
      67              : ///     Use this class as a tool to create const_iterators to your own geometric objects.
      68              : template <class TValue, class TBaseIterator, class TConstBaseIterator>
      69              : class ConstGenericGridObjectIterator : public TConstBaseIterator
      70              : {
      71              :         friend class Grid;
      72              :         template <class TIterDest, class TIterSrc> friend TIterDest iterator_cast(const TIterSrc& iter);
      73              : 
      74              :         public:
      75              :                 typedef TValue  value_type;
      76              : 
      77              :         public:
      78              :                 ConstGenericGridObjectIterator()        {}
      79              : 
      80              :                 ConstGenericGridObjectIterator(const ConstGenericGridObjectIterator& iter) :
      81            0 :                         TConstBaseIterator(iter)        {}
      82              : 
      83              :                 ConstGenericGridObjectIterator(const GenericGridObjectIterator<TValue, TBaseIterator>& iter) :
      84              :                         TConstBaseIterator(iter)        {}
      85              : 
      86              :         ///     note that the * operator is read only.
      87              :                 inline TValue operator* () const        {return static_cast<TValue>(TConstBaseIterator::operator*());}
      88              : 
      89              :         protected:
      90              :                 ConstGenericGridObjectIterator(const TBaseIterator& iter) :
      91              :                         TConstBaseIterator(iter)        {}
      92              : 
      93              :                 ConstGenericGridObjectIterator(const TConstBaseIterator& iter) :
      94              :                         TConstBaseIterator(iter)        {}
      95              : };
      96              : 
      97              : ////////////////////////////////////////////////////////////////////////
      98              : //      iterator_cast
      99              : ///     You should avoid casting whenever possible!
     100              : template <class TIterDest, class TIterSrc>
     101              : inline TIterDest
     102              : iterator_cast(const TIterSrc& iter)
     103              : {
     104              :         return TIterDest(iter);
     105              : }
     106              : 
     107              : }//     end of namespace
     108              : 
     109              : #endif