diff options
Diffstat (limited to 'Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H')
| -rw-r--r-- | Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H index bfa9283e6..4bfcd9fc9 100644 --- a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H +++ b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H @@ -39,19 +39,19 @@ class PsatdAlgorithm : public SpectralBaseAlgorithm /** * \brief Virtual function for current correction in Fourier space - * (equation (19) of https://doi.org/10.1016/j.jcp.2013.03.010). + * (<a href="https://doi.org/10.1016/j.jcp.2013.03.010"> Vay et al, 2013</a>). * This function overrides the virtual function \c CurrentCorrection in the - * base class \c SpectralBaseAlgorithm (qualifier \c override) and cannot be - * overridden by further derived classes (qualifier \c final). + * base class \c SpectralBaseAlgorithm and cannot be overridden by further + * derived classes. * - * \param[in,out] field_data all fields in Fourier space - * \param[in,out] current three-dimensional array of unique pointers to MultiFab - * storing the three components of the current density - * \param[in] rho unique pointer to MultiFab storing the charge density + * \param[in,out] field_data All fields in Fourier space + * \param[in,out] current Array of unique pointers to \c MultiFab storing + * the three components of the current density + * \param[in] rho Unique pointer to \c MultiFab storing the charge density */ - virtual void CurrentCorrection ( SpectralFieldData& field_data, - std::array<std::unique_ptr<amrex::MultiFab>,3>& current, - const std::unique_ptr<amrex::MultiFab>& rho ) override final; + virtual void CurrentCorrection (SpectralFieldData& field_data, + std::array<std::unique_ptr<amrex::MultiFab>,3>& current, + const std::unique_ptr<amrex::MultiFab>& rho) override final; /** * \brief Virtual function for Vay current deposition in Fourier space |