1 /// Copyright (c) 2017-2024, Lawrence Livermore National Security, LLC and other CEED contributors. 2 /// All Rights Reserved. See the top-level LICENSE and NOTICE files for details. 3 /// 4 /// SPDX-License-Identifier: BSD-2-Clause 5 /// 6 /// This file is part of CEED: http://github.com/ceed 7 8 /// @file 9 /// Public header for types and macros used in user QFunction source code 10 #ifndef CEED_QFUNCTION_DEFS_H 11 #define CEED_QFUNCTION_DEFS_H 12 13 #include <stddef.h> 14 #include <stdint.h> 15 16 /** 17 @ingroup CeedQFunction 18 This macro defines compiler attributes to the CEED_QFUNCTION to force inlining for called functions. 19 The `inline` declaration does not necessarily enforce a compiler to inline a function. 20 This can be detrimental to performance, so here we force inlining to occur unless inlining has been forced off (like during debugging). 21 **/ 22 #ifndef CEED_QFUNCTION_ATTR 23 #ifndef __NO_INLINE__ 24 #if defined(__GNUC__) || defined(__clang__) 25 #define CEED_QFUNCTION_ATTR __attribute__((flatten)) 26 #elif defined(__INTEL_COMPILER) 27 #define CEED_QFUNCTION_ATTR _Pragma("forceinline") 28 #else 29 #define CEED_QFUNCTION_ATTR 30 #endif 31 #else 32 #define CEED_QFUNCTION_ATTR 33 #endif 34 #if defined(__GNUC__) || defined(__clang__) 35 #define CEED_QFUNCTION_HELPER_ATTR CEED_QFUNCTION_ATTR __attribute__((always_inline)) 36 #else 37 #define CEED_QFUNCTION_HELPER_ATTR CEED_QFUNCTION_ATTR 38 #endif 39 #endif 40 41 /** 42 @ingroup CeedQFunction 43 This macro populates the correct function annotations for User QFunction source for code generation backends or populates default values for CPU 44 backends. It also creates a variable `name_loc` populated with the correct source path for creating the respective User QFunction. 45 **/ 46 #ifndef CEED_QFUNCTION 47 #define CEED_QFUNCTION(name) \ 48 static const char name##_loc[] = __FILE__ ":" #name; \ 49 CEED_QFUNCTION_ATTR static int name 50 #endif 51 52 /** 53 @ingroup CeedQFunction 54 This macro populates the correct function annotations for User QFunction helper function source for code generation backends or populates default 55 values for CPU backends. 56 **/ 57 #ifndef CEED_QFUNCTION_HELPER 58 #define CEED_QFUNCTION_HELPER CEED_QFUNCTION_HELPER_ATTR static inline 59 #endif 60 61 /** 62 @ingroup CeedQFunction 63 Using VLA syntax to reshape User QFunction inputs and outputs can make user code more readable. 64 VLA is a C99 feature that is not supported by the C++ dialect used by CUDA. 65 This macro allows users to use the VLA syntax with the CUDA backends. 66 **/ 67 #ifndef CEED_Q_VLA 68 #define CEED_Q_VLA Q 69 #endif 70 71 /** 72 @ingroup Ceed 73 This macro provides the appropriate SIMD Pragma for the compilation environment. 74 Code generation backends may redefine this macro, as needed. 75 **/ 76 #ifndef CeedPragmaSIMD 77 #if defined(__INTEL_COMPILER) 78 #define CeedPragmaSIMD _Pragma("vector") 79 /// Cannot use Intel pragma ivdep because it miscompiles unpacking symmetric tensors, as in Poisson2DApply, where the SIMD loop body contains 80 /// temporaries such as the following. 81 /// 82 /// const CeedScalar dXdxdXdxT[2][2] = {{qd[i+0*Q], qd[i+2*Q]}, 83 /// {qd[i+2*Q], qd[i+1*Q]}}; 84 /// for (int j=0; j<2; j++) 85 /// vg[i+j*Q] = (du[0] * dXdxdXdxT[0][j] + du[1] * dXdxdXdxT[1][j]); 86 /// 87 /// Miscompilation with pragma ivdep observed with icc (ICC) 19.0.5.281 20190815 at -O2 and above. 88 #elif defined(__GNUC__) && __GNUC__ >= 5 89 #define CeedPragmaSIMD _Pragma("GCC ivdep") 90 #elif defined(__clang__) 91 #define CeedPragmaSIMD _Pragma("clang loop vectorize(enable)") 92 #elif defined(_OPENMP) && _OPENMP >= 201307 // OpenMP-4.0 (July, 2013) 93 #define CeedPragmaSIMD _Pragma("omp simd") 94 #else 95 #define CeedPragmaSIMD 96 #endif 97 #endif 98 99 /// Integer type, used for indexing 100 /// @ingroup Ceed 101 typedef int32_t CeedInt; 102 #define CeedInt_FMT "d" 103 104 /// Integer type, used array sizes 105 /// @ingroup Ceed 106 typedef ptrdiff_t CeedSize; 107 #define CeedSize_FMT "td" 108 109 /// Integer type, for small integers 110 /// @ingroup Ceed 111 typedef signed char CeedInt8; 112 #define CeedInt8_FMT "d" 113 114 /// Scalar (floating point) types 115 /// 116 /// @ingroup Ceed 117 typedef enum { 118 /// Single precision 119 CEED_SCALAR_FP32, 120 /// Double precision 121 CEED_SCALAR_FP64 122 } CeedScalarType; 123 /// Base scalar type for the library to use: change which header is included to change the precision. 124 #include "ceed-f64.h" // IWYU pragma: export 125 126 /// Ceed error code. 127 /// 128 /// This enum is used to specify the type of error returned by a function. 129 /// A zero error code is success, negative error codes indicate terminal errors and positive error codes indicate nonterminal errors. 130 /// With nonterminal errors the object state has not been modified, but with terminal errors the object data is likely modified or corrupted. 131 /// @ingroup Ceed 132 typedef enum { 133 /// Success error code 134 CEED_ERROR_SUCCESS = 0, 135 /// Minor error, generic 136 CEED_ERROR_MINOR = 1, 137 /// Minor error, dimension mismatch in inputs 138 CEED_ERROR_DIMENSION = 2, 139 /// Minor error, incomplete object setup 140 CEED_ERROR_INCOMPLETE = 3, 141 /// Minor error, incompatible arguments/configuration 142 CEED_ERROR_INCOMPATIBLE = 4, 143 /// Minor error, access lock problem 144 CEED_ERROR_ACCESS = 5, 145 /// Major error, generic 146 CEED_ERROR_MAJOR = -1, 147 /// Major error, internal backend error 148 CEED_ERROR_BACKEND = -2, 149 /// Major error, operation unsupported by current backend 150 CEED_ERROR_UNSUPPORTED = -3, 151 } CeedErrorType; 152 153 /// Specify memory type. 154 /// Many Ceed interfaces take or return pointers to memory. 155 /// This enum is used to specify where the memory being provided or requested must reside. 156 /// @ingroup Ceed 157 typedef enum { 158 /// Memory resides on the host 159 CEED_MEM_HOST, 160 /// Memory resides on a device (corresponding to \ref Ceed resource) 161 CEED_MEM_DEVICE, 162 } CeedMemType; 163 164 /// Conveys ownership status of arrays passed to Ceed interfaces. 165 /// @ingroup Ceed 166 typedef enum { 167 /// Implementation will copy the values and not store the passed pointer. 168 CEED_COPY_VALUES, 169 /// Implementation can use and modify the data provided by the user, but does not take ownership. 170 CEED_USE_POINTER, 171 /// Implementation takes ownership of the pointer and will free using CeedFree() when done using it. 172 /// The user should not assume that the pointer remains valid after ownership has been transferred. 173 /// Note that arrays allocated using C++ operator new or other allocators cannot generally be freed using CeedFree(). 174 /// CeedFree() is capable of freeing any memory that can be freed using free(). 175 CEED_OWN_POINTER, 176 } CeedCopyMode; 177 178 /// Denotes type of vector norm to be computed 179 /// @ingroup CeedVector 180 typedef enum { 181 /// \f$\Vert \bm{x}\Vert_1 = \sum_i \vert x_i\vert\f$ 182 CEED_NORM_1, 183 /// \f$\Vert \bm{x} \Vert_2 = \sqrt{\sum_i x_i^2}\f$ 184 CEED_NORM_2, 185 /// \f$\Vert \bm{x} \Vert_\infty = \max_i \vert x_i \vert\f$ 186 CEED_NORM_MAX, 187 } CeedNormType; 188 189 /// Denotes whether a linear transformation or its transpose should be applied 190 /// @ingroup CeedBasis 191 typedef enum { 192 /// Apply the linear transformation 193 CEED_NOTRANSPOSE, 194 /// Apply the transpose 195 CEED_TRANSPOSE 196 } CeedTransposeMode; 197 198 /// Basis evaluation mode 199 /// @ingroup CeedBasis 200 typedef enum { 201 /// Perform no evaluation (either because there is no data or it is already at quadrature points) 202 CEED_EVAL_NONE = 0, 203 /// Interpolate from nodes to quadrature points 204 CEED_EVAL_INTERP = 1, 205 /// Evaluate gradients at quadrature points from input in the basis 206 CEED_EVAL_GRAD = 2, 207 /// Evaluate divergence at quadrature points from input in the basis 208 CEED_EVAL_DIV = 4, 209 /// Evaluate curl at quadrature points from input in the basis 210 CEED_EVAL_CURL = 8, 211 /// Using no input, evaluate quadrature weights on the reference element 212 CEED_EVAL_WEIGHT = 16, 213 } CeedEvalMode; 214 215 /// Type of quadrature; also used for location of nodes 216 /// @ingroup CeedBasis 217 typedef enum { 218 /// Gauss-Legendre quadrature 219 CEED_GAUSS = 0, 220 /// Gauss-Legendre-Lobatto quadrature 221 CEED_GAUSS_LOBATTO = 1, 222 } CeedQuadMode; 223 224 /// Type of basis shape to create non-tensor element basis. 225 /// Dimension can be extracted with bitwise AND (CeedElemTopology & 2**(dim + 2)) == TRUE 226 /// @ingroup CeedBasis 227 typedef enum { 228 /// Line 229 CEED_TOPOLOGY_LINE = 1 << 16 | 0, 230 /// Triangle - 2D shape 231 CEED_TOPOLOGY_TRIANGLE = 2 << 16 | 1, 232 /// Quadralateral - 2D shape 233 CEED_TOPOLOGY_QUAD = 2 << 16 | 2, 234 /// Tetrahedron - 3D shape 235 CEED_TOPOLOGY_TET = 3 << 16 | 3, 236 /// Pyramid - 3D shape 237 CEED_TOPOLOGY_PYRAMID = 3 << 16 | 4, 238 /// Prism - 3D shape 239 CEED_TOPOLOGY_PRISM = 3 << 16 | 5, 240 /// Hexehedron - 3D shape 241 CEED_TOPOLOGY_HEX = 3 << 16 | 6, 242 } CeedElemTopology; 243 244 /// Denotes type of data stored in a CeedQFunctionContext field 245 /// @ingroup CeedQFunction 246 typedef enum { 247 /// Double precision value 248 CEED_CONTEXT_FIELD_DOUBLE = 1, 249 /// 32 bit integer value 250 CEED_CONTEXT_FIELD_INT32 = 2, 251 /// Boolean value 252 CEED_CONTEXT_FIELD_BOOL = 3, 253 } CeedContextFieldType; 254 255 #endif // CEED_QFUNCTION_DEFS_H 256