CN.hpp

Go to the documentation of this file.

#ifndef MOAB_CN_HPP
#define MOAB_CN_HPP

#include <vector>
#include <algorithm>
#include <cassert>

#include "moab/EntityType.hpp"

namespace moab {

enum {
  MAX_SUB_ENTITIES = 12,
  MAX_SUB_ENTITY_VERTICES = 9
};

typedef std::pair<EntityType, EntityType> DimensionPair;

class CN
{
private:

  static const char *entityTypeNames[];
  
  CN();

  static short int numberBasis;

  static void SwitchBasis(const int old_basis, const int new_basis);
  
  static short increasingInts[];
  
public:

  enum { MAX_NODES_PER_ELEMENT = 27 };
  enum { MID_EDGE_BIT   = 1<<1,
         MID_FACE_BIT   = 1<<2,
         MID_REGION_BIT = 1<<3 };

  enum {INTERSECT = 0, UNION};

    // each entity type has two ConnMap objects, holding information about the bounding
    // edges and faces for each entity; see comment for mConnectivityMap
    // (this struct not documented with Doxygen)
  struct ConnMap
  {
      // Topological dimension of this entry
    short int topo_dimension;

      // Number of sub-elements of this dimension
    short int num_sub_elements;
    
      // Number of nodes in each sub-element of this dimension
    short int num_corners_per_sub_element[MAX_SUB_ENTITIES];

      // Type of each sub-element
    EntityType target_type[MAX_SUB_ENTITIES];

      // Connectivity of each of the sub-elements
    short int conn[MAX_SUB_ENTITIES][MAX_SUB_ENTITY_VERTICES];
  };

    // mConnectivityMap[i=entity type][j=0,1,2]:
    //  num_sub_elements = # bounding edges(j=0) or faces(j=1) for entity type i, or self (j=2)
    //  num_corners_per_sub_element[k] (k=0..num_sub_elements-1) = number of nodes in sub-facet k
    //    (can vary over sub-facets, e.g. faces bounding a pyramid) or self (j=2)
    //  target_type[k] = entity type of sub-facet k (e.g. MBTRI or MBQUAD bounding a pyramid) or self (j=2)
    //  conn[k][l] (l=0..CN::VerticesPerEntity[target_type[k]]) = vertex connectivity of sub-facet k,
    //    with respect to entity i's canonical vertex ordering, or self (j=2)
    // (not documented with Doxygen)
  static const ConnMap mConnectivityMap[MBMAXTYPE][3];

    // structure used to define reverse canonical ordering information
    // (not documented with Doxygen)
  struct UpConnMap
  {
      // Number of higher-dimensional entities using each sub-entity
    short int num_targets_per_source_element[MAX_SUB_ENTITIES];

      // Higher-dimensional entities using each sub-entity
    short int targets_per_source_element[MAX_SUB_ENTITIES][MAX_SUB_ENTITIES];
  };

    // Reverse canonical numbering, duplicates data in mConnectivityMap, but 
    // connectivity data in this table must be in ascending order (used for
    // efficient sorting)
    // (not documented with Doxygen)
  static const UpConnMap mUpConnMap[MBMAXTYPE][4][4];
    
    // Mid-node bits indexed by number of nodes in element
  static const unsigned char midNodesPerType[MBMAXTYPE][MAX_NODES_PER_ELEMENT+1];

  static short int permuteVec[MBMAXTYPE][3][MAX_SUB_ENTITIES+1];
  static short int revPermuteVec[MBMAXTYPE][3][MAX_SUB_ENTITIES+1];
  
  static const DimensionPair TypeDimensionMap[];

  static short int GetBasis();
  
  static void SetBasis(const int in_basis);

  static inline
  const char *EntityTypeName(const EntityType this_type);
  
  static EntityType EntityTypeFromName(const char *name);
  
  static inline
  short int Dimension(const EntityType t);

  static inline
  short int VerticesPerEntity(const EntityType t);
  
  static inline
  short int NumSubEntities(const EntityType t, const int d);

  static inline
  EntityType SubEntityType(const EntityType this_type,
                             const int sub_dimension,
                             const int index);
  
  static inline
  void SubEntityVertexIndices(const EntityType this_type, 
                              const int sub_dimension,
                              const int sub_index,
                              int sub_entity_conn[]);
  
  static inline
  const short* SubEntityVertexIndices( const EntityType this_type, 
                                       const int sub_dimension,
                                       const int sub_index,
                                       EntityType& sub_type,
                                       int& num_sub_ent_vertices );
  
  static void SubEntityNodeIndices(const EntityType this_topo, 
                                   const int num_nodes,
                                   const int sub_dimension,
                                   const int sub_index,
                                   EntityType& sub_entity_topo,
                                   int& num_sub_entity_nodes,
                                   int sub_entity_conn[]);

