Salome HOME
Code and documentation update
[modules/adao.git] / doc / en / scripts / simple_ParallelFunctionTest.rst
index b068a9913984cb0a89180e728cc342d979dd9e62..eb902e9e2e377388bc13d431ab583485013db793 100644 (file)
@@ -1,14 +1,29 @@
 .. index:: single: FunctionTest (example)
 
-This example describes the test of the correct operation of an operator and
-that its call is compatible with its use in the ADAO algorithms. The necessary
-information are minimal, namely here an operator of type observation :math:`H`
-and a state :math:`\mathbf{x}^b` on which to test it (named "*CheckingPoint*"
-for the test).
-
-The test is repeated a customizable number of times, and a final statistic
-allows to quickly check the good behavior of the operator. The simplest
-diagnostic consists in checking, at the end, the order of magnitude of the
-values indicated as the average of the differences between the repeated outputs
-Y and their mean Ym*. For a typical operator, these values should be close to
-the numerical zero.
+This example describes the test of the correct operation of a given operator,
+and that its call proceeds in a way compatible with its common use in parallel
+in the ADAO algorithms. The required information are minimal, namely here an
+operator :math:`F` (described for the test by the observation command
+"*ObservationOperator*"), and a state :math:`\mathbf{x}^b` to test it on
+(described for the test by the command "*CheckingPoint*").
+
+The test is repeated a configurable number of times, and a final statistic
+makes it possible to quickly verify the operator's good behavior. The simplest
+diagnostic consists in checking, at the very end of the display, the order of
+magnitude of the values indicated as the mean of the differences between the
+repeated outputs and their mean, under the part entitled "*Characteristics of
+the mean of the differences between the outputs Y and their mean Ym*". For a
+satisfactory operator, these values should be close to the numerical zero.
+
+.. note::
+
+    .. index:: single: EnableMultiProcessingInEvaluation
+
+    It can be useful to make sure that the evaluation of the operator is really
+    done in parallel, and for example that there is no forced use of a
+    parallelism acceleration, which would avoid a real parallel test. For this
+    purpose, it is recommended to systematically use the boolean special
+    parameter "*EnableMultiProcessingInEvaluation*", exclusively reserved for
+    this purpose, of the operator declaration command. The use of this
+    parameter is illustrated in this example. It should not be used in any
+    other case.