aboutsummaryrefslogtreecommitdiff
path: root/Source/Diagnostics/FlushFormats/FlushFormatPlotfile.H
diff options
context:
space:
mode:
authorGravatar David Grote <grote1@llnl.gov> 2022-12-19 05:43:16 -0800
committerGravatar GitHub <noreply@github.com> 2022-12-19 14:43:16 +0100
commitc3eb6ea1efeff3910e8520d94e260d94367d68f7 (patch)
treeaf59d4a61a92fc602ca224e0fdd45685960de433 /Source/Diagnostics/FlushFormats/FlushFormatPlotfile.H
parent4913d07348eeed38263745a47ffe3a9f9a680076 (diff)
downloadWarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.gz
WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.zst
WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.zip
Clean up documentation (#3542)
* Fix comments for documentation * More fixes to comments for documentation * Fixes in the doc files * Fix typo in parameters.rst
Diffstat (limited to 'Source/Diagnostics/FlushFormats/FlushFormatPlotfile.H')
-rw-r--r--Source/Diagnostics/FlushFormats/FlushFormatPlotfile.H1
1 files changed, 1 insertions, 0 deletions
diff --git a/Source/Diagnostics/FlushFormats/FlushFormatPlotfile.H b/Source/Diagnostics/FlushFormats/FlushFormatPlotfile.H
index e773f8e2f..744ef2e4b 100644
--- a/Source/Diagnostics/FlushFormats/FlushFormatPlotfile.H
+++ b/Source/Diagnostics/FlushFormats/FlushFormatPlotfile.H
@@ -48,6 +48,7 @@ public:
/** \brief Write particles data to file.
* \param[in] filename name of output directory
* \param[in] particle_diags Each element of this vector handles output of 1 species.
+ * \param[in] isBTD whether this is a back-transformed diagnostic
*/
void WriteParticles(const std::string& filename,
const amrex::Vector<ParticleDiag>& particle_diags,