  static void SubEntityConn(const void *parent_conn, const EntityType parent_type,
                            const int sub_dimension,
                            const int sub_index,
                            void *sub_entity_conn, int &num_sub_vertices);

  static short int AdjacentSubEntities(const EntityType this_type,
                                 const int *source_indices,
                                 const int num_source_indices,
                                 const int source_dim,
                                 const int target_dim,
                                 std::vector<int> &index_list,
                                 const int operation_type = CN::INTERSECT);

  static short int SideNumber(const EntityType parent_type, const int *parent_conn, 
                              const int *child_conn, const int child_num_verts,
                              const int child_dim,
                        int &side_number, int &sense, int &offset);
  static short int SideNumber(const EntityType parent_type, const unsigned int *parent_conn, 
                        const unsigned int *child_conn, const int child_num_verts,
                        const int child_dim,
                        int &side_number, int &sense, int &offset);
  static short int SideNumber(const EntityType parent_type, const long *parent_conn, 
                        const long *child_conn, const int child_num_verts,
                        const int child_dim,
                        int &side_number, int &sense, int &offset);
  static short int SideNumber(const EntityType parent_type, const unsigned long *parent_conn, 
                        const unsigned long *child_conn, const int child_num_verts,
                        const int child_dim,
                        int &side_number, int &sense, int &offset);
  static short int SideNumber(const EntityType parent_type, void * const *parent_conn, 
                        void * const *child_conn, const int child_num_verts,
                        const int child_dim,
                        int &side_number, int &sense, int &offset);

  static short int SideNumber(const EntityType parent_type,
                        const int *child_conn_indices, const int child_num_verts,
                        const int child_dim,
                        int &side_number, int &sense, int &offset);

  static short int OppositeSide(const EntityType parent_type,
                          const int child_index,
                          const int child_dim,
                          int &opposite_index,
                          int &opposite_dim);

  static bool ConnectivityMatch(const int *conn1,
                                const int *conn2,
                                const int num_vertices,
                                int &direct, int &offset);
  static bool ConnectivityMatch(const unsigned int *conn1,
                                const unsigned int *conn2,
                                const int num_vertices,
                                int &direct, int &offset);
  static bool ConnectivityMatch(const long* conn1,
                                const long* conn2,
                                const int num_vertices,
                                int& direct, int& offset );
  static bool ConnectivityMatch(const unsigned long* conn1,
                                const unsigned long* conn2,
                                const int num_vertices,
                                int &direct, int& offset );
  static bool ConnectivityMatch(void* const* conn1,
                                void* const* conn2,
                                const int num_vertices,
                                int& direct, int& offset );

  static inline
  void setPermutation(const EntityType t, const int dim, short int *pvec, 
                      const int num_entries, const bool is_reverse = false);

  static inline
  void resetPermutation(const EntityType t, const int dim);
  
  static int permuteThis(const EntityType t, const int dim, int *pvec, 
                         const int indices_per_ent, const int num_entries);
  static int permuteThis(const EntityType t, const int dim, unsigned int *pvec, 
                         const int indices_per_ent, const int num_entries);
  static int permuteThis(const EntityType t, const int dim, long *pvec, 
                         const int indices_per_ent, const int num_entries);
  static int permuteThis(const EntityType t, const int dim, void **pvec, 
                         const int indices_per_ent, const int num_entries);

  static int revPermuteThis(const EntityType t, const int dim, int *pvec, 
                            const int indices_per_ent, const int num_entries);
  static int revPermuteThis(const EntityType t, const int dim, unsigned int *pvec, 
                            const int indices_per_ent, const int num_entries);
  static int revPermuteThis(const EntityType t, const int dim, long *pvec, 
                            const int indices_per_ent, const int num_entries);
  static int revPermuteThis(const EntityType t, const int dim, void **pvec, 
                            const int indices_per_ent, const int num_entries);

  static inline
  bool HasMidEdgeNodes(const EntityType this_type, 
                       const int num_verts);

  static inline
  bool HasMidFaceNodes(const EntityType this_type, 
                       const int num_verts);

  static inline
  bool HasMidRegionNodes(const EntityType this_type, 
                         const int num_verts);

  static inline
  void HasMidNodes(const EntityType this_type, 
                   const int num_verts, 
                   int mid_nodes[4]);

  static inline
  int HasMidNodes( const EntityType this_type, const int num_verts );

  static void HONodeParent( EntityType elem_type,
                            int num_nodes, 
                            int ho_node_index,
                            int &parent_dim, 
                            int &parent_index );

