ElementType.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 TotalEnergies
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_MESH_ELEMENTTYPE_HPP
#define GEOS_MESH_ELEMENTTYPE_HPP
 
#include "codingUtilities/EnumStrings.hpp"
 
namespace geos
{
 
enum class ElementType : integer
{
  Vertex,        
  Line,          
  Triangle,      
  Quadrilateral, 
  Polygon,       
  Tetrahedron,   
  Pyramid,       
  Wedge,         
  Hexahedron,    
  Prism5,        
  Prism6,        
  Prism7,        
  Prism8,        
  Prism9,        
  Prism10,       
  Prism11,       
  Polyhedron,    
  // NOTE: If you add anything below Polyhedron,
  // don't forget to update numElementTypes() below.
};
 
inline constexpr integer numElementTypes()
{
  return static_cast< integer >( ElementType::Polyhedron ) + 1;
}
 
inline int getElementDim( ElementType const elementType )
{
  switch( elementType )
  {
    case ElementType::Vertex:        return 0;
    case ElementType::Line:          return 1;
    case ElementType::Triangle:
    case ElementType::Quadrilateral:
    case ElementType::Polygon:       return 2;
    case ElementType::Tetrahedron:
    case ElementType::Pyramid:
    case ElementType::Wedge:
    case ElementType::Hexahedron:
    case ElementType::Prism5:
    case ElementType::Prism6:
    case ElementType::Prism7:
    case ElementType::Prism8:
    case ElementType::Prism9:
    case ElementType::Prism10:
    case ElementType::Prism11:
    case ElementType::Polyhedron:    return 3;
  }
  return 0;
}
 
ENUM_STRINGS( ElementType,
              "Vertex",
              "BEAM",
              "C2D3",
              "C2D4",
              "Polygon",
              "C3D4",
              "C3D5",
              "C3D6",
              "C3D8",
              "PentagonalPrism",
              "HexagonalPrism",
              "HeptagonalPrism",
              "OctagonalPrism",
              "NonagonalPrism",
              "DecagonalPrism",
              "HendecagonalPrism",
              "Polyhedron" );
 
inline auto constexpr generalMeshErrorAdvice = "Consider checking the validity of your mesh with "
                                               "the `mesh_doctor` GEOS python tools (documentation at"
                                               "https://geosx-geosx.readthedocs-hosted.com/en/latest/docs/sphinx/pythonTools/mesh_doctor.html).";
 
} // namespace geos
 
#endif //GEOS_MESH_ELEMENTTYPE_HPP