diff options
Diffstat (limited to 'Source/FieldSolver/SpectralSolver/SpectralSolver.H')
| -rw-r--r-- | Source/FieldSolver/SpectralSolver/SpectralSolver.H | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/Source/FieldSolver/SpectralSolver/SpectralSolver.H b/Source/FieldSolver/SpectralSolver/SpectralSolver.H index c570b017b..bd92d003f 100644 --- a/Source/FieldSolver/SpectralSolver/SpectralSolver.H +++ b/Source/FieldSolver/SpectralSolver/SpectralSolver.H @@ -4,7 +4,8 @@ #include <SpectralBaseAlgorithm.H> #include <SpectralFieldData.H> -/* \brief Top-level class for the electromagnetic spectral solver +/** + * \brief Top-level class for the electromagnetic spectral solver * * Stores the field in spectral space, and has member functions * to Fourier-transform the fields between real space and spectral space @@ -26,7 +27,8 @@ class SpectralSolver const amrex::RealVect dx, const amrex::Real dt, const bool pml=false ); - /* \brief Transform the component `i_comp` of MultiFab `mf` + /** + * \brief Transform the component `i_comp` of MultiFab `mf` * to spectral space, and store the corresponding result internally * (in the spectral field specified by `field_index`) */ void ForwardTransform( const amrex::MultiFab& mf, @@ -36,8 +38,10 @@ class SpectralSolver field_data.ForwardTransform( mf, field_index, i_comp ); }; - /* \brief Transform spectral field specified by `field_index` back to - * real space, and store it in the component `i_comp` of `mf` */ + /** + * \brief Transform spectral field specified by `field_index` back to + * real space, and store it in the component `i_comp` of `mf` + */ void BackwardTransform( amrex::MultiFab& mf, const int field_index, const int i_comp=0 ){ @@ -45,7 +49,9 @@ class SpectralSolver field_data.BackwardTransform( mf, field_index, i_comp ); }; - /* \brief Update the fields in spectral space, over one timestep */ + /** + * \brief Update the fields in spectral space, over one timestep + */ void pushSpectralFields(){ BL_PROFILE("SpectralSolver::pushSpectralFields"); // Virtual function: the actual function used here depends |