type.hh

Go to the documentation of this file.

// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_GEOMETRY_TYPE_HH
#define DUNE_GEOMETRY_TYPE_HH
 
#include <cassert>
#include <cstdint>
 
#include <string>
 
#include <dune/common/deprecated.hh>
#include <dune/common/exceptions.hh>
#include <dune/common/keywords.hh>
#include <dune/common/typetraits.hh>
#include <dune/common/unused.hh>
 
namespace Dune
{
 
  // forward declaration needed for deprecated makeFromVertices
  class GeometryType;
  GeometryType geometryTypeFromVertexCount(unsigned int dim, unsigned int vertices);
 
  namespace Impl
  {
 
    enum TopologyConstruction { pyramidConstruction = 0, prismConstruction = 1 };
 
 
 
    // Basic Topology Types
    // --------------------
 
    struct Point
    {
      static const unsigned int dimension = 0;
      static const unsigned int numCorners = 1;
 
      static const unsigned int id = 0;
 
      static std::string name () { return "p"; }
    };
 
 
    template< class BaseTopology >
    struct Prism
    {
      static const unsigned int dimension = BaseTopology::dimension + 1;
      static const unsigned int numCorners = 2 * BaseTopology::numCorners;
 
      static const unsigned int id = BaseTopology::id | ((unsigned int)prismConstruction << (dimension-1));
 
      static std::string name () { return BaseTopology::name() + "l"; }
    };
 
 
    template< class BaseTopology >
    struct Pyramid
    {
      static const unsigned int dimension = BaseTopology::dimension + 1;
      static const unsigned int numCorners = BaseTopology::numCorners + 1;
 
      static const unsigned int id = BaseTopology::id | ((unsigned int)pyramidConstruction << (dimension-1));
 
      static std::string name () { return BaseTopology::name() + "o"; }
    };
 
 
 
    // Properties of Topologies
    // ------------------------
 
    template< class Topology >
    struct IsSimplex
      : public std::integral_constant< bool, (Topology::id >> 1) == 0 >
    {};
 
    template< class Topology >
    struct IsCube
      : public std::integral_constant< bool,  (Topology::id | 1) == (1 << Topology::dimension) - 1 >
    {};
 
 
 
    // Dynamic Topology Properties
    // ---------------------------
 
    inline static unsigned int numTopologies ( int dim ) noexcept
    {
      return (1u << dim);
    }
 
    inline bool static isPyramid ( unsigned int topologyId, int dim, int codim = 0 ) noexcept
    {
      assert( (dim > 0) && (topologyId < numTopologies( dim )) );
      assert( (0 <= codim) && (codim < dim) );
      return (((topologyId & ~1) & (1u << (dim-codim-1))) == 0);
    }
 
    inline static bool isPrism ( unsigned int topologyId, int dim, int codim = 0 ) noexcept
    {
      assert( (dim > 0) && (topologyId < numTopologies( dim )) );
      assert( (0 <= codim) && (codim < dim) );
      return (( (topologyId | 1) & (1u << (dim-codim-1))) != 0);
    }
 
    inline static bool isTopology ( TopologyConstruction construction, unsigned int topologyId, int dim, int codim = 0 ) noexcept
    {
      assert( (dim > 0) && (topologyId < numTopologies( dim )) );
      assert( (0 <= codim) && (codim <= dim) );
      return (codim >= (dim-1)) || (((topologyId >> (dim-codim-1)) & 1) == (unsigned int)construction);
    }
 
    inline static unsigned int baseTopologyId ( unsigned int topologyId, int dim, int codim = 1 ) noexcept
    {
      assert( (dim >= 0) && (topologyId < numTopologies( dim )) );
      assert( (0 <= codim) && (codim <= dim) );
      return topologyId & ((1u << (dim-codim)) - 1);
    }
 
 
 
    // SimplexTopology
    // ---------------
 
    template< unsigned int dim >
    struct SimplexTopology
    {
      typedef Pyramid< typename SimplexTopology< dim-1 >::type > type;
    };
 
    template<>
    struct SimplexTopology< 0 >
    {
      typedef Point type;
    };
 
 
 
    // CubeTopology
    // ------------
 
    template< unsigned int dim >
    struct CubeTopology
    {
      typedef Prism< typename CubeTopology< dim-1 >::type > type;
    };
 
    template<>
    struct CubeTopology< 0 >
    {
      typedef Point type;
    };
 
 
 
    // PyramidTopology
    // ---------------
 
    template< unsigned int dim >
    struct PyramidTopology
    {
      typedef Pyramid< typename CubeTopology< dim-1 >::type > type;
    };
 
 
 
    // PrismTopology
    // -------------
 
