1D3V Cartesian Support (#2307)

* Build System: Add 1D Geometry

* test PR

* test PR

* 1D cartesian yee algorithm

* fixed typo

* Fixes for PML

* 1D support related multiple changes

* Fix compilation

* change 1D to 1D_Z

* 1D Field Gather and typo fix

* 1D Charge Deposition

* Particle Pusher

* multiple changes related to 1D

* 1D diagnostics and initialization

* PlasmaInjector and PEC fixes for 1D

* clean-up delete diags file

* mobility 1D laser particle and bilinear filter

* deleted diags files

* update laser particle weight formula

* delete diags files

* Azure: Add 1D Cartesian Runner

* 1D fixes for FieldProbe

* Update Docs/source/developers/dimensionality.rst

Co-authored-by: Remi Lehe <remi.lehe@normalesup.org>

* 1d laser injection and langmuir test input files

* 1d tests

* clean up : delete print statements

* analyse simulation result for laser injection and Langmuir tests

* EOL

* delete input files for which there are no automated tests

* delete input files for which there are no automated tests

* add ignore_unused to remove warnings

* remove space

* Fix compilation issues

* fix error : macro name must be an identifier

* Small bug fix

* cleanup Python script for analysis

* bug fix

* bug fix

* Update ParticleProbe: Check 1D in-domain

* Update Source/Make.WarpX

* Update .azure-pipelines.yml

* Add USE_OPENPMD=FALSE to .azure-pipeline.yml

* resolve conflict

* resolve conflict

* fix typo

* Correct out-of-bound access

* Fix Particle BC in WarpXParticleContainer and correct path to checksumAPI in python analysis scripts

* EOL

* Fix bug : accessing out of bound index of cell in 1D

* remove 1d test for cartesian3d

* Fix CI check

* Slight style change

* Address review comments

* Fix GPU compilation Filter.cpp

* Fix CI

* Fix Indentation

* Address review comments

* More consistent ifdef for dimension bigger than 1

* Update Examples/Tests/Langmuir/analysis_langmuir_multi_1d.py

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update GNUmakefile

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Regression/prepare_file_ci.py

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.H

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Source/Filter/Filter.cpp

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Source/Filter/Filter.cpp

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Source/Filter/Filter.cpp

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Source/Filter/Filter.cpp

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Source/Initialization/PlasmaInjector.cpp

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Source/Initialization/PlasmaInjector.cpp

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* add comment inline to explain twice push_back

* Add amrex::Abort for NCIGodfreyFilter

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
Co-authored-by: Prabhat Kumar <prabhatkumar@kraken.dhcp.lbl.gov>
Co-authored-by: Remi Lehe <remi.lehe@normalesup.org>
Co-authored-by: Remi Lehe <rlehe@lbl.gov>

3 files changed, 65 insertions, 12 deletions

diff --git a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H
index 216723553..d7946c97e 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H
+++ b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H
@@ -71,6 +71,13 @@ struct CartesianCKCAlgorithm {
         constexpr Real gammax=0._rt, gammay=0._rt, gammaz=0._rt;
         constexpr Real betaxy=0._rt, betazy=0._rt, betayx=0._rt, betayz=0._rt;
         constexpr Real alphay=0._rt;
+#elif defined WARPX_DIM_1D_Z
+        Real const alphaz = inv_dz;
+        // Other coefficients are 0 in 1D Cartesian
+        // (and will actually not be used in the stencil)
+        constexpr Real gammax=0._rt, gammay=0._rt, gammaz=0._rt;
+        constexpr Real betaxy=0._rt, betazy=0._rt, betayx=0._rt, betayz=0._rt, betaxz=0._rt, betazx=0._rt;
+        constexpr Real alphay=0._rt, alphax=0._rt;
 #endif
 
         // Store the coefficients in array `stencil_coefs`, in prescribed order
@@ -124,14 +131,16 @@ struct CartesianCKCAlgorithm {
         amrex::Real const * const coefs_x, int const /*n_coefs_x*/,
         int const i, int const j, int const k, int const ncomp=0 ) {
 
+        using namespace amrex;
+#if (defined WARPX_DIM_3D || WARPX_DIM_XZ)
         amrex::Real const alphax = coefs_x[1];
-#if defined WARPX_DIM_3D
-        amrex::Real const betaxy = coefs_x[2];
-#endif
         amrex::Real const betaxz = coefs_x[3];
+#endif
 #if defined WARPX_DIM_3D
+        amrex::Real const betaxy = coefs_x[2];
         amrex::Real const gammax = coefs_x[4];
 #endif
+
 #if defined WARPX_DIM_3D
         return alphax * (F(i+1,j  ,k  ,ncomp) - F(i,  j,  k  ,ncomp))
              + betaxy * (F(i+1,j+1,k  ,ncomp) - F(i  ,j+1,k  ,ncomp)
@@ -146,6 +155,9 @@ struct CartesianCKCAlgorithm {
         return alphax * (F(i+1,j  ,k  ,ncomp) - F(i,  j,  k  ,ncomp))
              + betaxz * (F(i+1,j+1,k  ,ncomp) - F(i  ,j+1,k  ,ncomp)
                       +  F(i+1,j-1,k  ,ncomp) - F(i  ,j-1,k  ,ncomp));
+#elif (defined WARPX_DIM_1D_Z)
+        amrex::ignore_unused(F, coefs_x, i, j, k, ncomp);
+        return 0._rt; // 1D Cartesian: derivative along x is 0
 #endif
     }
 
@@ -158,8 +170,14 @@ struct CartesianCKCAlgorithm {
         amrex::Real const * const coefs_x, int const /*n_coefs_x*/,
         int const i, int const j, int const k, int const ncomp=0 ) {
 
+        using namespace amrex;
+#if (defined WARPX_DIM_1D_Z)
+        amrex::ignore_unused(F, coefs_x, i, j, k, ncomp);
+        return 0._rt; // 1D Cartesian: derivative along x is 0
+#else
         amrex::Real const inv_dx = coefs_x[0];
         return inv_dx*( F(i,j,k,ncomp) - F(i-1,j,k,ncomp) );
+#endif
     }
 
     /**
@@ -186,10 +204,10 @@ struct CartesianCKCAlgorithm {
                       +  F(i-1,j+1,k+1,ncomp) - F(i-1,j  ,k+1,ncomp)
                       +  F(i+1,j+1,k-1,ncomp) - F(i+1,j  ,k-1,ncomp)
                        +  F(i-1,j+1,k-1,ncomp) - F(i-1,j  ,k-1,ncomp));
-#elif (defined WARPX_DIM_XZ)
+#elif (defined WARPX_DIM_XZ || WARPX_DIM_1D_Z)
         amrex::ignore_unused(F, coefs_y, n_coefs_y,
             i, j, k, ncomp);
-        return 0._rt; // 2D Cartesian: derivative along y is 0
+        return 0._rt; // 1D and 2D Cartesian: derivative along y is 0
 #else
         amrex::ignore_unused(F, coefs_y, n_coefs_y,
             i, j, k, ncomp);
@@ -210,7 +228,7 @@ struct CartesianCKCAlgorithm {
         amrex::Real const inv_dy = coefs_y[0];
         amrex::ignore_unused(n_coefs_y);
         return inv_dy*( F(i,j,k,ncomp) - F(i,j-1,k,ncomp) );
-#elif (defined WARPX_DIM_XZ)
+#elif (defined WARPX_DIM_XZ || WARPX_DIM_1D_Z)
         amrex::ignore_unused(F, coefs_y, n_coefs_y,
             i, j, k, ncomp);
         return 0._rt; // 2D Cartesian: derivative along y is 0
@@ -233,7 +251,9 @@ struct CartesianCKCAlgorithm {
         amrex::ignore_unused(n_coefs_z);
 
         Real const alphaz = coefs_z[1];
+#if (defined WARPX_DIM_3D || WARPX_DIM_XZ)
         Real const betazx = coefs_z[2];
+#endif
 #if defined WARPX_DIM_3D
         Real const betazy = coefs_z[3];
         Real const gammaz = coefs_z[4];
@@ -252,6 +272,8 @@ struct CartesianCKCAlgorithm {
         return alphaz * (F(i  ,j+1,k  ,ncomp) - F(i  ,j  ,k  ,ncomp))
              + betazx * (F(i+1,j+1,k  ,ncomp) - F(i+1,j  ,k  ,ncomp)
                       +  F(i-1,j+1,k  ,ncomp) - F(i-1,j  ,k  ,ncomp));
+#elif (defined WARPX_DIM_1D_Z)
+        return alphaz * (F(i+1  ,j,k  ,ncomp) - F(i  ,j  ,k  ,ncomp));
 #endif
     }
 
@@ -269,6 +291,8 @@ struct CartesianCKCAlgorithm {
         return inv_dz*( F(i,j,k,ncomp) - F(i,j,k-1,ncomp) );
 #elif (defined WARPX_DIM_XZ)
         return inv_dz*( F(i,j,k,ncomp) - F(i,j-1,k,ncomp) );
+#elif (defined WARPX_DIM_1D_Z)
+        return inv_dz*( F(i,j,k,ncomp) - F(i-1,j,k,ncomp) );
 #endif
     }
 
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.H b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.H
index 5c1d68687..01d83804b 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.H
+++ b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.H
@@ -74,8 +74,13 @@ struct CartesianNodalAlgorithm {
         int const i, int const j, int const k, int const ncomp=0 ) {
 
         using namespace amrex;
+#if (defined WARPX_DIM_1D_Z)
+        ignore_unused(i, j, k, coefs_x, ncomp, F);
+        return 0._rt; // 1D Cartesian: derivative along x is 0
+#else
         Real const inv_dx = coefs_x[0];
         return 0.5_rt*inv_dx*( F(i+1,j,k,ncomp) - F(i-1,j,k,ncomp) );
+#endif
     }
 
     /**
@@ -88,8 +93,14 @@ struct CartesianNodalAlgorithm {
         amrex::Real const * const coefs_x, int const n_coefs_x,
         int const i, int const j, int const k, int const ncomp=0 ) {
 
+        using namespace amrex;
+#if (defined WARPX_DIM_1D_Z)
+        ignore_unused(i, j, k, coefs_x, n_coefs_x, ncomp, F);
+        return 0._rt; // 1D Cartesian: derivative along x is 0
+#else
         return UpwardDx( F, coefs_x, n_coefs_x, i, j, k ,ncomp);
         // For CartesianNodalAlgorithm, UpwardDx and DownwardDx are equivalent
+#endif
     }
 
     /**
@@ -106,9 +117,9 @@ struct CartesianNodalAlgorithm {
 #if defined WARPX_DIM_3D
         Real const inv_dy = coefs_y[0];
         return 0.5_rt*inv_dy*( F(i,j+1,k,ncomp) - F(i,j-1,k,ncomp) );
-#elif (defined WARPX_DIM_XZ)
+#elif defined(WARPX_DIM_XZ) || defined(WARPX_DIM_1D_Z)
         ignore_unused(i, j, k, coefs_y, ncomp, F);
-        return 0._rt; // 2D Cartesian: derivative along y is 0
+        return 0._rt; // 1D and 2D Cartesian: derivative along y is 0
 #endif
     }
 
@@ -142,6 +153,8 @@ struct CartesianNodalAlgorithm {
         return 0.5_rt*inv_dz*( F(i,j,k+1,ncomp) - F(i,j,k-1,ncomp) );
 #elif (defined WARPX_DIM_XZ)
         return 0.5_rt*inv_dz*( F(i,j+1,k,ncomp) - F(i,j-1,k,ncomp) );
+#elif (defined WARPX_DIM_1D_Z)
+        return 0.5_rt*inv_dz*( F(i+1,j,k,ncomp) - F(i-1,j,k,ncomp) );
 #endif
     }
 
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H
index 4fe813754..f2c8553d5 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H
+++ b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H
@@ -71,8 +71,14 @@ struct CartesianYeeAlgorithm {
         amrex::Real const * const coefs_x, int const /*n_coefs_x*/,
         int const i, int const j, int const k, int const ncomp=0 ) {
 
+        using namespace amrex;
+#if (defined WARPX_DIM_1D_Z)
+        amrex::ignore_unused(F, coefs_x, i, j, k, ncomp);
+        return 0._rt; // 1D Cartesian: derivative along x is 0
+#else
         amrex::Real const inv_dx = coefs_x[0];
         return inv_dx*( F(i+1,j,k,ncomp) - F(i,j,k,ncomp) );
+#endif
     }
 
     /**
@@ -84,8 +90,14 @@ struct CartesianYeeAlgorithm {
         amrex::Real const * const coefs_x, int const /*n_coefs_x*/,
         int const i, int const j, int const k, int const ncomp=0 ) {
 
+        using namespace amrex;
+#if (defined WARPX_DIM_1D_Z)
+        amrex::ignore_unused(F, coefs_x, i, j, k, ncomp);
+        return 0._rt; // 1D Cartesian: derivative along x is 0
+#else
         amrex::Real const inv_dx = coefs_x[0];
         return inv_dx*( F(i,j,k,ncomp) - F(i-1,j,k,ncomp) );
+#endif
     }
 
     /**
@@ -101,10 +113,10 @@ struct CartesianYeeAlgorithm {
         Real const inv_dy = coefs_y[0];
         amrex::ignore_unused(n_coefs_y);
         return inv_dy*( F(i,j+1,k,ncomp) - F(i,j,k,ncomp) );
-#elif (defined WARPX_DIM_XZ)
+#elif (defined WARPX_DIM_XZ || WARPX_DIM_1D_Z)
         amrex::ignore_unused(F, coefs_y, n_coefs_y,
             i, j, k, ncomp);
-        return 0._rt; // 2D Cartesian: derivative along y is 0
+        return 0._rt; // 1D and 2D Cartesian: derivative along y is 0
 #else
         amrex::ignore_unused(F, coefs_y, n_coefs_y,
             i, j, k, ncomp);
@@ -125,10 +137,10 @@ struct CartesianYeeAlgorithm {
         Real const inv_dy = coefs_y[0];
         amrex::ignore_unused(n_coefs_y);
         return inv_dy*( F(i,j,k,ncomp) - F(i,j-1,k,ncomp) );
-#elif (defined WARPX_DIM_XZ)
+#elif (defined WARPX_DIM_XZ || WARPX_DIM_1D_Z)
         amrex::ignore_unused(F, coefs_y, n_coefs_y,
             i, j, k, ncomp);
-        return 0._rt; // 2D Cartesian: derivative along y is 0
+        return 0._rt; // 1D and 2D Cartesian: derivative along y is 0
 #else
         amrex::ignore_unused(F, coefs_y, n_coefs_y,
             i, j, k, ncomp);
@@ -149,6 +161,8 @@ struct CartesianYeeAlgorithm {
         return inv_dz*( F(i,j,k+1,ncomp) - F(i,j,k,ncomp) );
 #elif (defined WARPX_DIM_XZ)
         return inv_dz*( F(i,j+1,k,ncomp) - F(i,j,k,ncomp) );
+#elif (defined WARPX_DIM_1D_Z)
+        return inv_dz*( F(i+1,j,k,ncomp) - F(i,j,k,ncomp) );
 #endif
     }
 
@@ -167,6 +181,8 @@ struct CartesianYeeAlgorithm {
         return inv_dz*( F(i,j,k,ncomp) - F(i,j,k-1,ncomp) );
 #elif (defined WARPX_DIM_XZ)
         return inv_dz*( F(i,j,k,ncomp) - F(i,j-1,k,ncomp) );
+#elif (defined WARPX_DIM_1D_Z)
+        return inv_dz*( F(i,j,k,ncomp) - F(i-1,j,k,ncomp) );
 #endif
     }