Switch to using pragma once for header files, and replace multiple definitions of WIDE_PI constant with use of math library M_PIl

rpep · davidcortesortuno · rpep · commit a263c83557b4 · 2019-05-10T15:31:40.000+01:00
Co-Authored-By: David Ignacio Cortee &lt;david.cortes.o@gmail.com&gt;
diff --git a/native/include/a_clib.h b/native/include/a_clib.h
@@ -7,7 +7,7 @@
 #include "a_random.h"
 #include "c_vectormath.h"
 
-#define WIDE_PI 3.1415926535897932384626433832795L
+
 
 // ----------------------------------------------------------------------------
 // From exch.c
diff --git a/native/include/a_random.h b/native/include/a_random.h
@@ -1,11 +1,4 @@
-#ifndef __FIDIMAG_RANDOM__
-#define __FIDIMAG_RANDOM__
-
-
-
-//#include<omp.h>
-
-#define WIDE_PI 3.1415926535897932384626433832795L
+#pragma once
 
 //=================================================
 //random number, mt19937
@@ -14,7 +7,7 @@ typedef struct {
     unsigned int matrix[2];// = { 0, 0x9908b0dfU};
     int index_t;
     int seed;
-    
+
 } mt19937_state;
 
 #define	MT19973_RAND_MAX 4294967295u
@@ -29,5 +22,3 @@ int rand_int_n(mt19937_state *state, int n);
 void gauss_random_vector(mt19937_state *state, double *x, int n);
 
 void uniform_random_sphere(mt19937_state *state, double *spin, int n);
-
-#endif
diff --git a/native/include/c_clib.h b/native/include/c_clib.h
@@ -1,8 +1,7 @@
 #pragma once
-
 #include <math.h>
 #include<omp.h>
-#define WIDE_PI 3.1415926535897932384626433832795L
+
 
 // ----------------------------------------------------------------------------
 // From: llg.c
