Coupling WarpX with an ✨improved✨ version of the QED library (#1198)

* Initial work to couple improved QED module to WarpX

* WIP to couple with WarpX the new QED library

* Continuing work to couple the new version of the QED library with WarpX

* progress towards completing coupling with new version of QED library

* WarpX coupled with new version of QED library

* default behavior is to display table generation progress

* some host device functions are now device only

* fixed bug

* bugfixing

* updating tests

* updated test

* updated test

* added initial version of tests (not working)

* added check and updated a comment

* fixed bug

* added inputfiles and analysis script for new BW tests

* test for BW process are ready

* modified test

* make lgtm happy

* removed TABs

* initial work to add QS tests (not working)

* removed old tests

* fixed bug in script

* changed position of evolution of optical depth

* progress with QSR tests

* improved test

* very low energy photons are always eliminated

* added tests to regression suite

* improved test

* improved tests

* removed redundant parameter

* removed trailing white space

* updated documentation

* fix lgtm warnings

* fixed missing check on chi parameter

* fixed missing check on chi parameter & bugfixing

* improved comments

* increased tolerance in tests

* updated units in test

* now test succeds if the error is extremely small

* updated checksums

* fixed bug

* fixed some unused or uninitialized variables warnings

* now using ignore_unused instead of commenting out some variables

* fixed warnings

* partial fix of a test

* fixed test

* fixed test

* added checksums

* fixed tests

* fixed benchmark for qed_schwinger2

* removed checksums for tests which do no exist anymore

* fixed checksums for several qed tests

* fixed checksums for several qed tests

* fixed checksums

* removed unwanted checksum

* fixed checksum

* removed files which should have been deleted

* add some const

* [skip ci] added some docstrings and some const

* Update Source/Particles/ElementaryProcess/QEDInternals/BreitWheelerEngineWrapper.H

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/ElementaryProcess/QEDInternals/BreitWheelerEngineWrapper.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/ElementaryProcess/QEDInternals/QuantumSyncEngineWrapper.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* added some docstrings and some const

* replaced ManagedVectors with DeviceVectors

* Update Source/Particles/ElementaryProcess/QEDInternals/QedWrapperCommons.H

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* added some const

* removed unwanted assert

* updated comment

* changed position of GPU synchronization directive

* Update Docs/source/running_cpp/parameters.rst

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Examples/Modules/qed/quantum_synchrotron/analysis.py

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Examples/Modules/qed/quantum_synchrotron/analysis.py

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Examples/Modules/qed/breit_wheeler/analysis.py

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Examples/Modules/qed/breit_wheeler/analysis.py

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* add do_plot option to some analysis scripts

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* uncomment a line

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* simplified input scripts for BW tests

* simplified input scripts for QS tests

* removed unwanted files

* simplified analysis script

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* reverted modification to schwinger analysis script

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* remove outdated comment

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Source/Particles/MultiParticleContainer.cpp

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* fix warnings

* made test more robust

* reset benchmark for qed_breit_wheeler_2d

* fixed bug in test

* make test more robust

* made test more robust

* Update Examples/Modules/qed/quantum_synchrotron/analysis.py

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update Examples/Modules/qed/quantum_synchrotron/analysis.py

Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>

* Update run_test.sh

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

Co-authored-by: Tools <warpx@lbl.gov>
Co-authored-by: NeilZaim <49716072+NeilZaim@users.noreply.github.com>
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

1 files changed, 31 insertions, 24 deletions

diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 75d65deb9..a6fa558f1 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -558,36 +558,36 @@ Particle initialization
 * ``<species>.do_qed`` (`int`) optional (default `0`)
     If `<species>.do_qed = 0` all the QED effects are disabled for this species.
     If `<species>.do_qed = 1` QED effects can be enabled for this species (see below).
-    **Implementation of this feature is in progress. It requires `picsar` on the `QED` branch and to compile with QED=TRUE**
+    **This feature requires to compile with QED=TRUE**
 
 * ``<species>.do_qed_quantum_sync`` (`int`) optional (default `0`)
     It only works if `<species>.do_qed = 1`. Enables Quantum synchrotron emission for this species.
     Quantum synchrotron lookup table should be either generated or loaded from disk to enable
     this process (see "Lookup tables for QED modules" section below).
     `<species>` must be either an electron or a positron species.
-    **Implementation of this feature is in progress. It requires `picsar` on the `QED` branch and to compile with QED=TRUE**
+    **This feature requires to compile with QED=TRUE**
 
 * ``<species>.do_qed_breit_wheeler`` (`int`) optional (default `0`)
     It only works if `<species>.do_qed = 1`. Enables non-linear Breit-Wheeler process for this species.
     Breit-Wheeler lookup table should be either generated or loaded from disk to enable
     this process (see "Lookup tables for QED modules" section below).
     `<species>` must be a photon species.
-    **Implementation of this feature is in progress. It requires `picsar` on the `QED` branch and to compile with QED=TRUE**
+    **This feature requires to compile with QED=TRUE**
 
 * ``<species>.qed_quantum_sync_phot_product_species`` (`string`)
     If an electron or a positron species has the Quantum synchrotron process, a photon product species must be specified
     (the name of an existing photon species must be provided)
-    **Implementation of this feature is in progress. It requires `picsar` on the `QED` branch and to compile with QED=TRUE**
+    **This feature requires to compile with QED=TRUE**
 
 * ``<species>.qed_breit_wheeler_ele_product_species`` (`string`)
     If a photon species has the Breit-Wheeler process, an electron product species must be specified
     (the name of an existing electron species must be provided)
-    **Implementation of this feature is in progress. It requires `picsar` on the `QED` branch and to compile with QED=TRUE**
+    **This feature requires to compile with QED=TRUE**
 
 * ``<species>.qed_breit_wheeler_pos_product_species`` (`string`)
     If a photon species has the Breit-Wheeler process, a positron product species must be specified
     (the name of an existing positron species must be provided).
-    **Implementation of this feature is in progress. It requires `picsar` on the `QED` branch and to compile with QED=TRUE**
+    **This feature requires to compile with QED=TRUE**
 
 .. _running-cpp-parameters-laser:
 
@@ -1725,23 +1725,22 @@ Reduced Diagnostics
     The separator between row values in the output file.
     The default separator is a whitespace.
 
-Lookup tables and other settings for QED modules (implementation in progress)
+Lookup tables and other settings for QED modules
 -----------------------------------------------------------------------------
 
 Lookup tables store pre-computed values for functions used by the QED modules.
-**Implementation of this feature is in progress. It requires `picsar` on the `QED` branch and to compile with QED=TRUE**
+**This feature requires to compile with QED=TRUE (and also with QED_TABLE_GEN=TRUE for table generation) **
 
 * ``qed_bw.lookup_table_mode`` (`string`)
     There are three options to prepare the lookup table required by the Breit-Wheeler module:
 
-    * ``dummy_builtin``:  a built-in table is used (Warning: the quality of the table is very low,
-      so this option has to be used only for test purposes).
+    * ``builtin``:  a built-in table is used (Warning: the table gives reasonable results but its resolution
+    is quite low).
 
     * ``generate``: a new table is generated. This option requires Boost math library
       (version >= 1.67) and to compile with QED_TABLE_GEN=TRUE. All
-      the following parameters must be specified:
-
-        * ``qed_bw.chi_min`` (`float`): minimum chi parameter to be considered by the engine
+      the following parameters must be specified (table 1 is used to evolve the optical depth
+      of the photons, while table 2 is used for pair generation):
 
         * ``qed_bw.tab_dndt_chi_min`` (`float`): minimum chi parameter for lookup table 1 (
           used for the evolution of the optical depth of the photons)
@@ -1758,8 +1757,8 @@ Lookup tables store pre-computed values for functions used by the QED modules.
         * ``qed_bw.tab_pair_chi_how_many`` (`int`): number of points to be used for chi axis in lookup table 2
 
         * ``qed_bw.tab_pair_frac_how_many`` (`int`): number of points to be used for the second axis in lookup table 2
-          (the second axis is the ratio between the energy of the less energetic particle of the pair and the
-          energy of the photon).
+          (the second axis is the ratio between the quantum parameter of the less energetic particle of the pair and the
+          quantum parameter of the photon).
 
         * ``qed_bw.save_table_in`` (`string`): where to save the lookup table
 
@@ -1771,14 +1770,13 @@ Lookup tables store pre-computed values for functions used by the QED modules.
 * ``qed_qs.lookup_table_mode`` (`string`)
     There are three options to prepare the lookup table required by the Quantum Synchrotron module:
 
-    * ``dummy_builtin``:  a built-in table is used (Warning: the quality of the table is very low,
-      so this option has to be used only for test purposes).
+    * ``builtin``: a built-in table is used (Warning: the table gives reasonable results but its resolution
+    is quite low).
 
     * ``generate``: a new table is generated. This option requires Boost math library
       (version >= 1.67) and to compile with QED_TABLE_GEN=TRUE. All
-      the following parameters must be specified:
-
-        * ``qed_qs.chi_min`` (`float`): minimum chi parameter to be considered by the engine
+      the following parameters must be specified (table 1 is used to evolve the optical depth
+      of the particles, while table 2 is used for photon emission):
 
         * ``qed_qs.tab_dndt_chi_min`` (`float`): minimum chi parameter for lookup table 1 (
           used for the evolution of the optical depth of electrons and positrons)
@@ -1794,8 +1792,11 @@ Lookup tables store pre-computed values for functions used by the QED modules.
 
         * ``qed_qs.tab_em_chi_how_many`` (`int`): number of points to be used for chi axis in lookup table 2
 
-        * ``qed_qs.tab_em_prob_how_many`` (`int`): number of points to be used for the second axis in lookup table 2
-          (the second axis is a cumulative probability).
+        * ``qed_qs.tab_em_frac_how_many`` (`int`): number of points to be used for the second axis in lookup table 2
+          (the second axis is the ratio between the quantum parameter of the photon and the
+          quantum parameter of the charged particle).
+
+        * ``qed_qs.tab_em_frac_min`` (`float`): minimum value to be considered for the second axis of lookup table 2
 
         * ``qed_bw.save_table_in`` (`string`): where to save the lookup table
 
@@ -1804,8 +1805,14 @@ Lookup tables store pre-computed values for functions used by the QED modules.
 
         * ``qed_qs.load_table_from`` (`string`): name of the lookup table file to read from.
 
-* ``qed_qs.photon_creation_energy_threshold`` (`float`) optional (default `2*me*c^2`)
-    Energy threshold for photon particle creation in SI units.
+* ``qed_bw.chi_min`` (`float`): minimum chi parameter to be considered by the Breit-Wheeler engine
+    (suggested value : 0.01)
+
+* ``qed_qs.chi_min`` (`float`): minimum chi parameter to be considered by the Quantum Synchrotron engine
+    (suggested value : 0.001)
+
+* ``qed_qs.photon_creation_energy_threshold`` (`float`) optional (default `2`)
+    Energy threshold for photon particle creation in `*me*c^2` units.
 
 * ``warpx.do_qed_schwinger`` (`bool`) optional (default `0`)
     If this is 1, Schwinger electron-positron pairs can be generated in vacuum in the cells where the EM field is high enough.