doc/en/ref_algorithm_ParallelFunctionTest.rst

   1 ..
   2    Copyright (C) 2008-2022 EDF R&D
   3
   4    This file is part of SALOME ADAO module.
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. index:: single: ParallelFunctionTest
  25 .. _section_ref_algorithm_ParallelFunctionTest:
  26
  27 Checking algorithm "*ParallelFunctionTest*"
  28 -------------------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  32
  33 This algorithm allows to verify that an operator, in particular the
  34 observation one, is working correctly in parallel and that its call is
  35 compatible with its usage in ADAO algorithms. In practice, it allows to
  36 call one or several times the operator in parallel, activating or not
  37 the "debug" mode during execution.
  38
  39 Statistics on input and output vectors for each execution of operator are
  40 given, and an another global statistic is given at the end of the checking
  41 algorithm. The precision of printed outputs can be controlled to facilitate
  42 automatic tests of operator. It may also be useful to check the entries
  43 themselves beforehand with the intended test
  44 :ref:`section_ref_algorithm_InputValuesTest`.
  45
  46 .. ------------------------------------ ..
  47 .. include:: snippets/Header2Algo02.rst
  48
  49 .. include:: snippets/CheckingPoint.rst
  50
  51 .. include:: snippets/ObservationOperator.rst
  52
  53 .. ------------------------------------ ..
  54 .. include:: snippets/Header2Algo03Chck.rst
  55
  56 .. include:: snippets/NumberOfPrintedDigits.rst
  57
  58 .. include:: snippets/NumberOfRepetition.rst
  59
  60 .. include:: snippets/SetDebug.rst
  61
  62 .. include:: snippets/ShowElementarySummary.rst
  63
  64 StoreSupplementaryCalculations
  65   .. index:: single: StoreSupplementaryCalculations
  66
  67   *List of names*. This list indicates the names of the supplementary
  68   variables, that can be available during or at the end of the algorithm, if
  69   they are initially required by the user. Their avalability involves,
  70   potentially, costly calculations or memory consumptions. The default is then
  71   a void list, none of these variables being calculated and stored by default
  72   (excepted the unconditionnal variables). The possible names are in the
  73   following list (the detailed description of each named variable is given in
  74   the following part of this specific algorithmic documentation, in the
  75   sub-section "*Information and variables available at the end of the
  76   algorithm*"): [
  77   "CurrentState",
  78   "SimulatedObservationAtCurrentState",
  79   ].
  80
  81   Example :
  82   ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
  83
  84 .. ------------------------------------ ..
  85 .. include:: snippets/Header2Algo04.rst
  86
  87 .. include:: snippets/NoUnconditionalOutput.rst
  88
  89 .. ------------------------------------ ..
  90 .. include:: snippets/Header2Algo05.rst
  91
  92 .. include:: snippets/CurrentState.rst
  93
  94 .. include:: snippets/SimulatedObservationAtCurrentState.rst
  95
  96 .. ------------------------------------ ..
  97 .. include:: snippets/Header2Algo09.rst
  98
  99 .. include:: scripts/simple_ParallelFunctionTest.rst
 100
 101 .. literalinclude:: scripts/simple_ParallelFunctionTest.py
 102
 103 .. include:: snippets/Header2Algo10.rst
 104
 105 .. literalinclude:: scripts/simple_ParallelFunctionTest.res
 106
 107 .. ------------------------------------ ..
 108 .. include:: snippets/Header2Algo06.rst
 109
 110 - :ref:`section_ref_algorithm_FunctionTest`
 111 - :ref:`section_ref_algorithm_InputValuesTest`
 112 - :ref:`section_ref_algorithm_LinearityTest`