doc/fr/ref_algorithm_FunctionTest.rst

   1 ..
   2    Copyright (C) 2008-2023 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: FunctionTest
  25 .. _section_ref_algorithm_FunctionTest:
  26
  27 Algorithme de vérification "*FunctionTest*"
  28 -------------------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  32
  33 Cet algorithme permet de vérifier qu'un opérateur :math:`F` quelconque, dont en
  34 particulier celui d'observation, fonctionne correctement et que son appel se
  35 déroule de manière compatible avec son usage dans les algorithmes d'ADAO. De
  36 manière pratique, il permet d'appeler une ou plusieurs fois l'opérateur, en
  37 activant ou non le mode "debug" lors de l'exécution. L'opérateur :math:`F` est
  38 considéré comme dépendant d'une variable vectorielle :math:`\mathbf{x}`.
  39
  40 Une statistique sur les vecteurs en entrée et en sortie de chaque exécution de
  41 l'opérateur est indiquée, et une autre globale est fournie de manière
  42 récapitulative à la fin de l'algorithme de vérification. La précision
  43 d'affichage est contrôlable pour permettre l'automatisation des tests
  44 d'opérateur. Il peut être aussi utile de vérifier préalablement les entrées
  45 elles-mêmes avec le test prévu :ref:`section_ref_algorithm_InputValuesTest`.
  46
  47 .. ------------------------------------ ..
  48 .. include:: snippets/Header2Algo02.rst
  49
  50 .. include:: snippets/CheckingPoint.rst
  51
  52 .. include:: snippets/ObservationOperator.rst
  53
  54 .. ------------------------------------ ..
  55 .. include:: snippets/Header2Algo03Chck.rst
  56
  57 .. include:: snippets/NumberOfPrintedDigits.rst
  58
  59 .. include:: snippets/NumberOfRepetition.rst
  60
  61 .. include:: snippets/SetDebug.rst
  62
  63 .. include:: snippets/ShowElementarySummary.rst
  64
  65 StoreSupplementaryCalculations
  66   .. index:: single: StoreSupplementaryCalculations
  67
  68   *Liste de noms*. Cette liste indique les noms des variables supplémentaires,
  69   qui peuvent être disponibles au cours du déroulement ou à la fin de
  70   l'algorithme, si elles sont initialement demandées par l'utilisateur. Leur
  71   disponibilité implique, potentiellement, des calculs ou du stockage coûteux.
  72   La valeur par défaut est donc une liste vide, aucune de ces variables n'étant
  73   calculée et stockée par défaut (sauf les variables inconditionnelles). Les
  74   noms possibles pour les variables supplémentaires sont dans la liste suivante
  75   (la description détaillée de chaque variable nommée est donnée dans la suite
  76   de cette documentation par algorithme spécifique, dans la sous-partie
  77   "*Informations et variables disponibles à la fin de l'algorithme*") : [
  78   "CurrentState",
  79   "SimulatedObservationAtCurrentState",
  80   ].
  81
  82   Exemple :
  83   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
  84
  85 .. ------------------------------------ ..
  86 .. include:: snippets/Header2Algo04.rst
  87
  88 .. include:: snippets/NoUnconditionalOutput.rst
  89
  90 .. ------------------------------------ ..
  91 .. include:: snippets/Header2Algo05.rst
  92
  93 .. include:: snippets/CurrentState.rst
  94
  95 .. include:: snippets/SimulatedObservationAtCurrentState.rst
  96
  97 .. ------------------------------------ ..
  98 .. _section_ref_algorithm_FunctionTest_examples:
  99
 100 .. include:: snippets/Header2Algo09.rst
 101
 102 .. --------- ..
 103 .. include:: scripts/simple_FunctionTest1.rst
 104
 105 .. literalinclude:: scripts/simple_FunctionTest1.py
 106
 107 .. include:: snippets/Header2Algo10.rst
 108
 109 .. literalinclude:: scripts/simple_FunctionTest1.res
 110     :language: none
 111
 112 .. --------- ..
 113 .. include:: scripts/simple_FunctionTest2.rst
 114
 115 .. literalinclude:: scripts/simple_FunctionTest2.py
 116
 117 .. include:: snippets/Header2Algo10.rst
 118
 119 .. literalinclude:: scripts/simple_FunctionTest2.res
 120     :language: none
 121
 122 .. ------------------------------------ ..
 123 .. include:: snippets/Header2Algo06.rst
 124
 125 - :ref:`section_ref_algorithm_InputValuesTest`
 126 - :ref:`section_ref_algorithm_LinearityTest`
 127 - :ref:`section_ref_algorithm_ParallelFunctionTest`
 128 - :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`