doc/fr/ref_algorithm_FunctionTest.rst

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