diff --git a/native/include/c_demagcoef.h b/native/include/c_demagcoef.h
@@ -1,3 +1,4 @@
+#pragma once
 /* This file demag_oommf.h is taken from the OOMMF project (oommf/app/oxs/ext/demagcoef.h
 downloaded from http://math.nist.gov/oommf/dist/oommf12a5rc_20120928.tar.gz)
 with slightly modifications (change OC_REALWIDE to double)
diff --git a/native/include/c_dipolar.h b/native/include/c_dipolar.h
@@ -1,11 +1,8 @@
+#pragma once
 #include<math.h>
 #include<complex>
 #include<fftw3.h>
 #include "c_vectormath.h"
-//#include<omp.h>
-
-#define WIDE_PI 3.1415926535897932384626433832795L
-
 
 enum Type_Nij {
 	Tensor_xx, Tensor_yy, Tensor_zz, Tensor_xy, Tensor_xz, Tensor_yz
@@ -24,9 +21,9 @@ typedef struct {
   int lenx;
   int leny;
   int lenz;
-  
+
   int total_length;
-  
+
   //TODO: free tensors after obtaining NXX to save memory?
   double *tensor_xx;
   double *tensor_yy;
@@ -42,7 +39,7 @@ typedef struct {
   std::complex<double> *Nxy;
   std::complex<double> *Nxz;
   std::complex<double> *Nyz;
-  
+
   std::complex<double> *Mx;
   std::complex<double> *My;
   std::complex<double> *Mz;
@@ -56,7 +53,7 @@ typedef struct {
   double *hx;
   double *hy;
   double *hz;
-  
+
   //we need three plans
   fftw_plan tensor_plan;
   fftw_plan m_plan;
@@ -68,7 +65,7 @@ fft_demag_plan *create_plan(void);
 void finalize_plan(fft_demag_plan * plan);
 void init_plan(fft_demag_plan *plan, double dx, double dy,
 		double dz, int nx, int ny, int nz);
-void compute_dipolar_tensors(fft_demag_plan * plan); 
+void compute_dipolar_tensors(fft_demag_plan * plan);
 void compute_demag_tensors(fft_demag_plan * plan);
 void create_fftw_plan(fft_demag_plan * plan);
 
@@ -111,4 +108,3 @@ void run_step1(ode_solver *s, double *m, double *h, double *m_pred, double *T,
 		double *alpha, double *mu_s_inv, int *pins);
 void run_step2(ode_solver *s, double *m_pred, double *h, double *m, double *T,
 		double *alpha, double *mu_s_inv, int *pins);
-
diff --git a/native/include/c_nebm_geodesic_lib.h b/native/include/c_nebm_geodesic_lib.h
@@ -1,5 +1,4 @@
 #include "math.h"
-#define WIDE_PI 3.1415926535897932384626433832795L
 
 double compute_geodesic_GreatCircle(double * A, double * B,
                                     int n_dofs_image,
diff --git a/native/include/c_nebm_lib.h b/native/include/c_nebm_lib.h
@@ -1,5 +1,4 @@
 #include "math.h"
-#define WIDE_PI 3.1415926535897932384626433832795L
 
 void compute_tangents_C(double * ys, double * energy,
                         double * tangents, int image_num, int nodes
diff --git a/native/include/c_nebm_spherical_lib.h b/native/include/c_nebm_spherical_lib.h
@@ -1,5 +1,4 @@
 #include "math.h"
-#define WIDE_PI 3.1415926535897932384626433832795L
 
 void normalise_spherical(double * a, int n);
 
diff --git a/native/include/c_tensor_2dpbc.h b/native/include/c_tensor_2dpbc.h
@@ -7,12 +7,12 @@ inline double RR(double x,double y,double z)
 inline double R(double x,double y,double z)
 {return sqrt(x*x+y*y+z*z);}
 
-//------------------------------------------------------------------------------	       
+//------------------------------------------------------------------------------
 
 //------------------------------------------------------------------------------
 //about Nxxinf
 
-inline double 
+inline double
 fxx(double x,double y,double z)
 {
 	double t1,t2,t3,t5;
@@ -49,7 +49,7 @@ inline double fzz(double x,double y,double z){
 }
 
 
-inline double 
+inline double
 Nzzinf(double x,double y,double z,double X0,double Y0)
 {
 	return fzz(x+X0,y+Y0,z)+fzz(x-X0,y-Y0,z)-fzz(x+X0,y-Y0,z)-fzz(x-X0,y+Y0,z);
@@ -97,7 +97,7 @@ inline double Nyzinf(double x,double y,double z,double X0,double Y0){
 //------------------------------------------------------------------------------
 //------------------------------------------------------------------------------
 //about Nxxdipole
-inline double 
+inline double
 DemagNxxDipolar(double x,double y,double z)
 {
 double  t1 = x*x;
@@ -109,7 +109,7 @@ double  t8 = sqrt(t6);
 return -(2.0 * t1 - t3 - t4) / (t8 * t7);
 }
 
-inline double 
+inline double
 DemagNxyDipolar(double x,double y,double z)
 {
 double  t6 = RR(x,y,z);
@@ -125,4 +125,3 @@ double DemagTensorAsymptotic(enum Type_Nij comp,double x,double y,double z,doubl
 double DemagTensorDipolar(enum Type_Nij comp,double x,double y,double z);
 
 double DemagTensorInfinite(enum Type_Nij comp,double x,double y,double z,double X0,double Y0);
-
diff --git a/native/include/m_baryakhtar_clib.h b/native/include/m_baryakhtar_clib.h
@@ -1,8 +1,5 @@
 #include<math.h>
 
-//#include<omp.h>
-
-#define WIDE_PI 3.1415926535897932384626433832795L
 #define MU0 1.25663706143591728850e-6
 
 void compute_laplace_m(double *m, double *field, double *Ms, double dx, double dy, double dz,
diff --git a/native/include/m_clib.h b/native/include/m_clib.h
@@ -1,7 +1,5 @@
 #include<math.h>
-#include<omp.h>
 
-#define WIDE_PI 3.1415926535897932384626433832795L
 #define MU0 1.25663706143591728850e-6
 #define MU0_INV 795774.71545947669074
 
diff --git a/native/src/a_random.cpp b/native/src/a_random.cpp
@@ -4,13 +4,13 @@
 #include "a_random.h"
 
 mt19937_state *create_mt19937_state(void) {
-    
+
     mt19937_state *state = (mt19937_state*) malloc(sizeof(mt19937_state));
     state->seed = 1;
     state->index_t = 0;
     state->matrix[0] = 0;
     state->matrix[1] = 0x9908b0dfU;
-    
+
     return state;
 }
 
@@ -20,13 +20,13 @@ void finalize_mt19937_state(mt19937_state *state) {
 
 
 void initial_rng_mt19973(mt19937_state *state, int seed) {
-    
+
     if (seed<0){
         state->seed = (unsigned int) time(NULL);
     }else{
         state->seed = seed;
     }
-    
+
     state->MT[0] = state->seed & 0xFFFFFFFFU;
     for (int i = 1; i < 624; i++) {
         state->MT[i] = (state->MT[i - 1] ^ (state->MT[i - 1] >> 30)) + i;
@@ -37,21 +37,21 @@ void initial_rng_mt19973(mt19937_state *state, int seed) {
 
 //return a integer in [0, MT19973_RAND_MAX]
 inline unsigned int rand_int(mt19937_state *state) {
-    
+
     unsigned int x;
     int index_t = state->index_t;
-    
+
     x = (state->MT[index_t] & 0x1U) + (state->MT[(index_t + 1) % 624] & 0xFFFFFFFEU);
     state->MT[index_t] = (state->MT[(index_t + 397) % 624] ^ (x >> 1))^ state->matrix[x & 1];
-    
+
     x = state->MT[index_t];
     x ^= (x >> 11);
     x ^= (x << 7) & 0x9d2c5680U;
     x ^= (x << 15) & 0xefc60000U;
     x ^= (x >> 18);
-    
+
     state->index_t = (index_t + 1) % 624;
-    
+
     return x;
 }
 
@@ -135,7 +135,7 @@ void random_integer_vector(mt19937_state *state, int *ids, int n) {
 void uniform_random_sphere(mt19937_state *state, double *spin, int n){
     for (int i=0;i<n;i++){
         int j=3*i;
-        double phi= random_double(state)*2*WIDE_PI;
+        double phi= random_double(state)*2*M_PIl;
         double ct = 2*random_double(state)-1;
         double st = sqrt(1-ct*ct);
         spin[j] = st*cos(phi); //mx = sin(theta)*cos(phi)
diff --git a/native/src/a_util.cpp b/native/src/a_util.cpp
@@ -154,7 +154,7 @@ double skyrmion_number(double * spin, double * charge, int nx, int ny, int nz,
     charge[i] += volume(S, S_i, S_j);
 
     /* Scale the chirality quantity */
