From 3d97024d163b556fffbc3afd693c953be1a0ee45 Mon Sep 17 00:00:00 2001 From: Christian Heinrich Date: Tue, 26 May 2015 16:01:11 +0200 Subject: [PATCH 1/1] [Documentation] Added a note for smpi/cpu_threshold --- doc/doxygen/options.doc | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/doxygen/options.doc b/doc/doxygen/options.doc index e757e95dca..deb750902d 100644 --- a/doc/doxygen/options.doc +++ b/doc/doxygen/options.doc @@ -701,10 +701,17 @@ to update it to get accurate simulation results. When the code is constituted of numerous consecutive MPI calls, the previous mechanism feeds the simulation kernel with numerous tiny computations. The \b smpi/cpu_threshold item becomes handy when this -impacts badly the simulation performance. It specify a threshold (in -second) under which the execution chunks are not reported to the -simulation kernel (default value: 1e-6). Please note that in some -circonstances, this optimization can hinder the simulation accuracy. +impacts badly the simulation performance. It specifies a threshold (in +seconds) below which the execution chunks are not reported to the +simulation kernel (default value: 1e-6). + + +\note + The option smpi/cpu_threshold ignores any computation time spent + below this threshold. SMPI does not consider the \a amount of these + computations; there is no offset for this. Hence, by using a + value that is too low, you may end up with unreliable simulation + results. In some cases, however, one may wish to disable simulation of application computation. This is the case when SMPI is used not to -- 2.20.1