From 2639e8ececefd977d75e0430da3b9665e0fc510b Mon Sep 17 00:00:00 2001 From: Matthieu Schaller <schaller@strw.leidenuniv.nl> Date: Thu, 26 Sep 2019 20:02:19 +0200 Subject: [PATCH] Add a message of caution about the alternative neighbour number definition. --- doc/RTD/source/ParameterFiles/parameter_description.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/RTD/source/ParameterFiles/parameter_description.rst b/doc/RTD/source/ParameterFiles/parameter_description.rst index ae6191c928..dcc829fe2a 100644 --- a/doc/RTD/source/ParameterFiles/parameter_description.rst +++ b/doc/RTD/source/ParameterFiles/parameter_description.rst @@ -332,6 +332,10 @@ h_i)`). Note that in the case where all the particles in the simulation have the same mass, the two definitions lead to the same number density value. +**We dot not recommend using this alternative neighbour number definition +in production runs.** It is mainly provided for backward compatibility with +earlier simulations. + The second one, the relative tolerance for the smoothing length, specifies the convergence criteria for the smoothing length when using the Newton-Raphson scheme. This works with the maximal number of iterations, -- GitLab