diff options
author | 2019-12-18 09:00:43 -0800 | |
---|---|---|
committer | 2019-12-18 09:00:43 -0800 | |
commit | 11516e4e0ec304f5acb7044f84875fb327b46fa0 (patch) | |
tree | 4937709090cf6a88d9a77dc3315e4c65e7f61bd9 /Source/FieldSolver/SpectralSolver/SpectralFieldData.H | |
parent | d76fa513ff75ee723de8b8a055f8106105fbe058 (diff) | |
download | WarpX-11516e4e0ec304f5acb7044f84875fb327b46fa0.tar.gz WarpX-11516e4e0ec304f5acb7044f84875fb327b46fa0.tar.zst WarpX-11516e4e0ec304f5acb7044f84875fb327b46fa0.zip |
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 |