    template< unsigned int dim >
    struct PrismTopology
    {
      typedef Prism< typename SimplexTopology< dim-1 >::type > type;
    };
 
 
 
 
    // IfTopology
    // ----------
 
    template< template< class > class Operation, int dim, class Topology = Point >
    struct IfTopology
    {
      template< class... Args >
      static auto apply ( unsigned int topologyId, Args &&... args )
      {
        if( topologyId & 1 )
          return IfTopology< Operation, dim-1, Prism< Topology > >::apply( topologyId >> 1, std::forward< Args >( args )... );
        else
          return IfTopology< Operation, dim-1, Pyramid< Topology > >::apply( topologyId >> 1, std::forward< Args >( args )... );
      }
    };
 
    template< template< class > class Operation, class Topology >
    struct IfTopology< Operation, 0, Topology >
    {
      template< class... Args >
      static auto apply ( unsigned int topologyId, Args &&... args )
      {
        DUNE_UNUSED_PARAMETER( topologyId );
        return Operation< Topology >::apply( std::forward< Args >( args )... );
      }
    };
 
  } // namespace Impl
 
 
 
  // GeometryType
  // -------------
 
  class GeometryType
  {
  public:
 
    enum
    BasicType {
      simplex,       
      cube,          
      pyramid,       
      prism,         
      extended,      
      none           
    };
 
  private:
 
    unsigned char dim_;
 
    bool none_;
 
    unsigned int topologyId_;
 
    // Internal type used for the Id. The exact nature of this type is kept
    // as an implementation detail on purpose. We use a scoped enum here because scoped enums
    // can be used as template parameters, but are not implicitly converted to other integral
    // types by the compiler. That way, we avoid unfortunate implicit conversion chains, e.g.
    // people trying to work with GlobalGeometryTypeIndex, but forgetting to actually call
    // GlobalGeometryTypeIndex::index(gt) and just using gt directly.
    enum class IdType : std::uint64_t
    {};
 
  public:
 
    using Id = IdType;
 
    constexpr operator Id() const
    {
      // recreate the exact storage layout that this class is using, making conversion
      // extremely cheap
      std::uint64_t id = dim_ | (std::uint64_t(none_) << 8) | (std::uint64_t(topologyId_) << 32);
      return static_cast<Id>(id);
    }
 
    constexpr GeometryType(Id id)
      : dim_(static_cast<std::uint64_t>(id) & 0xFF)
      , none_(static_cast<std::uint64_t>(id) & 0x100)
      , topologyId_(static_cast<std::uint64_t>(id) >> 32)
    {}
 
 
    constexpr GeometryType ()
      : dim_(0), none_(true), topologyId_(0)
    {}
 
    DUNE_NO_DEPRECATED_BEGIN
    GeometryType(BasicType basicType, unsigned int dim)
      DUNE_DEPRECATED_MSG("The GeometryType constructor taking BasicType is deprecated and will be removed after DUNE 2.6")
      : dim_(dim), none_((basicType == GeometryType::none) ? true : false), topologyId_(0)
    {
      if (dim < 2)
        return;
      switch( basicType )
      {
      case GeometryType::simplex :
        topologyId_ = 0;
        break;
      case GeometryType::cube :
        topologyId_ = ((1 << dim) - 1);
        break;
      case GeometryType::pyramid :
        if (dim == 3)
          topologyId_ = 0b0011;
        else
          DUNE_THROW( RangeError,
                      "Invalid basic geometry type: no pyramids for dimension " << dim << "." );
        break;
      case GeometryType::prism :
        if (dim == 3)
          topologyId_ = 0b0101;
        else
          DUNE_THROW( RangeError,
                      "Invalid basic geometry type: no prisms for dimension " << dim << "." );
        break;
      case GeometryType::none :
        break;
      default :
        DUNE_THROW( RangeError,
                    "Invalid basic geometry type: " << basicType << " for dimension " << dim << "." );
      }
    }
    DUNE_NO_DEPRECATED_END
 
    constexpr GeometryType(unsigned int topologyId, unsigned int dim, bool none)
      : dim_(dim), none_(none), topologyId_(topologyId)
    {}
 
    constexpr GeometryType(unsigned int topologyId, unsigned int dim)
      : dim_(dim), none_(false), topologyId_(topologyId)
    {}
 
    template<class TopologyType,
      class = Dune::void_t<decltype(TopologyType::dimension), decltype(TopologyType::id)>>
    explicit GeometryType(TopologyType t)
      : dim_(TopologyType::dimension), none_(false), topologyId_(TopologyType::id)
    {
      DUNE_UNUSED_PARAMETER(t);
    }
 
    DUNE_DEPRECATED_MSG("GeometryType(unsigned dim) is deprecated in DUNE 2.7, please use Dune::GeometryTypes::cube(dim) instead")
    explicit GeometryType(unsigned int dim)
      : dim_(dim), none_(false), topologyId_(0)
    {
      assert(dim < 2);
    }
 
