Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Radiation plugin: Save amplitudes additionally per rank #4456

Merged
merged 7 commits into from
May 2, 2023
Merged

Radiation plugin: Save amplitudes additionally per rank #4456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f95cad3
open Series in parallel
franzpoeschel Feb 8, 2023
407247a
Write distributed amplitudes with split imaginary and real parts
franzpoeschel Feb 8, 2023
432d1c9
Store as std::complex
franzpoeschel Feb 8, 2023
000d196
Add parameter to switch this on/off
franzpoeschel Feb 21, 2023
9f81d6a
.rst documentation
franzpoeschel Feb 27, 2023
85ca362
Comments and cleanup
franzpoeschel Apr 25, 2023
0909647
Cleanup - I missed this one
franzpoeschel Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 40 additions & 16 deletions docs/source/usage/plugins/radiation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,21 +314,27 @@ Output

Depending on the command line options used, there are different output files.

======================================== ========================================================================================================================
Command line flag Output description
======================================== ========================================================================================================================
``--<species>_radiation.totalRadiation`` Contains *ASCII* files that have the total spectral intensity until the timestep specified by the filename.
Each row gives data for one observation direction (same order as specified in the ``observer.py``).
The values for each frequency are separated by *tabs* and have the same order as specified in ``radiation.param``.
The spectral intensity is stored in the units :math:`\mathrm{[Js]}`.
``--<species>_radiation.lastRadiation`` has the same format as the output of *totalRadiation*.
The spectral intensity is only summed over the last radiation ``dump`` period.
``--<species>_radiation.radPerGPU`` Same output as *totalRadiation* but only summed over each GPU.
Because each GPU specifies a spatial region, the origin of radiation signatures can be distinguished.
*radiationOpenPMD* In the folder ``radiationOpenPMD``, openPMD files (currently hdf5) for each radiation dump and species are stored.
These are complex amplitudes in units used by *PIConGPU*.
These are for restart purposes and for more complex data analysis.
======================================== ========================================================================================================================
============================================== ========================================================================================================================
Command line flag Output description
============================================== ========================================================================================================================
``--<species>_radiation.totalRadiation`` Contains *ASCII* files that have the total spectral intensity until the timestep specified by the filename.
Each row gives data for one observation direction (same order as specified in the ``observer.py``).
The values for each frequency are separated by *tabs* and have the same order as specified in ``radiation.param``.
The spectral intensity is stored in the units :math:`\mathrm{[Js]}`.
``--<species>_radiation.lastRadiation`` has the same format as the output of *totalRadiation*.
The spectral intensity is only summed over the last radiation ``dump`` period.
``--<species>_radiation.radPerGPU`` Same output as *totalRadiation* but only summed over each GPU.
Because each GPU specifies a spatial region, the origin of radiation signatures can be distinguished.
``--<species>_radiation.distributedAmplitude`` By default, the amplitudes are summed up over the MPI ranks.
Some analyses require the raw distributed output of amplitudes without prior summation.
Activating this flag will make the Radiation plugin additionally output the amplitudes before summation.
The first dimension in the dataset output corresponds with the parallel distribution of MPI workers.
Note that instead of separate datasets for the imaginary and real parts, this output is formatted as datasets of complex
number types.
*radiationOpenPMD* In the folder ``radiationOpenPMD``, openPMD files (currently hdf5) for each radiation dump and species are stored.
These are complex amplitudes in units used by *PIConGPU*.
These are for restart purposes and for more complex data analysis.
============================================== ========================================================================================================================


Text-based output
Expand Down Expand Up @@ -412,6 +418,24 @@ Dataset Description Dimensions
This inconsistency will be fixed in the future.
Until this inconstincy is resolved, please multiply the datasets with the square root of the ``unitSI`` attribute to convert the amplitudes to SI units.

**Amplitude_distributed (Group, opt-in):**

======== ========================================== ============================================
Dataset Description Dimensions
======== ========================================== ============================================
``x`` x-component of the complex amplitude (``MPI ranks``, ``N_observer``, ``N_omega``)
``y`` y-component of the complex amplitude (``MPI ranks``, ``N_observer``, ``N_omega``)
``z`` z-component of the complex amplitude (``MPI ranks``, ``N_observer``, ``N_omega``)
======== ========================================== ============================================

.. note::

Please be aware, that despite the fact, that the SI-unit of each amplitude entry is :math:`\mathrm{[\sqrt{Js}]}`, the stored ``unitSI`` attribute returns :math:`\mathrm{[Js]}`.
This inconsistency will be fixed in the future.
Until this inconstincy is resolved, please multiply the datasets with the square root of the ``unitSI`` attribute to convert the amplitudes to SI units.

Additionally, the representation of complex numbers differs from that in the summed Amplitude output.
This inconsistency will be fixed by changing the output format of the summed Amplitudes.

**DetectorDirection (Group):**

Expand Down Expand Up @@ -559,4 +583,4 @@ References
*Synthetic radiation diagnostics as a pathway for studying plasma dynamics from advanced accelerators to astrophysical observations*,
PhD Thesis at Technische Universität Dresden & Helmholtz-Zentrum Dresden - Rossendorf (2019),
https://doi.org/10.5281/zenodo.3616045

Loading