doc/fr/ref_algorithm_FunctionTest.rst

   1 ..
   2    Copyright (C) 2008-2018 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 Description
  31 +++++++++++
  32
  33 Cet algorithme permet de vérifier que l'opérateur d'observation fonctionne
  34 correctement et que son appel se déroule de manière compatible avec son usage
  35 dans les algorithmes d'ADAO. De manière pratique, il permet d'appeler une ou
  36 plusieurs fois l'opérateur, en activant ou non le mode "debug" lors de
  37 l'exécution.
  38
  39 Une statistique sur les vecteurs en entrée et en sortie de chaque exécution de
  40 l'opérateur est indiquée, et une autre globale est fournie de manière
  41 récapitulative à la fin de l'algorithme de vérification. La précision
  42 d'affichage est contrôlable pour permettre l'automatisation des tests
  43 d'opérateur.
  44
  45 Commandes requises et optionnelles
  46 ++++++++++++++++++++++++++++++++++
  47
  48 Les commandes requises générales, disponibles dans l'interface en édition, sont
  49 les suivantes:
  50
  51   .. include:: snippets/CheckingPoint.rst
  52
  53   .. include:: snippets/ObservationOperator.rst
  54
  55 Les commandes optionnelles générales, disponibles dans l'interface en édition,
  56 sont indiquées dans la :ref:`section_ref_checking_keywords`. De plus, les
  57 paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
  58 options particulières, décrites ci-après, de l'algorithme. On se reportera à la
  59 :ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
  60 commande.
  61
  62 Les options de l'algorithme sont les suivantes:
  63
  64   .. include:: snippets/NumberOfPrintedDigits.rst
  65
  66   .. include:: snippets/NumberOfRepetition.rst
  67
  68   .. include:: snippets/SetDebug.rst
  69
  70   StoreSupplementaryCalculations
  71     .. index:: single: StoreSupplementaryCalculations
  72
  73     Cette liste indique les noms des variables supplémentaires qui peuvent être
  74     disponibles à la fin de l'algorithme. Cela implique potentiellement des
  75     calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
  76     aucune de ces variables n'étant calculée et stockée par défaut. Les noms
  77     possibles sont dans la liste suivante : ["CurrentState",
  78     "SimulatedObservationAtCurrentState"].
  79
  80     Exemple :
  81     ``{"StoreSupplementaryCalculations":["CurrentState"]}``
  82
  83 Informations et variables disponibles à la fin de l'algorithme
  84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  85
  86 En sortie, après exécution de l'algorithme, on dispose d'informations et de
  87 variables issues du calcul. La description des
  88 :ref:`section_ref_output_variables` indique la manière de les obtenir par la
  89 méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
  90 d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
  91 l'écriture des procédures de post-processing, sont décrites dans
  92 l':ref:`subsection_r_o_v_Inventaire`.
  93
  94 Les sorties conditionnelles de l'algorithme sont les suivantes:
  95
  96   .. include:: snippets/CurrentState.rst
  97
  98   .. include:: snippets/SimulatedObservationAtCurrentState.rst
  99
 100 Voir aussi
 101 ++++++++++
 102
 103 Références vers d'autres sections :
 104   - :ref:`section_ref_algorithm_LinearityTest`