Docs: inputs section cleanup - QED #6385
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EZoni
reviewed
Nov 13, 2025
Co-authored-by: Edoardo Zoni <[email protected]>
EZoni
reviewed
Nov 13, 2025
Docs/source/usage/parameters.rst
Outdated
Comment on lines
3857
to
3864
|
|
||
| * ``<species_name>.do_classical_radiation_reaction`` (`int`) optional (default `0`) | ||
| Enables Radiation Reaction (or Radiation Friction) for the species. Species | ||
| must be either electrons or positrons. Boris pusher must be used for the | ||
| simulation. If both ``<species>.do_classical_radiation_reaction`` and | ||
| ``<species_name>.do_qed_quantum_sync`` are enabled, then the classical module | ||
| will be used when the particle's chi parameter is below ``qed_qs.chi_min``, | ||
| the discrete quantum module otherwise. |
Member
There was a problem hiding this comment.
Just a quick comment: classical radiation reaction does not require a compilation with WarpX_QED=ON, since it is just a modified Boris pusher.
Docs/source/usage/parameters.rst
Outdated
|
|
||
| Lookup tables store pre-computed values for functions used by the QED modules. | ||
| **This feature requires to compile with QED=TRUE (and also with QED_TABLE_GEN=TRUE for table generation)** | ||
| This feature requires with the extra build option ``-DWarpX_QED_TABLE_GEN=ON`` for table generation. |
Member
There was a problem hiding this comment.
We can update this: either you compile with DWarpX_QED_TABLE_GEN=ON or you use the external table generator (we can link the documentation page that explains how to use it).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
QED input parameters are moved to a dedicated subsection. Split from #6355.