Grid.h

#ifndef UTIL_GRID_H
#define UTIL_GRID_H
 
/*
* Util Package - C++ Utilities for Scientific Computation
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
#include <util/global.h>
#include <util/space/IntVector.h>
 
namespace Util
{
 
   class Grid
   {
 
   public:
 
      Grid();
 
      Grid(const IntVector& dimensions);
 
      // Compiler default destructor.
 
      // Compiler copy constructor.
 
      void setDimensions(const IntVector& dimensions);
 
      IntVector dimensions() const;
 
      int dimension(int i) const;
 
      int size() const;
 
      IntVector position(int rank) const;
 
      int rank(const IntVector& position) const;
 
      bool isInGrid(int coordinate, int i) const;
 
      bool isInGrid(IntVector& position) const;
 
      int shift(int& coordinate, int i) const;
 
      IntVector shift(IntVector& position) const;
 
   private:
 
      IntVector dimensions_;
 
      IntVector offsets_;
 
      int size_;
 
   };
 
   // Inline member functions
 
   inline IntVector Grid::dimensions() const
   {  return dimensions_; }
 
   inline int Grid::dimension(int i) const
   {
      assert(i >=0);
      assert(i < Dimension);  
      return dimensions_[i]; 
   }
 
   inline int Grid::size() const
   {  return size_; }
 
} 
#endif