    // We need this constructor for "int" and "unsigned int",
    // because otherwise GeometryType(int) would try to call the
    // generic GeometryType(TopologyType) constructor
    DUNE_DEPRECATED_MSG("GeometryType(dim) is deprecated in DUNE 2.7, please use Dune::GeometryTypes::cube(dim) instead")
    explicit GeometryType(int dim)
      : dim_(dim), none_(false), topologyId_(0)
    {
      assert(dim < 2);
    }
 
 
    DUNE_DEPRECATED_MSG("makeVertex() is deprecated in DUNE 2.6, please use Dune::GeometryTypes::vertex instead")
    void makeVertex() {
      none_  = false;
      dim_ = 0;
      topologyId_ = 0;
    }
 
    DUNE_DEPRECATED_MSG("makeLine() is deprecated in DUNE 2.6, please use Dune::GeometryTypes::line instead")
    void makeLine() {
      none_  = false;
      dim_ = 1;
      topologyId_ = 0;
    }
 
    DUNE_DEPRECATED_MSG("makeTriangle() is deprecated in DUNE 2.6, please use Dune::GeometryTypes::triangle instead")
    void makeTriangle() {
      none_  = false;
      dim_ = 2;
      topologyId_ = 0;
    }
 
    DUNE_DEPRECATED_MSG("makeQuadrilateral() is deprecated in DUNE 2.6, please use Dune::GeometryTypes::quadrilateral instead")
    void makeQuadrilateral() {
      none_  = false;
      dim_ = 2;
      topologyId_ = 0b0011;
    }
 
    DUNE_DEPRECATED_MSG("makeTetrahedron() is deprecated in DUNE 2.6, please use Dune::GeometryTypes::tetrahedron instead")
    void makeTetrahedron() {
      none_  = false;
      dim_ = 3;
      topologyId_ = 0;
    }
 
    DUNE_DEPRECATED_MSG("makePyramid() is deprecated in DUNE 2.6, please use Dune::GeometryTypes::pyramid instead")
    void makePyramid() {
      none_  = false;
      dim_ = 3;
      topologyId_ = 0b0011;
    }
 
    DUNE_DEPRECATED_MSG("makePrism() is deprecated in DUNE 2.6, please use Dune::GeometryTypes::prism instead")
    void makePrism() {
      none_  = false;
      dim_ = 3;
      topologyId_ = 0b0101;       // (1 << (dim_-1)) - 1;
    }
 
    DUNE_DEPRECATED_MSG("makeHexahedron() is deprecated in DUNE 2.6, please use Dune::GeometryTypes::hexahedron instead")
    void makeHexahedron() {
      none_  = false;
      dim_ = 3;
      topologyId_ = 0b0111;
    }
 
    DUNE_DEPRECATED_MSG("makeSimplex(dim) is deprecated in DUNE 2.6, please use Dune::GeometryTypes::simplex(dim) instead")
    void makeSimplex(unsigned int dim) {
      none_  = false;
      dim_ = dim;
      topologyId_ = 0;
    }
 
    DUNE_DEPRECATED_MSG("makeCube(dim) is deprecated in DUNE 2.6, please use Dune::GeometryTypes::cube(dim) instead")
    void makeCube(unsigned int dim) {
      none_  = false;
      dim_ = dim;
      topologyId_ = ((dim>1) ? ((1 << dim) - 1) : 0);
    }
 
    DUNE_DEPRECATED_MSG("makeNone(dim) is deprecated in DUNE 2.6, please use Dune::GeometryTypes::none(dim) instead")
    void makeNone(unsigned int dim) {
      none_ = true;
      dim_ = dim;
      topologyId_  = 0;
    }
 
    void makeFromVertices(unsigned int dim, unsigned int vertices) DUNE_DEPRECATED_MSG("Use the utility function geometryTypeFromVertexCount(...) instead.")
    {
      *this = geometryTypeFromVertexCount(dim, vertices);
      return;
    }
 
    constexpr bool isVertex() const {
      return dim_==0;
    }
 
    constexpr bool isLine() const {
      return dim_==1;
    }
 
    constexpr bool isTriangle() const {
      return ! none_ && dim_==2 && (topologyId_ | 1) == 0b0001;
    }
 
    constexpr bool isQuadrilateral() const {
      return ! none_ && dim_==2 && (topologyId_ | 1) == 0b0011;
    }
 
    constexpr bool isTetrahedron() const {
      return ! none_ && dim_==3 && (topologyId_ | 1) == 0b0001;
    }
 