-    charge[i] /= (8 * WIDE_PI);
+    charge[i] /= (8 * M_PIl);
 
     /* We use the sum to output the total spin chirality
      * or skyrmion number */
@@ -203,7 +203,7 @@ double compute_BergLuscher_angle(double *s1, double *s2, double *s3) {
          1i * dot(&s1[0], &crossp[0], 3)) /
         rho;
 
-  return 2 * std::imag(std::log(exp)) / (4 * WIDE_PI);
+  return 2 * std::imag(std::log(exp)) / (4 * M_PIl);
 }
 
 double skyrmion_number_BergLuscher(double *spin, double *charge, int nx, int ny,
diff --git a/native/src/c_demag_oommf.cpp b/native/src/c_demag_oommf.cpp
@@ -202,7 +202,7 @@ double SelfDemagNx(double x,double y,double z)
   arr[13] =  12*y*mpxz*log(diag+y);
   arr[14] =  -6*y*mpxz*log(xsq+zsq);
 
-  double Nxx = AccurateSum(15,arr)/(12*WIDE_PI*x*y*z);
+  double Nxx = AccurateSum(15,arr)/(12*M_PIl*x*y*z);
   return Nxx;
 }
 
@@ -311,7 +311,7 @@ CalculateSDA00(double x,double y,double z,
 
     arr[26] =  8*Newell_f(x,y,z);
 
-    result = AccurateSum(27,arr)/(4*WIDE_PI*dx*dy*dz);
+    result = AccurateSum(27,arr)/(4*M_PIl*dx*dy*dz);
   }
   return result;
 }
