Galilean PSATD with shift (#704)

* Read Galilean velocity

* Prepare structures for Galilean solver

* Started implementing Galilean equations

* Analytical limits for X1, X2, X3, X4 coefficients added

* Slight changes added

* Added Galilean position pusher

* Scale galilean velocity

* Remove unneeded Abort

* Fix Galilean pusher

* Allocate Theta2 array

* Fix definition of coefficients

* Increase guard cells for Galilean

* Add guard cell in particle exchange

* Type corrected

* v_gal added to warpx_current_deposition

* v_gal added to WarpXParticleContainer.H

* Bug fixed  - update particle x-position over one time step

* Fix issues with merge from dev

* Preparation for merging dev into galilean.

* Adding galilean shift

* Implemented galilean shift

* Changed method's name from GalileanShift to ShiftGalileanBoundary

* Added doxygen string for ShiftGalileanBoundary

* Removed never used method LowerCornerWithCentering

* Removed temporary comments

* Removed dt as a variable from DepositCharge method and its dependencies

* Converted tab to spaces

* Removed EOL white space

* Add documentation and automated tests

* Fix compilation error

* Add automated test

* Update automated test

* Removed temporary used galilean shift

* Removed temporary used particle's push for Galilean PSATD

* Removed unused statement

* Remove EOL white space.

* Added zero shift for LowerCorner in RZ geometry

* Minor changes to Galilean implementation

* Modifications for GPU

* Fix typo

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

1 files changed, 14 insertions, 4 deletions

diff --git a/Source/FieldSolver/SpectralSolver/SpectralSolver.cpp b/Source/FieldSolver/SpectralSolver/SpectralSolver.cpp
index ca7bd06a0..c24a7af69 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralSolver.cpp
+++ b/Source/FieldSolver/SpectralSolver/SpectralSolver.cpp
@@ -7,8 +7,10 @@
 #include <SpectralKSpace.H>
 #include <SpectralSolver.H>
 #include <PsatdAlgorithm.H>
+#include <GalileanAlgorithm.H>
 #include <PMLPsatdAlgorithm.H>
 
+
 /* \brief Initialize the spectral Maxwell solver
  *
  * This function selects the spectral algorithm to be used, allocates the
@@ -28,6 +30,7 @@ SpectralSolver::SpectralSolver(
                 const amrex::DistributionMapping& dm,
                 const int norder_x, const int norder_y,
                 const int norder_z, const bool nodal,
+                const amrex::Array<amrex::Real,3>& v_galilean,
                 const amrex::RealVect dx, const amrex::Real dt,
                 const bool pml ) {
 
@@ -40,13 +43,20 @@ SpectralSolver::SpectralSolver(
 
     // - Select the algorithm depending on the input parameters
     //   Initialize the corresponding coefficients over k space
+
     if (pml) {
         algorithm = std::unique_ptr<PMLPsatdAlgorithm>( new PMLPsatdAlgorithm(
             k_space, dm, norder_x, norder_y, norder_z, nodal, dt ) );
-    } else {
-        algorithm = std::unique_ptr<PsatdAlgorithm>( new PsatdAlgorithm(
-            k_space, dm, norder_x, norder_y, norder_z, nodal, dt ) );
-    }
+    } else if ((v_galilean[0]==0) && (v_galilean[1]==0) && (v_galilean[2]==0)){
+         // v_galilean is 0: use standard PSATD algorithm
+         algorithm = std::unique_ptr<PsatdAlgorithm>( new PsatdAlgorithm(
+             k_space, dm, norder_x, norder_y, norder_z, nodal, dt ) );
+      } else {
+          // Otherwise: use the Galilean algorithm
+          algorithm = std::unique_ptr<GalileanAlgorithm>( new GalileanAlgorithm(
+              k_space, dm, norder_x, norder_y, norder_z, nodal, v_galilean, dt ));
+       }
+
 
     // - Initialize arrays for fields in spectral space + FFT plans
     field_data = SpectralFieldData( realspace_ba, k_space, dm,