  static short int HONodeIndex(const EntityType this_type, const int num_verts,
                         const int subfacet_dim, const int subfacet_index);
};

inline short int CN::GetBasis() {return numberBasis;}
  
inline const char *CN::EntityTypeName(const EntityType this_type) 
{
  return entityTypeNames[this_type];
}

inline short int CN::Dimension(const EntityType t) 
{
  return mConnectivityMap[t][0].topo_dimension;
}

inline short int CN::VerticesPerEntity(const EntityType t) 
{
  return (MBVERTEX == t ? (short int) 1 : mConnectivityMap[t][mConnectivityMap[t][0].topo_dimension-1].num_corners_per_sub_element[0]);
}

inline short int CN::NumSubEntities(const EntityType t, const int d)
{
  return (t != MBVERTEX && d > 0 ? mConnectivityMap[t][d-1].num_sub_elements :
          (d ? (short int) -1 : VerticesPerEntity(t)));
}

inline EntityType CN::SubEntityType(const EntityType this_type,
                                        const int sub_dimension,
                                        const int index) 
{
  
  return (!sub_dimension ? MBVERTEX : 
          (Dimension(this_type) == sub_dimension && 0 == index ? this_type :
          mConnectivityMap[this_type][sub_dimension-1].target_type[index]));
}

inline const short* CN::SubEntityVertexIndices( const EntityType this_type, 
                                                  const int sub_dimension,
                                                  const int index,
                                                  EntityType& sub_type,
                                                  int& n ) 
{
  if (sub_dimension == 0) {
    n = 1;
    sub_type = MBVERTEX;
    return increasingInts + index;
  }
  else {
    const CN::ConnMap& map = mConnectivityMap[this_type][sub_dimension-1];
    sub_type = map.target_type[index];
    n = map.num_corners_per_sub_element[index];
    return map.conn[index];
  }
}
  
inline void CN::SubEntityVertexIndices(const EntityType this_type, 
                                         const int sub_dimension,
                                         const int index,
                                         int sub_entity_conn[]) 
{
  EntityType type;
  int n;
  const short* indices = SubEntityVertexIndices( this_type, sub_dimension, index, type, n );
  std::copy( indices, indices+n, sub_entity_conn );
}

inline bool CN::HasMidEdgeNodes(const EntityType this_type, 
                                     const int num_nodes)
{
  const int bits = HasMidNodes( this_type, num_nodes );
  return static_cast<bool>( (bits & (1<<1)) >> 1 );
}

inline bool CN::HasMidFaceNodes(const EntityType this_type, 
                                       const int num_nodes)
{
  const int bits = HasMidNodes( this_type, num_nodes );
  return static_cast<bool>( (bits & (1<<2)) >> 2 );
}

inline bool CN::HasMidRegionNodes(const EntityType this_type, 
                                         const int num_nodes)
{
  const int bits = HasMidNodes( this_type, num_nodes );
  return static_cast<bool>( (bits & (1<<3)) >> 3 );
}

inline int CN::HasMidNodes( const EntityType this_type, const int num_nodes )
{
  assert( (unsigned)num_nodes <= (unsigned)MAX_NODES_PER_ELEMENT );
  return midNodesPerType[this_type][num_nodes];
}
  

inline void CN::HasMidNodes(const EntityType this_type, const int num_nodes,
                              int mid_nodes[4])
{
  const int bits = HasMidNodes( this_type, num_nodes );
  mid_nodes[0] = 0;
  mid_nodes[1] = (bits & (1<<1)) >> 1;
  mid_nodes[2] = (bits & (1<<2)) >> 2;
  mid_nodes[3] = (bits & (1<<3)) >> 3;
}

inline void CN::setPermutation(const EntityType t, const int dim, short int *pvec, 
                                 const int num_entries, const bool is_reverse) 
{
  short int *this_vec = permuteVec[t][dim], *that_vec = revPermuteVec[t][dim];
  if (is_reverse) {
    this_vec = revPermuteVec[t][dim];
    that_vec = permuteVec[t][dim];
  }

  for (short int i = 0; i < num_entries; i++) {
    this_vec[i] = pvec[i];
    that_vec[pvec[i]] = i;
  }

  this_vec[MAX_SUB_ENTITIES] = that_vec[MAX_SUB_ENTITIES] = (short)num_entries;
}

inline void CN::resetPermutation(const EntityType t, const int dim) 
{
  if (-1 == dim) {
    for (unsigned int i = 0; i < 3; i++) resetPermutation(t, i);
    return;
  }
  
  for (short unsigned int i = 0; i < MAX_SUB_ENTITIES; i++) {
    revPermuteVec[t][dim][i] = permuteVec[t][dim][i] = i;
  }
  
  revPermuteVec[t][dim][MAX_SUB_ENTITIES] = 
    permuteVec[t][dim][MAX_SUB_ENTITIES] = MAX_SUB_ENTITIES+1;
}

} // namespace moab 

#endif