@@ -409,7 +409,7 @@ double CalculateSDA01(double x,double y,double z,
 
   arr[26] =  8*Newell_g(x,y,z);
 
-  return AccurateSum(27,arr)/(4*WIDE_PI*l*h*e);
+  return AccurateSum(27,arr)/(4*M_PIl*l*h*e);
   /// factor Nxy from Newell's paper.
 }
 
@@ -482,7 +482,7 @@ double DemagNxxAsymptotic(double x, double y, double z,
     term7 *= (1.0/16.0);
   }
 
-  double Nxx = (-dx*dy*dz/(4*WIDE_PI)) * (((term7/R2 + term5)/R2 + term3)/(R2*R));
+  double Nxx = (-dx*dy*dz/(4*M_PIl)) * (((term7/R2 + term5)/R2 + term3)/(R2*R));
   // Error should be of order 1/R^9
 
   return Nxx;
@@ -545,7 +545,7 @@ double DemagNxyAsymptotic(double x, double y, double z,
     term7 *= (7.0/16.0);
   }
 
-  double Nxy = (-dx*dy*dz*x*y/(4*WIDE_PI*R2)) * (((term7/R2 + term5)/R2 + term3)/(R2*R));
+  double Nxy = (-dx*dy*dz*x*y/(4*M_PIl*R2)) * (((term7/R2 + term5)/R2 + term3)/(R2*R));
   // Error should be of order 1/R^9
 
   return Nxy;
diff --git a/native/src/c_nebm_spherical_lib.cpp b/native/src/c_nebm_spherical_lib.cpp
@@ -5,21 +5,21 @@
 double compute_norm_spherical(double * a, int n, int scale) {
     /* Compute the norm of an array *a. *a is assumed to have spherical
      * coordinates as:
-           
+
      *      a = [ theta_0 phi_0 theta_1 phi_1 ... ]
-     
+
      * This function is necessary to either normalise a vector or compute the
      * distance between two images (see below)
      *
      * To compute the norm, we redefine the angles, so they always lie on the
-     * [-PI, PI] range, rather than [0, 2PI] for phi. 
+     * [-PI, PI] range, rather than [0, 2PI] for phi.
      *
      * ARGUMENTS:
-     
+
      * n        :: length of a
      *
      * scale    :: If scale is zero, we do not scale the norm
-     
+
      * Notice that, when computing the DISTANCE between two images, Y_i, Y_i+1
      * for example, we just do the difference (Y_i - Y_(i+1)) and then compute
      * its norm (using this function) but RESCALING the length by the number
@@ -32,10 +32,10 @@ double compute_norm_spherical(double * a, int n, int scale) {
 
     for(int i = 0; i < n; i++){
 
-        if (a[i] > WIDE_PI){
-            a[i] = 2 * WIDE_PI - a[i];
-        } else if(a[i] < -WIDE_PI){
-            a[i] += 2 * WIDE_PI;
+        if (a[i] > M_PIl){
+            a[i] = 2 * M_PIl - a[i];
+        } else if(a[i] < -M_PIl){
+            a[i] += 2 * M_PIl;
         }
 
         norm += a[i] * a[i];
diff --git a/native/src/c_tensor_2dpbc.cpp b/native/src/c_tensor_2dpbc.cpp
diff --git a/native/src/m_util.cpp b/native/src/m_util.cpp

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#pragma once`
`1`	`2`	`/* This file demag_oommf.h is taken from the OOMMF project (oommf/app/oxs/ext/demagcoef.h`
`2`	`3`	`downloaded from http://math.nist.gov/oommf/dist/oommf12a5rc_20120928.tar.gz)`
`3`	`4`	`with slightly modifications (change OC_REALWIDE to double)`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`#include "math.h"`
`2`		`-#define WIDE_PI 3.1415926535897932384626433832795L`
`3`	`2`
`4`	`3`	`double compute_geodesic_GreatCircle(double * A, double * B,`
`5`	`4`	`int n_dofs_image,`