diff options
author | 2020-01-07 15:52:36 -0800 | |
---|---|---|
committer | 2020-01-07 15:52:36 -0800 | |
commit | bed6fa6939db176d4f5987db8792e793951932e5 (patch) | |
tree | 293a28b0217d0628e2db8c2a8729b85e3a15ec2c /Source/FieldSolver/SpectralSolver/SpectralFieldData.H | |
parent | 03043ce368c8c1dbe081c52126e6a61e94b42edb (diff) | |
parent | 8ea11195d34d61e9353da2f00ee081e6d751149b (diff) | |
download | WarpX-bed6fa6939db176d4f5987db8792e793951932e5.tar.gz WarpX-bed6fa6939db176d4f5987db8792e793951932e5.tar.zst WarpX-bed6fa6939db176d4f5987db8792e793951932e5.zip |
Merge pull request #573 from MaxThevenet/reformat_doxygen
Make comments in header files Doxygen-readable
Diffstat (limited to 'Source/FieldSolver/SpectralSolver/SpectralFieldData.H')
-rw-r--r-- | Source/FieldSolver/SpectralSolver/SpectralFieldData.H | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Source/FieldSolver/SpectralSolver/SpectralFieldData.H b/Source/FieldSolver/SpectralSolver/SpectralFieldData.H index 01ca11083..dc83d279d 100644 --- a/Source/FieldSolver/SpectralSolver/SpectralFieldData.H +++ b/Source/FieldSolver/SpectralSolver/SpectralFieldData.H @@ -8,20 +8,20 @@ // Declare type for spectral fields using SpectralField = amrex::FabArray< amrex::BaseFab <Complex> >; -/* Index for the regular fields, when stored in spectral space */ +/** Index for the regular fields, when stored in spectral space */ struct SpectralFieldIndex { enum { Ex=0, Ey, Ez, Bx, By, Bz, Jx, Jy, Jz, rho_old, rho_new, n_fields }; // n_fields is automatically the total number of fields }; -/* Index for the PML fields, when stored in spectral space */ +/** Index for the PML fields, when stored in spectral space */ struct SpectralPMLIndex { enum { Exy=0, Exz, Eyx, Eyz, Ezx, Ezy, Bxy, Bxz, Byx, Byz, Bzx, Bzy, n_fields }; // n_fields is automatically the total number of fields }; -/* \brief Class that stores the fields in spectral space, and performs the +/** \brief Class that stores the fields in spectral space, and performs the * Fourier transforms between real space and spectral space */ class SpectralFieldData |