mapper.hh

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_GRID_COMMON_MAPPER_HH
#define DUNE_GRID_COMMON_MAPPER_HH
 
#include <utility>
 
#include <dune/common/bartonnackmanifcheck.hh>
 
namespace Dune
{
  template <typename G, typename MapperImp, typename IndexType=int>
  class Mapper
  {
  public:
 
    using Index = IndexType;
 
    template<class EntityType>
    Index index (const EntityType& e) const
    {
      CHECK_INTERFACE_IMPLEMENTATION((asImp().map(e)));
      return asImp().index(e);
    }
 
 
    Index subIndex (const typename G::Traits::template Codim<0>::Entity& e,
                    int i,
                    unsigned int codim) const
    {
      CHECK_INTERFACE_IMPLEMENTATION((asImp().map(e,i,codim)));
      return asImp().subIndex(e,i,codim);
    }
 
    auto size () const
    {
      CHECK_INTERFACE_IMPLEMENTATION((asImp().size()));
      return asImp().size();
    }
 
 
    template<class EntityType>
    bool contains (const EntityType& e, IndexType& result) const
    {
      CHECK_INTERFACE_IMPLEMENTATION((asImp().contains(e,result )));
      return asImp().contains(e,result );
    }
 
 
    bool contains (const typename G::Traits::template Codim<0>::Entity& e, int i, int cc, IndexType& result) const
    {
      CHECK_INTERFACE_IMPLEMENTATION((asImp().contains(e,i,cc,result)))
      return asImp().contains(e,i,cc,result);
    }
 
    template <class GridView>
    void update (GridView&& gridView)
    {
      CHECK_AND_CALL_INTERFACE_IMPLEMENTATION((asImp().update(std::forward<GridView>(gridView))));
    }
 
    [[deprecated("Use update(gridView) instead! Will be removed after release 2.8. Mappers have to implement update(gridView).")]]
    void update ()
    {
      CHECK_AND_CALL_INTERFACE_IMPLEMENTATION((asImp().update()));
    }
 
  private:
    MapperImp& asImp () {return static_cast<MapperImp &> (*this);}
    const MapperImp& asImp () const {return static_cast<const MapperImp &>(*this);}
  };
 
#undef CHECK_INTERFACE_IMPLEMENTATION
#undef CHECK_AND_CALL_INTERFACE_IMPLEMENTATION
 
}
#endif