doc/en/scripts/simple_ParallelFunctionTest.rst

   1 .. index:: single: FunctionTest (example)
   2
   3 This example describes the test of the correct operation of a given operator,
   4 and that its call proceeds in a way compatible with its common use in parallel
   5 in the ADAO algorithms. The required information are minimal, namely here an
   6 operator :math:`F` (described for the test by the observation command
   7 "*ObservationOperator*"), and a state :math:`\mathbf{x}^b` to test it on
   8 (described for the test by the command "*CheckingPoint*").
   9
  10 The test is repeated a configurable number of times, and a final statistic
  11 makes it possible to quickly verify the operator's good behavior. The simplest
  12 diagnostic consists in checking, at the very end of the display, the order of
  13 magnitude of the values indicated as the mean of the differences between the
  14 repeated outputs and their mean, under the part entitled "*Characteristics of
  15 the mean of the differences between the outputs Y and their mean Ym*". For a
  16 satisfactory operator, these values should be close to the numerical zero.
  17
  18 .. note::
  19
  20     .. index:: single: EnableMultiProcessingInEvaluation
  21
  22     It can be useful to make sure that the evaluation of the operator is really
  23     done in parallel, and for example that there is no forced use of a
  24     parallelism acceleration, which would avoid a real parallel test. For this
  25     purpose, it is recommended to systematically use the boolean special
  26     parameter "*EnableMultiProcessingInEvaluation*", exclusively reserved for
  27     this purpose, of the operator declaration command. The use of this
  28     parameter is illustrated in this example. It should not be used in any
  29     other case.