Update of the documentation to reflect changes to prune emissions.

polycfd · Apr 13, 2024 · 421ea66 · 421ea66
1 parent eb4ce8f
commit 421ea66
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 1 deletion.
diff --git a/documentation/APECSS-Documentation.pdf b/documentation/APECSS-Documentation.pdf
diff --git a/documentation/chapters/emissions.tex b/documentation/chapters/emissions.tex
@@ -16,7 +16,7 @@ \chapter{Acoustic emissions}
 & {\tt EmissionIntegration Euler} & Integrates the radial position and, if applicable, the velocity using an Euler scheme.\\
 & {\tt EmissionIntegration RK4} & Integrates the radial position and, if applicable, the velocity using a conventional fourth-order Runge-Kutta scheme. This is the default.\\
 & {\tt KBIterTolerance <float>} & Tolerance $\eta$ for the evaluation of the pressure using a model based on the Kirkwood-Bethe hypothesis in conjunction with the NASG EoS.\\
-& {\tt PruneEmissions <float>} & Prune the emission node if the pressure difference with their neighbors is smaller than the defined tolerance.\\
+& {\tt PruneEmissions} & Prune the list of emission nodes according to a test function provided by the user. This test function must  be hooked up to the function pointer {\tt Bubble->Emissions->prune\_test()}.\\
  \hline
 \end{tabular} \vspace{0.2em}