XGCa
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
globals.hpp
Go to the documentation of this file.
1 #ifndef GLOBALS_HPP
2 #define GLOBALS_HPP
3 #include <limits.h>
4 #include <string>
5 #include <cassert>
6 #include "space_settings.hpp"
7 #include "array_deep_copy.hpp"
8 #include "access_add.hpp"
9 #include "simd.hpp"
10 #ifdef USE_MPI
11 #include "my_mpi.hpp"
12 #endif
13 #include "constants.hpp"
14 
15 /* Returns max number of omp threads, or 1 if no omp
16  */
17 inline int get_num_cpu_threads(){
18 #ifdef USE_OMP
19  return omp_get_max_threads();
20 #else
21  return 1;
22 #endif
23 }
24 
25 /* Return true if MPI rank is zero
26  * */
27 inline bool is_rank_zero(){
28 #ifdef USE_MPI
29  return SML_COMM_RANK==0;
30 #else
31  return true;
32 #endif
33 }
34 
35 /* Safely abort and exit the code
36  * */
37 inline void exit_XGC(std::string msg){
38  printf("%s",msg.c_str());
39  fflush(stdout);
40 #ifdef USE_MPI
41  MPI_Abort(SML_COMM_WORLD, 1);
42 #else
43  exit(1);
44 #endif
45 }
46 
47 /* Asserts condition
48  * (Callable from Device)
49  * (C++ has no standardized assert with a message)
50  * */
51 KOKKOS_INLINE_FUNCTION void assert_XGC(bool cond, const char* msg){
52  if(!cond){
53  DEVICE_PRINTF("%s",msg);
54  assert(false);
55  }
56 }
57 
58 /* Check that two integers multiplied together doesn't cause an overflow
59  * */
60 inline bool causes_multiplication_overflow(int a,int b){
61  int c = a*b;
62  if(b==0) return false; // No overflow
63  return !(c/b == a);
64 }
65 
66 /* Check that two integers added together doesn't cause an overflow
67  * */
68 inline bool causes_addition_overflow(int a,int b){
69  if ( ((b > 0) && (a > INT_MAX - b)) // a + b would overflow
70  ||((b < 0) && (a < INT_MIN - b)) ){ // a + b would underflow
71  return true;
72  } else {
73  return false;
74  }
75 }
76 
77 enum class Order{
78  Zero,
79  One,
80  Two
81 };
82 
84  ELECTRON = 0,
86 };
87 
88 enum KinType{
91 };
92 
93 /* PhiInterpType specifies whether the field uses two values in order to interpolate in the phi direction
94  * */
95 enum class PhiInterpType{
96  Planes,
97  None
98 };
99 
100 // Eventually, nearly the entire code will be templated on PhiInterpType, which is XGC1 vs XGCa
101 // As an intermediate step, it is convenient to specify the template in one global location
102 #ifdef XGC1
104 #else
106 #endif
107 
108 /* Whether to use cylindrical limit geometry with periodic boundary function
109  */
110 enum class GeometryType{
111  Toroidal,
113 };
114 #ifdef CYLINDRICAL
116 #else
118 #endif
119 
129 template<GeometryType GT>
130 KOKKOS_INLINE_FUNCTION double geometry_switch(double a, double b);
131 
132 template<>
133 KOKKOS_INLINE_FUNCTION double geometry_switch<GeometryType::Toroidal>(double a, double b){
134  return a;
135 }
136 
137 template<>
138 KOKKOS_INLINE_FUNCTION double geometry_switch<GeometryType::CylindricalLimit>(double a, double b){
139  return b;
140 }
141 
142 
146 template<GeometryType GT>
147 KOKKOS_INLINE_FUNCTION constexpr bool use_toroidal_terms();
148 
149 template<>
150 KOKKOS_INLINE_FUNCTION constexpr bool use_toroidal_terms<GeometryType::CylindricalLimit>(){
151  return 0;
152 }
153 
154 template<>
155 KOKKOS_INLINE_FUNCTION constexpr bool use_toroidal_terms<GeometryType::Toroidal>(){
156  return 1;
157 }
158 
159 /***/
160 
162  PIR = 0,
163  PIZ,
164  PIP,
169 };
170 
172  PIM = 0,
176 };
177 
178 // Divide two integers, then round up
179 KOKKOS_INLINE_FUNCTION int divide_and_round_up(int a, int b){
180  return (a+b-1)/b;
181 }
182 
183 // Positive modulo. i.e. positive_modulo(-1,3) will return 2, whereas (-1)%3 returns -1.
184 KOKKOS_INLINE_FUNCTION unsigned positive_modulo( int value, unsigned m) {
185  int mod = value % (int)m;
186  if (mod < 0) {
187  mod += m;
188  }
189  return mod;
190 }
191 
192 // Defined and initialized in my_mpi.cpp, reset in sml.tpp
193 extern bool global_debug_flag;
194 
195 #endif
Definition: globals.hpp:84
Magnetic moment mu.
Definition: globals.hpp:172
KOKKOS_INLINE_FUNCTION int divide_and_round_up(int a, int b)
Definition: globals.hpp:179
constexpr GeometryType GEOMETRY
Definition: globals.hpp:117
bool is_rank_zero()
Definition: globals.hpp:27
gyroradius
Definition: globals.hpp:165
MPI_Comm SML_COMM_WORLD
Definition: my_mpi.cpp:4
#define DEVICE_PRINTF(...)
Definition: space_settings.hpp:85
Definition: globals.hpp:89
W0.
Definition: globals.hpp:173
bool causes_multiplication_overflow(int a, int b)
Definition: globals.hpp:60
Definition: globals.hpp:168
bool global_debug_flag
Definition: checkpoint.cpp:11
KOKKOS_INLINE_FUNCTION unsigned positive_modulo(int value, unsigned m)
Definition: globals.hpp:184
PhiInterpType
Definition: globals.hpp:95
r coordinate
Definition: globals.hpp:162
Order
Definition: globals.hpp:77
constexpr PhiInterpType PIT_GLOBAL
Definition: globals.hpp:105
Definition: globals.hpp:175
Definition: globals.hpp:90
ParticlePhase
Definition: globals.hpp:161
2nd weight
Definition: globals.hpp:167
int SML_COMM_RANK
Definition: my_mpi.cpp:5
KinType
Definition: globals.hpp:88
GeometryType
Definition: globals.hpp:110
KOKKOS_INLINE_FUNCTION double geometry_switch(double a, double b)
Definition: globals.hpp:85
void exit_XGC(std::string msg)
Definition: globals.hpp:37
F0.
Definition: globals.hpp:174
int get_num_cpu_threads()
Definition: globals.hpp:17
phi coordinate
Definition: globals.hpp:164
KOKKOS_INLINE_FUNCTION constexpr bool use_toroidal_terms()
1st weight
Definition: globals.hpp:166
ParticleConsts
Definition: globals.hpp:171
z coordinate
Definition: globals.hpp:163
SpeciesType
Definition: globals.hpp:83
bool causes_addition_overflow(int a, int b)
Definition: globals.hpp:68
KOKKOS_INLINE_FUNCTION void assert_XGC(bool cond, const char *msg)
Definition: globals.hpp:51