doc/fr/ref_algorithm_FunctionTest.rst

   1 ..
   2    Copyright (C) 2008-2015 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 .. index:: single: AlgorithmParameters
  49 .. index:: single: CheckingPoint
  50 .. index:: single: ObservationOperator
  51 .. index:: single: NumberOfPrintedDigits
  52 .. index:: single: NumberOfRepetition
  53 .. index:: single: SetDebug
  54
  55 Les commandes requises générales, disponibles dans l'interface en édition, sont
  56 les suivantes:
  57
  58   CheckingPoint
  59     *Commande obligatoire*. Elle définit le vecteur utilisé comme l'état autour
  60     duquel réaliser le test requis, noté :math:`\mathbf{x}` et similaire à
  61     l'ébauche :math:`\mathbf{x}^b`. Sa valeur est définie comme un objet de type
  62     "*Vector*".
  63
  64   ObservationOperator
  65     *Commande obligatoire*. Elle indique l'opérateur d'observation, notée
  66     précédemment :math:`H`, qui transforme les paramètres d'entrée
  67     :math:`\mathbf{x}` en résultats :math:`\mathbf{y}` qui sont à comparer aux
  68     observations :math:`\mathbf{y}^o`.  Sa valeur est définie comme un objet de
  69     type "*Function*". Différentes formes fonctionnelles peuvent être
  70     utilisées, comme décrit dans la section
  71     :ref:`section_ref_operator_requirements`. Si un contrôle :math:`U` est
  72     inclus dans le modèle d'observation, l'opérateur doit être appliqué à une
  73     paire :math:`(X,U)`.
  74
  75 Les commandes optionnelles générales, disponibles dans l'interface en édition,
  76 sont indiquées dans la :ref:`section_ref_checking_keywords`. De plus, les
  77 paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
  78 options particulières, décrites ci-après, de l'algorithme. On se reportera à la
  79 :ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
  80 commande.
  81
  82 Les options de l'algorithme sont les suivantes:
  83
  84   NumberOfPrintedDigits
  85     Cette clé indique le nombre de décimales de précision pour les affichages de
  86     valeurs réelles. La valeur par défaut est 5, avec un minimum de 0.
  87
  88     Exemple : ``{"NumberOfPrintedDigits":5}``
  89
  90   NumberOfRepetition
  91     Cette clé indique le nombre de fois où répéter l'évaluation de la fonction.
  92     La valeur par défaut est 1.
  93
  94     Exemple : ``{"NumberOfRepetition":3}``
  95
  96   SetDebug
  97     Cette clé requiert l'activation, ou pas, du mode de débogage durant
  98     l'évaluation de la fonction. La valeur par défaut est "False", les choix
  99     sont "True" ou "False".
 100
 101     Exemple : ``{"SetDebug":False}``
 102
 103 Voir aussi
 104 ++++++++++
 105
 106 Références vers d'autres sections :
 107   - :ref:`section_ref_algorithm_LinearityTest`