    constexpr bool isPyramid() const {
      return ! none_ && dim_==3 && (topologyId_ | 1) == 0b0011;
    }
 
    constexpr bool isPrism() const {
      return ! none_ && dim_==3 && (topologyId_ | 1) == 0b0101;
    }
 
    constexpr bool isHexahedron() const {
      return ! none_ && dim_==3 && (topologyId_ | 1) == 0b0111;
    }
 
    constexpr bool isSimplex() const {
      return ! none_ && (topologyId_ | 1) == 1;
    }
 
    constexpr bool isCube() const {
      return ! none_ && ((topologyId_ ^ ((1 << dim_)-1)) >> 1 == 0);
    }
 
    constexpr bool isNone() const {
      return none_;
    }
 
    constexpr unsigned int dim() const {
      return dim_;
    }
 
    constexpr unsigned int id() const {
      return topologyId_;
    }
 
    constexpr bool operator==(const GeometryType& other) const {
      return ( ( none_ == other.none_ )
               && ( ( none_ == true )
                    || ( ( dim_ == other.dim_ )
                         && ( (topologyId_ >> 1) == (other.topologyId_ >> 1) )
                         )
                    )
               );
    }
 
    constexpr bool operator!=(const GeometryType& other) const {
      return ! ((*this)==other);
    }
 
    constexpr bool operator < (const GeometryType& other) const {
      return ( ( none_ < other.none_ )
               || ( !( other.none_ < none_ )
                    && ( ( dim_ < other.dim_ )
                         || ( (other.dim_ == dim_)
                              && ((topologyId_ >> 1) < (other.topologyId_ >> 1) )
                              )
                         )
                    )
               );
    }
 
  };
 
  inline std::ostream& operator<< (std::ostream& s, const GeometryType& a)
  {
    if (a.isSimplex())
    {
      s << "(simplex, " << a.dim() << ")";
      return s;
    }
    if (a.isCube())
    {
      s << "(cube, " << a.dim() << ")";
      return s;
    }
    if (a.isPyramid())
    {
      s << "(pyramid, 3)";
      return s;
    }
    if (a.isPrism())
    {
      s << "(prism, 3)";
      return s;
    }
    if (a.isNone())
    {
      s << "(none, " << a.dim() << ")";
      return s;
    }
    s << "(other [" << a.id() << "], " << a.dim() << ")";
    return s;
  }
 
  DUNE_NO_DEPRECATED_BEGIN
  inline std::ostream& operator<< (std::ostream& s, GeometryType::BasicType type)
  {
    switch (type) {
    case GeometryType::simplex :
      s << "simplex";
      break;
    case GeometryType::cube :
      s << "cube";
      break;
    case GeometryType::pyramid :
      s << "pyramid";
      break;
    case GeometryType::prism :
      s << "prism";
      break;
    case GeometryType::extended :
      s << "other";
    case GeometryType::none :
      s << "none";
      break;
    default :
      DUNE_THROW(Exception, "invalid GeometryType::BasicType");
    }
    return s;
  }
  DUNE_NO_DEPRECATED_END
 
 
 
  namespace GeometryTypes {
 
 
    inline constexpr GeometryType simplex(unsigned int dim)
    {
      return GeometryType(0,dim,false);
    }
 
 
    inline constexpr GeometryType cube(unsigned int dim)
    {
      return GeometryType(((dim>1) ? ((1 << dim) - 1) : 0),dim,false);
    }
 
 
    inline constexpr GeometryType none(unsigned int dim)
    {
      return GeometryType(0,dim,true);
    }
 
#ifndef __cpp_inline_variables
    namespace {
#endif
 
 
      DUNE_INLINE_VARIABLE constexpr GeometryType vertex = GeometryType(0,0,false);
 
 
      DUNE_INLINE_VARIABLE constexpr GeometryType line = GeometryType(0,1,false);
 
 
      DUNE_INLINE_VARIABLE constexpr GeometryType triangle = simplex(2);
 
 
      DUNE_INLINE_VARIABLE constexpr GeometryType quadrilateral = cube(2);
 
 
      DUNE_INLINE_VARIABLE constexpr GeometryType tetrahedron = simplex(3);
 
 
      DUNE_INLINE_VARIABLE constexpr GeometryType pyramid = GeometryType(0b0011,3,false);
 
 
      DUNE_INLINE_VARIABLE constexpr GeometryType prism = GeometryType(0b0101,3,false);
 
 
      DUNE_INLINE_VARIABLE constexpr GeometryType hexahedron = cube(3);
 
#ifndef __cpp_inline_variables
    }
#endif
 
  }
 
 
} // namespace Dune
 
// include utility header needed for deprecated makeFromVertices
#include "utility/typefromvertexcount.hh"
 
#endif // DUNE_GEOMETRY_TYPE_HH