subgrid.hpp

/*
 * subgrid.hpp
 *
 * Created on: 18 Sep 2012
 * Author: Holger Schmitz
 * Email: holger@notjustphysics.com
 *
 * Copyright 2012 Holger Schmitz
 *
 * This file is part of Schnek.
 *
 * Schnek is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Schnek 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Schnek.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef SCHNEK_SUBGRID_HPP_
#define SCHNEK_SUBGRID_HPP_

#include "grid.hpp"
#include "range.hpp"

namespace schnek {

template<
  typename T,
  int rank,
  class BaseGrid
>
class SubGridStorage {
  public:
    typedef Array<int,rank> IndexType;
    typedef BaseGrid BaseGridType;
    typedef Range<int, rank> DomainType;
  protected:
    BaseGridType *baseGrid;
    DomainType domain;
    IndexType dims;

  public:

    class storage_iterator {
      protected:
        typename DomainType::iterator it;
        BaseGridType *baseGrid;
        T* element;
        storage_iterator(typename DomainType::iterator it_, BaseGridType *baseGrid_)
          : it(it_), baseGrid(baseGrid_), element(&baseGrid->get(*it)) {}

        friend class SubGridStorage;

      public:
        T& operator*() { return *element;}
        storage_iterator &operator++()
        {
          ++it;
          element = &baseGrid->get(*it);
          return *this;
        }
        bool operator==(const storage_iterator &SI)
        { return (it==SI.it) && (baseGrid == SI.baseGrid); }

        bool operator!=(const storage_iterator &SI)
        { return (it!=SI.it) || (baseGrid != SI.baseGrid); }
    };

    class const_storage_iterator {
      protected:
        typename DomainType::iterator it;
        const BaseGridType *baseGrid;
        const T* element;
        const_storage_iterator(typename DomainType::iterator it_, BaseGridType *baseGrid_)
          : it(it_), baseGrid(baseGrid_), element(&baseGrid->get(*it)) {}

        friend class SubGridStorage;

      public:
        const T& operator*() { return *element;}
        const_storage_iterator &operator++()
        {
          ++it;
          element = &baseGrid->get(*it);
          return *this;
        }
        bool operator==(const const_storage_iterator &SI)
        { return (it==SI.it) && (baseGrid == SI.baseGrid); }
        bool operator!=(const const_storage_iterator &SI)
        { return (it!=SI.it) || (baseGrid != SI.baseGrid); }
    };

    SubGridStorage();

    SubGridStorage(const IndexType &low_, const IndexType &high_);

    void resize(const IndexType &low_, const IndexType &high_);

    T &get(const IndexType &index)
    {
      //typename BaseGrid::CheckingPolicy<rank>::check(index, domain.getLo(), domain.getHi());
      return baseGrid->get(baseGrid->check(index, domain.getLo(), domain.getHi()));
    }

    const T &get(const IndexType &index) const
    {
      //typename BaseGrid::CheckingPolicy<rank>::check(index, domain.getLo(), domain.getHi());
      return baseGrid->get(baseGrid->check(index, domain.getLo(), domain.getHi()));
    }

    const IndexType& getLo() const { return domain.getLo(); }
    const IndexType& getHi() const { return domain.getHi(); }
    const IndexType& getDims() const { return dims; }

    int getLo(int k) const { return domain.getLo()[k]; }
    int getHi(int k) const { return domain.getHi()[k]; }
    int getDims(int k) const { return dims[k]; }

    storage_iterator begin() { return storage_iterator(domain.begin(), baseGrid); }
    storage_iterator end() { return storage_iterator(domain.end(), baseGrid); }

    const_storage_iterator cbegin() const { return const_storage_iterator(domain.cbegin(), baseGrid); }
    const_storage_iterator cend() const { return const_storage_iterator(domain.cend(), baseGrid); }

    void setBaseGrid(BaseGridType &baseGrid_) { baseGrid = &baseGrid_; }

};

template<
  class BaseGrid,
  template<int> class CheckingPolicy = GridNoArgCheck
>
class SubGrid
  : public GridBase
    <
      typename BaseGrid::value_type,
      BaseGrid::Rank,
      CheckingPolicy<BaseGrid::Rank>,
      SubGridStorage<
        typename BaseGrid::value_type,
        BaseGrid::Rank,
        BaseGrid
      >
    >
{
  private:
    typedef GridBase
        <
          typename BaseGrid::value_type,
          BaseGrid::Rank,
          CheckingPolicy<BaseGrid::Rank>,
          SubGridStorage<
            typename BaseGrid::value_type,
            BaseGrid::Rank,
            BaseGrid
          >
        > ParentType;

  public:
    enum {Rank = BaseGrid::Rank};
    typedef typename BaseGrid::value_type value_type;
    typedef Array<int,Rank> IndexType;
    typedef Range<int,Rank> RangeType;
    typedef BaseGrid BaseGridType;
    SubGrid();

    SubGrid(const IndexType &size, BaseGridType &baseGrid_);

    SubGrid(const IndexType &low, const IndexType &high, BaseGridType &baseGrid_);

    SubGrid(const RangeType &range, BaseGridType &baseGrid_);

};


} // namespace schnek

#include "subgrid.t"

#endif // SCHNEK_SUBGRID_HPP_