doc/en/ref_algorithm_ParallelFunctionTest.rst

   1 ..
   2    Copyright (C) 2008-2024 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 verification algorithm allows to analyze in a simple way the stability of
  34 an operator :math:`F` during its execution in parallel. The operator is any
  35 operator, so it can be the observation operator :math:`\mathcal{H}` as well as
  36 the evolution operator :math:`\mathcal{D}`, as long as it is provided in each
  37 case according to the :ref:`section_ref_operator_requirements`. The operator
  38 :math:`F` is considered as depending on a vector variable :math:`\mathbf{x}`
  39 and returning another vector variable :math:`\mathbf{y}`.
  40
  41 The algorithm verifies that the operator is working correctly and that its call
  42 is compatible with its usage in ADAO algorithms. In practice, it allows to call
  43 one or several times the operator, activating or not the "debug" mode during
  44 execution.
  45
  46 Statistics on :math:`\mathbf{x}` input and :math:`\mathbf{y}` output vectors
  47 are given for each execution of operator, and an another global statistic is
  48 given at the end. The precision of printed outputs can be controlled to
  49 facilitate automatic tests of operator. It may also be useful to check the
  50 entries themselves beforehand with the intended test
  51 :ref:`section_ref_algorithm_InputValuesTest`.
  52
  53 .. ------------------------------------ ..
  54 .. include:: snippets/Header2Algo12.rst
  55
  56 .. include:: snippets/FeaturePropDerivativeFree.rst
  57
  58 .. include:: snippets/FeaturePropParallelAlgorithm.rst
  59
  60 .. ------------------------------------ ..
  61 .. include:: snippets/Header2Algo02.rst
  62
  63 .. include:: snippets/CheckingPoint.rst
  64
  65 .. include:: snippets/ObservationOperator.rst
  66
  67 .. ------------------------------------ ..
  68 .. include:: snippets/Header2Algo03Chck.rst
  69
  70 .. include:: snippets/NumberOfPrintedDigits.rst
  71
  72 .. include:: snippets/NumberOfRepetition.rst
  73
  74 .. include:: snippets/SetDebug.rst
  75
  76 .. include:: snippets/ShowElementarySummary.rst
  77
  78 StoreSupplementaryCalculations
  79   .. index:: single: StoreSupplementaryCalculations
  80
  81   *List of names*. This list indicates the names of the supplementary
  82   variables, that can be available during or at the end of the algorithm, if
  83   they are initially required by the user. Their availability involves,
  84   potentially, costly calculations or memory consumptions. The default is then
  85   a void list, none of these variables being calculated and stored by default
  86   (excepted the unconditional variables). The possible names are in the
  87   following list (the detailed description of each named variable is given in
  88   the following part of this specific algorithmic documentation, in the
  89   sub-section "*Information and variables available at the end of the
  90   algorithm*"): [
  91   "CurrentState",
  92   "SimulatedObservationAtCurrentState",
  93   ].
  94
  95   Example :
  96   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
  97
  98 .. ------------------------------------ ..
  99 .. include:: snippets/Header2Algo04.rst
 100
 101 .. include:: snippets/NoUnconditionalOutput.rst
 102
 103 .. ------------------------------------ ..
 104 .. include:: snippets/Header2Algo05.rst
 105
 106 .. include:: snippets/CurrentState.rst
 107
 108 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 109
 110 .. ------------------------------------ ..
 111 .. _section_ref_algorithm_ParallelFunctionTest_examples:
 112
 113 .. include:: snippets/Header2Algo09.rst
 114
 115 .. include:: scripts/simple_ParallelFunctionTest.rst
 116
 117 .. literalinclude:: scripts/simple_ParallelFunctionTest.py
 118
 119 .. include:: snippets/Header2Algo10.rst
 120
 121 .. literalinclude:: scripts/simple_ParallelFunctionTest.res
 122     :language: none
 123
 124 .. ------------------------------------ ..
 125 .. include:: snippets/Header2Algo06.rst
 126
 127 - :ref:`section_ref_algorithm_InputValuesTest`
 128 - :ref:`section_ref_algorithm_LinearityTest`
 129 - :ref:`section_ref_algorithm_FunctionTest`
 130 - :ref:`section_ref_algorithm_ControledFunctionTest`
 131 - :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`