aboutsummaryrefslogtreecommitdiff
path: root/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmRZ.H
diff options
context:
space:
mode:
authorGravatar Edoardo Zoni <59625522+EZoni@users.noreply.github.com> 2020-08-06 06:30:14 -0700
committerGravatar GitHub <noreply@github.com> 2020-08-06 06:30:14 -0700
commit0564feb5041728173716ef251f1d66d37c314770 (patch)
tree5f621f3818791232a42464b60beb0c43e24df1f6 /Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmRZ.H
parent8721f1e05af20496c209d71af74fee896aaa5b7f (diff)
downloadWarpX-0564feb5041728173716ef251f1d66d37c314770.tar.gz
WarpX-0564feb5041728173716ef251f1d66d37c314770.tar.zst
WarpX-0564feb5041728173716ef251f1d66d37c314770.zip
Galilean PSATD: current correction and rho-free formulation (#1151)
* Introduce option to update E with/without rho * Clean up * Implement current correction for Galilean PSATD (needs bug fix) * Include equations in docs * Fix EOL whitespaces error * Small clean-up * Implement Galilean PSATD update without rho * Clean up * Fix bug in current correction * Fix EOL whitespaces * Clean up * Fix unused import * Remove unused variable * [skip CI] Improve docs * Clean up style * Fix EOL whitespaces * Fix EOL whitespaces * Clean up style * Revert analysis script to old status * [skip CI] Clean up style * Make equations more human-readable and improve comments * 2D test with current correction works * Temporary build fix as in #1197 * 3D test with current correction works * Rename th and th_star as theta and theta_star * Fix a couple of wrong comments * Add vertical spaces to improve readability * Improve documentation * Function CurrentCorrection is now pure * 2D benchmark fields data are now correct * Add limits of coefficients for nu=-1 * Change default of update_with_rho for Galilean PSATD
Diffstat (limited to 'Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmRZ.H')
-rw-r--r--Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmRZ.H20
1 files changed, 10 insertions, 10 deletions
diff --git a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmRZ.H b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmRZ.H
index fc03f95f2..b4c2597a8 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmRZ.H
+++ b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmRZ.H
@@ -30,19 +30,19 @@ class PsatdAlgorithmRZ : public SpectralBaseAlgorithmRZ
/**
* \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 SpectralBaseAlgorithmRZ (qualifier \c override) and cannot be
- * overridden by further derived classes (qualifier \c final).
+ * base class \c SpectralBaseAlgorithmRZ and cannot be overridden by further
+ * derived classes.
*
- * \param[in,out] field_data all fields in Fourier space
- * \param[in,out] current two-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 ( SpectralFieldDataRZ& field_data,
- std::array<std::unique_ptr<amrex::MultiFab>,3>& current,
- const std::unique_ptr<amrex::MultiFab>& rho ) override final;
+ virtual void CurrentCorrection (SpectralFieldDataRZ& 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