New Input Parameter for Order of Shape Factors (#1934)

* Define New Input Parameter interpolation.shape_factors_order

* Use New Input Parameter, Remove Obsolete Ones

* Add New Input Parameter to PICMI Interface

* Update Docs, Use New Input Parameter in Remaining Input Files

* Cleaning

* New Name: algo.particle_shape

19 files changed, 61 insertions, 24 deletions

diff --git a/Examples/Modules/RigidInjection/inputs_2d_BoostedFrame b/Examples/Modules/RigidInjection/inputs_2d_BoostedFrame
index 6ee50e80b..fabddbc93 100644
--- a/Examples/Modules/RigidInjection/inputs_2d_BoostedFrame
+++ b/Examples/Modules/RigidInjection/inputs_2d_BoostedFrame
@@ -21,6 +21,10 @@ warpx.do_moving_window = 1
 warpx.moving_window_dir = z
 warpx.moving_window_v = 1.0 # in units of the speed of light
 warpx.serialize_ics = 1
+
+# Order of particle shape factors
+algo.particle_shape = 1
+
 particles.species_names = beam
 particles.rigid_injected_species = beam
 beam.charge = -q_e
diff --git a/Examples/Modules/RigidInjection/inputs_2d_LabFrame b/Examples/Modules/RigidInjection/inputs_2d_LabFrame
index 70a87b405..be71eb81b 100644
--- a/Examples/Modules/RigidInjection/inputs_2d_LabFrame
+++ b/Examples/Modules/RigidInjection/inputs_2d_LabFrame
@@ -13,6 +13,10 @@ warpx.do_moving_window = 1
 warpx.moving_window_dir = z
 warpx.moving_window_v = 1.0 # in units of the speed of light
 warpx.serialize_ics = 1
+
+# Order of particle shape factors
+algo.particle_shape = 1
+
 particles.species_names = beam
 particles.rigid_injected_species = beam
 beam.charge = -q_e
diff --git a/Examples/Modules/boosted_diags/inputs_3d_slice b/Examples/Modules/boosted_diags/inputs_3d_slice
index a5112d405..d2663eece 100644
--- a/Examples/Modules/boosted_diags/inputs_3d_slice
+++ b/Examples/Modules/boosted_diags/inputs_3d_slice
@@ -15,13 +15,13 @@ algo.charge_deposition = standard
 algo.field_gathering = energy-conserving
 algo.particle_pusher = vay
 algo.maxwell_solver = ckc
-interpolation.nox = 3
-interpolation.noy = 3
-interpolation.noz = 3
 warpx.use_filter = 1
 warpx.cfl = 1.
 warpx.do_pml = 0
 
+# Order of particle shape factors
+algo.particle_shape = 3
+
 warpx.do_moving_window = 1
 warpx.moving_window_dir = z
 warpx.moving_window_v = 1.0 # in units of the speed of light
diff --git a/Examples/Modules/dive_cleaning/inputs_3d b/Examples/Modules/dive_cleaning/inputs_3d
index 9ac9d9fae..173e8e468 100644
--- a/Examples/Modules/dive_cleaning/inputs_3d
+++ b/Examples/Modules/dive_cleaning/inputs_3d
@@ -11,6 +11,9 @@ geometry.prob_hi     =  50.e-6    50.e-6   50.e-6
 warpx.do_dive_cleaning = 1
 warpx.do_pml = 1
 
+# Order of particle shape factors
+algo.particle_shape = 1
+
 particles.species_names = beam
 beam.charge = -q_e
 beam.mass = 1.e30
diff --git a/Examples/Modules/embedded_boundary_cube/inputs_3d b/Examples/Modules/embedded_boundary_cube/inputs_3d
index 481707540..7f00d0f4a 100644
--- a/Examples/Modules/embedded_boundary_cube/inputs_3d
+++ b/Examples/Modules/embedded_boundary_cube/inputs_3d
@@ -11,6 +11,9 @@ warpx.do_pml = 0
 warpx.const_dt = 1e-6
 warpx.cfl = 1
 
+# Order of particle shape factors
+algo.particle_shape = 1
+
 eb2.geom_type = box
 eb2.box_lo = -0.5 -0.5 -0.5
 eb2.box_hi = 0.5 0.5 0.5
diff --git a/Examples/Modules/ionization/inputs_2d_bf_rt b/Examples/Modules/ionization/inputs_2d_bf_rt
index 916c56046..e29022889 100644
--- a/Examples/Modules/ionization/inputs_2d_bf_rt
+++ b/Examples/Modules/ionization/inputs_2d_bf_rt
@@ -17,6 +17,9 @@ warpx.moving_window_v = 1.0
 warpx.gamma_boost = 2.
 warpx.boost_direction = z
 
+# Order of particle shape factors
+algo.particle_shape = 1
+
 particles.species_names = electrons ions
 
 ions.mass = 2.3428415e-26
diff --git a/Examples/Modules/ionization/inputs_2d_rt b/Examples/Modules/ionization/inputs_2d_rt
index 72fd60d47..8244093c8 100644
--- a/Examples/Modules/ionization/inputs_2d_rt
+++ b/Examples/Modules/ionization/inputs_2d_rt
@@ -12,6 +12,9 @@ algo.maxwell_solver = ckc
 warpx.do_pml = 1
 warpx.cfl = .999
 
+# Order of particle shape factors
+algo.particle_shape = 1
+
 particles.species_names = electrons ions
 
 ions.mass = 2.3428415e-26
diff --git a/Examples/Modules/laser_injection/inputs_2d_rt b/Examples/Modules/laser_injection/inputs_2d_rt
index b7c45b4ed..714409e17 100644
--- a/Examples/Modules/laser_injection/inputs_2d_rt
+++ b/Examples/Modules/laser_injection/inputs_2d_rt
@@ -28,6 +28,9 @@ algo.current_deposition = esirkepov
 # CFL
 warpx.cfl = 1.0
 
+# Order of particle shape factors
+algo.particle_shape = 1
+
 # Laser
 lasers.names        = laser1
 laser1.profile      = Gaussian
diff --git a/Examples/Modules/laser_injection/inputs_3d_rt b/Examples/Modules/laser_injection/inputs_3d_rt
index e755cc4f1..f3612079b 100644
--- a/Examples/Modules/laser_injection/inputs_3d_rt
+++ b/Examples/Modules/laser_injection/inputs_3d_rt
@@ -28,6 +28,9 @@ warpx.do_pml = 0
 # CFL
 warpx.cfl = 1.0
 
+# Order of particle shape factors
+algo.particle_shape = 1
+
 # Laser
 lasers.names        = laser1
 laser1.profile      = Gaussian
diff --git a/Examples/Modules/laser_injection_from_file/inputs.2d_test_txye b/Examples/Modules/laser_injection_from_file/inputs.2d_test_txye
index 43f0d1c93..a8f3db773 100644
--- a/Examples/Modules/laser_injection_from_file/inputs.2d_test_txye
+++ b/Examples/Modules/laser_injection_from_file/inputs.2d_test_txye
@@ -16,14 +16,14 @@ warpx.serialize_ics = 1
 #################################
 ############ NUMERICS ###########
 #################################
-interpolation.nox = 3
-interpolation.noy = 3
-interpolation.noz = 3
 warpx.cfl = 0.98
 warpx.use_filter = 0
 algo.maxwell_solver = ckc
 algo.load_balance_intervals = -1
 
+# Order of particle shape factors
+algo.particle_shape = 3
+
 #################################
 ############# LASER #############
 #################################
diff --git a/Examples/Modules/nci_corrector/inputs_2d b/Examples/Modules/nci_corrector/inputs_2d
index e53cbc438..78970b59e 100644
--- a/Examples/Modules/nci_corrector/inputs_2d
+++ b/Examples/Modules/nci_corrector/inputs_2d
@@ -24,9 +24,9 @@ warpx.do_pml = 0
 
 # Algorithms
 algo.current_deposition = esirkepov
-interpolation.nox = 3
-interpolation.noy = 3
-interpolation.noz = 3
+
+# Order of particle shape factors
+algo.particle_shape = 3
 
 warpx.serialize_ics = 1
 warpx.cfl = 1.0
diff --git a/Examples/Modules/qed/breit_wheeler/inputs_2d b/Examples/Modules/qed/breit_wheeler/inputs_2d
index 767543c05..26426f864 100644
--- a/Examples/Modules/qed/breit_wheeler/inputs_2d
+++ b/Examples/Modules/qed/breit_wheeler/inputs_2d
@@ -18,9 +18,6 @@ algo.current_deposition = esirkepov
 algo.charge_deposition = standard
 algo.field_gathering = energy-conserving
 algo.particle_pusher = boris
-interpolation.nox = 3 # Particle interpolation order. Must be the same in x, y, and z
-interpolation.noy = 3
-interpolation.noz = 3
 warpx.verbose = 1
 warpx.do_dive_cleaning = 0
 warpx.use_filter = 1
@@ -28,6 +25,9 @@ warpx.cfl = 1. # if 1., the time step is set to its CFL limit
 warpx.do_pml = 1 # use Perfectly Matched Layer as boundary condition
 warpx.serialize_ics = 1
 
+# Order of particle shape factors
+algo.particle_shape = 3
+
 #################################
 ############ PLASMA #############
 #################################
diff --git a/Examples/Modules/qed/breit_wheeler/inputs_3d b/Examples/Modules/qed/breit_wheeler/inputs_3d
index c690d564b..e31e2c536 100644
--- a/Examples/Modules/qed/breit_wheeler/inputs_3d
+++ b/Examples/Modules/qed/breit_wheeler/inputs_3d
@@ -18,9 +18,6 @@ algo.current_deposition = esirkepov
 algo.charge_deposition = standard
 algo.field_gathering = energy-conserving
 algo.particle_pusher = boris
-interpolation.nox = 3 # Particle interpolation order. Must be the same in x, y, and z
-interpolation.noy = 3
-interpolation.noz = 3
 warpx.verbose = 1
 warpx.do_dive_cleaning = 0
 warpx.use_filter = 1
@@ -28,6 +25,9 @@ warpx.cfl = 1. # if 1., the time step is set to its CFL limit
 warpx.do_pml = 1 # use Perfectly Matched Layer as boundary condition
 warpx.serialize_ics = 1
 
+# Order of particle shape factors
+algo.particle_shape = 3
+
 #################################
 ############ PLASMA #############
 #################################
diff --git a/Examples/Modules/qed/quantum_synchrotron/inputs_2d b/Examples/Modules/qed/quantum_synchrotron/inputs_2d
index d271f65fd..c735bafd7 100644
--- a/Examples/Modules/qed/quantum_synchrotron/inputs_2d
+++ b/Examples/Modules/qed/quantum_synchrotron/inputs_2d
@@ -18,9 +18,6 @@ algo.current_deposition = esirkepov
 algo.charge_deposition = standard
 algo.field_gathering = energy-conserving
 algo.particle_pusher = boris
-interpolation.nox = 3 # Particle interpolation order. Must be the same in x, y, and z
-interpolation.noy = 3
-interpolation.noz = 3
 warpx.verbose = 1
 warpx.do_dive_cleaning = 0
 warpx.use_filter = 1
@@ -28,6 +25,9 @@ warpx.cfl = 1. # if 1., the time step is set to its CFL limit
 warpx.do_pml = 1 # use Perfectly Matched Layer as boundary condition
 warpx.serialize_ics = 1
 
+# Order of particle shape factors
+algo.particle_shape = 3
+
 #################################
 ############ PLASMA #############
 #################################
diff --git a/Examples/Modules/qed/quantum_synchrotron/inputs_3d b/Examples/Modules/qed/quantum_synchrotron/inputs_3d
index 2e45803a6..e7a3c7175 100644
--- a/Examples/Modules/qed/quantum_synchrotron/inputs_3d
+++ b/Examples/Modules/qed/quantum_synchrotron/inputs_3d
@@ -18,9 +18,6 @@ algo.current_deposition = esirkepov
 algo.charge_deposition = standard
 algo.field_gathering = energy-conserving
 algo.particle_pusher = boris
-interpolation.nox = 3 # Particle interpolation order. Must be the same in x, y, and z
-interpolation.noy = 3
-interpolation.noz = 3
 warpx.verbose = 1
 warpx.do_dive_cleaning = 0
 warpx.use_filter = 1
@@ -28,6 +25,9 @@ warpx.cfl = 1. # if 1., the time step is set to its CFL limit
 warpx.do_pml = 1 # use Perfectly Matched Layer as boundary condition
 warpx.serialize_ics = 1
 
+# Order of particle shape factors
+algo.particle_shape = 3
+
 #################################
 ############ PLASMA #############
 #################################
diff --git a/Examples/Modules/qed/schwinger/inputs_3d_schwinger b/Examples/Modules/qed/schwinger/inputs_3d_schwinger
index 446eeb6e7..aaa53af9b 100644
--- a/Examples/Modules/qed/schwinger/inputs_3d_schwinger
+++ b/Examples/Modules/qed/schwinger/inputs_3d_schwinger
@@ -18,14 +18,14 @@ algo.current_deposition = esirkepov
 algo.charge_deposition = standard
 algo.field_gathering = momentum-conserving
 algo.particle_pusher = boris
-interpolation.nox = 1 # Particle interpolation order. Must be the same in x, y, and z
-interpolation.noy = 1
-interpolation.noz = 1
 warpx.verbose = 1
 warpx.cfl = 1. # if 1., the time step is set to its CFL limit
 warpx.do_pml = 0 # use Perfectly Matched Layer as boundary condition
 warpx.serialize_ics = 1
 
+# Order of particle shape factors
+algo.particle_shape = 1
+
 #################################
 ###### EXTERNAL EM FIELD ########
 #################################
diff --git a/Examples/Modules/relativistic_space_charge_initialization/inputs_3d b/Examples/Modules/relativistic_space_charge_initialization/inputs_3d
index d6758d160..2e41c4edd 100644
--- a/Examples/Modules/relativistic_space_charge_initialization/inputs_3d
+++ b/Examples/Modules/relativistic_space_charge_initialization/inputs_3d
@@ -10,6 +10,10 @@ geometry.prob_lo     = -50.e-6   -50.e-6    -50.e-6
 geometry.prob_hi     =  50.e-6    50.e-6     50.e-6
 
 warpx.cfl = 1.e-5
+
+# Order of particle shape factors
+algo.particle_shape = 1
+
 particles.species_names = beam
 beam.charge = -q_e
 beam.mass = m_e
diff --git a/Examples/Modules/resampling/inputs_leveling_thinning b/Examples/Modules/resampling/inputs_leveling_thinning
index d13e60142..e5de6b7f1 100644
--- a/Examples/Modules/resampling/inputs_leveling_thinning
+++ b/Examples/Modules/resampling/inputs_leveling_thinning
@@ -9,6 +9,9 @@ amr.max_level = 0
 
 warpx.do_pml = 0
 
+# Order of particle shape factors
+algo.particle_shape = 1
+
 particles.species_names = resampled_part1 resampled_part2
 
 my_constants.pi = 3.141592653589793
diff --git a/Examples/Modules/space_charge_initialization/inputs_3d b/Examples/Modules/space_charge_initialization/inputs_3d
index 4fe2fbabb..322cb3aad 100644
--- a/Examples/Modules/space_charge_initialization/inputs_3d
+++ b/Examples/Modules/space_charge_initialization/inputs_3d
@@ -10,6 +10,10 @@ geometry.prob_lo     = -50.e-6   -50.e-6    -50.e-6
 geometry.prob_hi     =  50.e-6    50.e-6     50.e-6
 
 warpx.cfl = 1.e-3
+
+# Order of particle shape factors
+algo.particle_shape = 1
+
 particles.species_names = beam
 beam.charge = -q_e
 beam.mass = m_e