Matter: Move the gauge calculation re:matter to its own file

Author: julianakwan

Source/CCZ4/MovingPunctureGauge.hpp

@@ -65,28 +65,6 @@ class MovingPunctureGauge
                        rhs.Gamma[i] - m_params.eta * vars.B[i];
         }
     }
-
-    // Add the matter terms to the rhs of the gauge equations
-    // For the MP gauge, this only changes the rhs of B through the rhs of Gamma
-    template <class data_t, template <typename> class vars_t>
-    AMREX_GPU_DEVICE AMREX_FORCE_INLINE void rhs_gauge_add_matter_terms(
-        vars_t<data_t> &matter_rhs, const vars_t<data_t> &matter_vars,
-        Tensor<2, data_t, 3> h_UU, const emtensor_t<data_t> emtensor,
-        const double G_Newton) const
-    {
-        FOR (i)
-        {
-            data_t matter_term_Gamma = 0.0;
-            FOR (j)
-            {
-                matter_term_Gamma += -16.0 * M_PI * G_Newton *
-                                     matter_vars.lapse * h_UU[i][j] *
-                                     emtensor.Si[j];
-            }
-
-            matter_rhs.B[i] += matter_term_Gamma;
-        }
-    }
 };
 
 #endif /* MOVINGPUNCTUREGAUGE_HPP_ */

Source/Matter/CCZ4RHSWithMatter.hpp

@@ -10,7 +10,7 @@
 #include "CCZ4RHS.hpp"
 #include "Cell.hpp"
 #include "FourthOrderDerivatives.hpp"
-#include "MovingPunctureGauge.hpp"
+#include "MovingPunctureGaugeWithMatter.hpp"
 #include "StateVariables.hpp" //This files needs NUM_VARS - total number of components
 #include "Tensor.hpp"
 #include "TensorAlgebra.hpp"
@@ -29,7 +29,7 @@
    an example of a matter_t. \sa CCZ4RHS(), ScalarField()
 */
 
-template <class matter_t, class gauge_t = MovingPunctureGauge,
+template <class matter_t, class gauge_t = MovingPunctureGaugeWithMatter,
           class deriv_t = FourthOrderDerivatives>
 class CCZ4RHSWithMatter : public CCZ4RHS<gauge_t, deriv_t>
 {

Source/Matter/Make.package

@@ -9,5 +9,6 @@ GRTECLYN_CEXE_headers += ChiRelaxation.hpp \
 			 MatterConstraints.impl.hpp \
 			 MatterWeyl4.hpp \
 			 MatterWeyl4.impl.hpp \
+			 MovingPunctureGaugeWithMatter \
 			 ScalarField.hpp \
 			 ScalarField.impl.hpp

Source/Matter/MovingPunctureGaugeWithMatter.hpp

@@ -0,0 +1,58 @@
+/* GRTeclyn
+ * Copyright 2022 The GRTL collaboration.
+ * Please refer to LICENSE in GRTeclyn's root directory.
+ */
+
+#ifndef MOVINGPUNCTUREGAUGEWITHMATTER_HPP_
+#define MOVINGPUNCTUREGAUGEWITHMATTER_HPP_
+
+#include "CCZ4RHSWithMatter.hpp"
+#include "DimensionDefinitions.hpp"
+// #include "EMTensor.hpp"
+#include "Tensor.hpp"
+
+#include <cmath>
+
+/**
+ * This class implements a slightly more generic version of the moving puncture
+ * gauge. In particular it uses a Bona-Masso slicing condition of the form
+ * f(lapse) = -c*lapse^(p-2)
+ * and a Gamma-driver shift condition
+ **/
+
+/// This class adds the matter terms to the RHS of the gauge equation
+/// for the moving puncture gauge
+
+class MovingPunctureGaugeWithMatter : public MovingPunctureGauge
+{
+
+  public:
+    MovingPunctureGaugeWithMatter(const params_t &a_params)
+        : MovingPunctureGauge(a_params)
+    {
+    }
+
+    // NOLINTBEGIN(bugprone-easily-swappable-parameters)
+    template <class data_t, template <typename> class vars_t>
+    AMREX_GPU_DEVICE AMREX_FORCE_INLINE void rhs_gauge_add_matter_terms(
+        vars_t<data_t> &matter_rhs, const vars_t<data_t> &matter_vars,
+        Tensor<2, data_t, 3> h_UU, const emtensor_t<data_t> emtensor,
+        const double G_Newton) const
+    // NOLINTEND(bugprone-easily-swappable-parameters)
+    {
+        FOR (i)
+        {
+            data_t matter_term_Gamma = 0.0;
+            FOR (j)
+            {
+                matter_term_Gamma += -16.0 * M_PI * G_Newton *
+                                     matter_vars.lapse * h_UU[i][j] *
+                                     emtensor.Si[j];
+            }
+
+            matter_rhs.B[i] += matter_term_Gamma;
+        }
+    }
+};
+
+#endif /* MOVINGPUNCTUREGAUGEWITHMATTER_HPP_ */

Tests/BSSNMatterTest/BSSNMatterTest.cpp

@@ -69,9 +69,11 @@ void run_bssn_matter_test()
 
         const auto &in_array = in_mf.arrays();
 
+        // NOLINTBEGIN(bugprone-easily-swappable-parameters)
         amrex::ParallelFor(
             in_mf, in_mf.nGrowVect(),
             [=] AMREX_GPU_DEVICE(int ibox, int i, int j, int k)
+            // NOLINTEND(bugprone-easily-swappable-parameters)
             {
                 const amrex::IntVect iv{i, j, k};
                 const amrex::RealVect coords = amrex::RealVect{iv} * dx;
@@ -84,7 +86,7 @@ void run_bssn_matter_test()
                 random_matter_bssn_initial_data(iv, in_array[ibox], coords);
             });
 
-        CCZ4_params_t<MovingPunctureGauge::params_t> ccz4_params;
+        CCZ4_params_t<MovingPunctureGaugeWithMatter::params_t> ccz4_params;
         ccz4_params.kappa1            = 0.0;
         ccz4_params.kappa2            = 0.0;
         ccz4_params.kappa3            = 0.0;
@@ -103,7 +105,7 @@ void run_bssn_matter_test()
         GRParmParse pp;
         pp.queryAdd("G_Newton", G_Newton);
 
-        CCZ4RHSWithMatter<DefaultScalarField, MovingPunctureGauge,
+        CCZ4RHSWithMatter<DefaultScalarField, MovingPunctureGaugeWithMatter,
                           FourthOrderDerivatives>
             current_ccz4_rhs{ccz4_params, dx, sigma, CCZ4RHS<>::USE_BSSN,
                              G_Newton};