Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[Documentation] Added a note for smpi/cpu_threshold
authorChristian Heinrich <franz-christian.heinrich@inria.fr>
Tue, 26 May 2015 14:01:11 +0000 (16:01 +0200)
committerGabriel Corona <gabriel.corona@loria.fr>
Tue, 9 Jun 2015 07:59:09 +0000 (09:59 +0200)
doc/doxygen/options.doc

index e757e95..deb7509 100644 (file)
@@ -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