MeshIteratorFortran.h

#ifndef PSCF_MESH_ITERATOR_FORTRAN_H
#define PSCF_MESH_ITERATOR_FORTRAN_H
 
/*
* PSCF - Polymer Self-Consistent Field Theory
*
* Copyright 2016 - 2022, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
#include <pscf/math/IntVec.h>   // member
 
namespace Pscf 
{
 
   using namespace Util;
 
   template <int D>
   class MeshIteratorFortran 
   {
 
   public:
 
      MeshIteratorFortran();
 
      MeshIteratorFortran(IntVec<D> const& dimensions);
 
      void setDimensions(IntVec<D> const& dimensions);
 
      void begin();
 
      void operator ++ ();
 
      bool atEnd() const;
 
      int rank() const;
 
      IntVec<D> const& position() const;
 
      IntVec<D> const& dimensions() const;
 
      int size() const;
 
      IntVec<D> const& offsets() const;
 
   private:
 
      // Dimensions of associated Mesh<D> object
      IntVec<D> dimensions_;
 
      // Offsets associated with position components
      IntVec<D> offsets_;
 
      // Grid position - vector of integer components 
      IntVec<D> position_;
 
      // Scalar rank of current node
      int  rank_;
 
      // Mesh size
      int  size_;
 
      // Has the iterator past the last grid point?
      bool atEnd_;
      
   };
   
   template <int D>
   inline bool MeshIteratorFortran<D>::atEnd() const
   {  return atEnd_; }
 
   template <int D>
   inline int MeshIteratorFortran<D>::rank() const
   {  return rank_; }
   
   template <int D>
   inline IntVec<D> const& MeshIteratorFortran<D>::position() const
   {  return position_; }
 
   template <int D>
   inline IntVec<D> const& MeshIteratorFortran<D>::dimensions() const
   {  return dimensions_; }
 
   template <int D>
   inline int MeshIteratorFortran<D>::size() const
   {  return size_; }
   
   template <int D>
   inline IntVec<D> const& MeshIteratorFortran<D>::offsets() const
   {  return offsets_; }
 
   #ifndef PSCF_MESH_ITERATOR_FORTRAN_TPP
   // Suppress implicit instantiation
   extern template class MeshIteratorFortran<1>;
   extern template class MeshIteratorFortran<2>;
   extern template class MeshIteratorFortran<3>;
   #endif
 
}
#endif