GEOS
PrismUtilities.hpp
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2024 TotalEnergies
7  * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
8  * Copyright (c) 2023-2024 Chevron
9  * Copyright (c) 2019- GEOS/GEOSX Contributors
10  * All rights reserved
11  *
12  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
13  * ------------------------------------------------------------------------------------------------------------
14  */
15 
16 #ifndef GEOS_MESH_GENERATORS_PRISMUTILITIES_HPP_
17 #define GEOS_MESH_GENERATORS_PRISMUTILITIES_HPP_
18 
19 #include "common/DataTypes.hpp"
20 #include "common/Span.hpp"
21 
22 namespace geos
23 {
24 
36 template< localIndex N >
37 localIndex getFaceNodesPrism( localIndex const faceNum,
38  arraySlice1d< localIndex const, cells::NODE_MAP_USD - 1 > const & elemNodes,
39  Span< localIndex > const faceNodes )
40 {
41  static_assert( N > 4,
42  "Function getFaceNodePrism can be called for a prism with N-sided polygon base where N > 5." );
43  static constexpr auto nodeCountError = "Not enough nodes for {} element (face index = {}).\n";
44  GEOS_UNUSED_VAR( nodeCountError ); // Not used in GPU builds.
45 
46  if( faceNum == 0 )
47  {
48  GEOS_ERROR_IF_LT_MSG( faceNodes.size(), 4, GEOS_FMT( nodeCountError, N, faceNum ) << generalMeshErrorAdvice );
49  faceNodes[0] = elemNodes[0];
50  faceNodes[1] = elemNodes[1];
51  faceNodes[2] = elemNodes[N+1];
52  faceNodes[3] = elemNodes[N];
53  return 4;
54  }
55  else if( faceNum == 1 )
56  {
57  GEOS_ERROR_IF_LT_MSG( faceNodes.size(), N, GEOS_FMT( nodeCountError, N, faceNum ) << generalMeshErrorAdvice );
58  faceNodes[0] = elemNodes[0];
59  for( localIndex i = 1; i < N; ++i )
60  {
61  faceNodes[i] = elemNodes[N-i];
62  }
63  return N;
64  }
65  else if( faceNum == 2 )
66  {
67  GEOS_ERROR_IF_LT_MSG( faceNodes.size(), 4, GEOS_FMT( nodeCountError, N, faceNum ) << generalMeshErrorAdvice );
68  faceNodes[0] = elemNodes[0];
69  faceNodes[1] = elemNodes[N];
70  faceNodes[2] = elemNodes[N*2-1];
71  faceNodes[3] = elemNodes[N-1];
72  return 4;
73  }
74  else if( faceNum >= 3 && faceNum <= N )
75  {
76  GEOS_ERROR_IF_LT_MSG( faceNodes.size(), 4, GEOS_FMT( nodeCountError, N, faceNum ) << generalMeshErrorAdvice );
77  faceNodes[0] = elemNodes[faceNum-2];
78  faceNodes[1] = elemNodes[faceNum-1];
79  faceNodes[2] = elemNodes[N+faceNum-1];
80  faceNodes[3] = elemNodes[N+faceNum-2];
81  return 4;
82  }
83  else if( faceNum == N + 1 )
84  {
85  GEOS_ERROR_IF_LT_MSG( faceNodes.size(), N, GEOS_FMT( nodeCountError, N, faceNum ) << generalMeshErrorAdvice );
86  for( localIndex i = 0; i < N; ++i )
87  {
88  faceNodes[i] = elemNodes[i+N];
89  }
90  return N;
91  }
92  else
93  {
94  GEOS_ERROR( GEOS_FMT( "Local face index out of range for Prism{} element: face index = {}.\n{}",
95  N, faceNum, generalMeshErrorAdvice ) );
96  return 0;
97  }
98 
99 }
100 
101 }
102 
103 #endif // GEOS_MESH_GENERATORS_PRISMUTILITIES_HPP_
GEOS_UNUSED_VAR
#define GEOS_UNUSED_VAR(...)
Mark an unused variable and silence compiler warnings.
Definition: GeosxMacros.hpp:84
GEOS_ERROR
#define GEOS_ERROR(msg)
Raise a hard error and terminate the program.
Definition: Logger.hpp:157
GEOS_ERROR_IF_LT_MSG
#define GEOS_ERROR_IF_LT_MSG(lhs, rhs, msg)
Raise a hard error if one value compares less than the other.
Definition: Logger.hpp:339
geos::Span
Lightweight non-owning wrapper over a contiguous range of elements.
Definition: Span.hpp:42
geos::Span::size
constexpr size_type size() const noexcept
Definition: Span.hpp:107
geos::localIndex
GEOS_LOCALINDEX_TYPE localIndex
Local index type (for indexing objects within an MPI partition).
Definition: DataTypes.hpp:84
geos::arraySlice1d
ArraySlice< T, 1, USD > arraySlice1d
Alias for 1D array slice.
Definition: DataTypes.hpp:192
geos::getFaceNodesPrism
localIndex getFaceNodesPrism(localIndex const faceNum, arraySlice1d< localIndex const, cells::NODE_MAP_USD - 1 > const &elemNodes, Span< localIndex > const faceNodes)
Get the local indices of the nodes in a face of the prism with N-sided polygon base.
Definition: PrismUtilities.hpp:37
geos::generalMeshErrorAdvice
constexpr auto generalMeshErrorAdvice
String available for mesh errors.
Definition: ElementType.hpp:144
Generated by doxygen 1.9.1