doc/fr/ref_checking_keywords.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: CHECKING_STUDY
  25 .. _section_ref_checking_keywords:
  26
  27 Liste des commandes et mots-clés pour un cas de vérification
  28 ------------------------------------------------------------
  29
  30 .. index:: single: Algorithm
  31 .. index:: single: AlgorithmParameters
  32 .. index:: single: CheckingPoint
  33 .. index:: single: Debug
  34 .. index:: single: ObservationOperator
  35 .. index:: single: Observer
  36 .. index:: single: Observers
  37 .. index:: single: Observer Template
  38 .. index:: single: Study_name
  39 .. index:: single: Study_repertory
  40 .. index:: single: UserDataInit
  41
  42 Ce jeu de commandes est lié à la description d'un cas de vérification, qui est
  43 une procédure pour vérifier les propriétés d'une information requise, utilisée
  44 ailleurs par un cas de calcul. Les termes sont classés par ordre alphabétique,
  45 sauf le premier, qui décrit le choix entre le calcul ou la vérification.
  46
  47 Les différentes commandes sont les suivantes:
  48
  49   **CHECKING_STUDY**
  50     *Commande obligatoire*. C'est la commande générale qui décrit le cas de
  51     vérification. Elle contient hiérarchiquement toutes les autres commandes.
  52
  53   Algorithm
  54     *Commande obligatoire*. C'est une chaîne de caractère qui indique
  55     l'algorithme de test choisi. Les choix sont limités et disponibles à travers
  56     l'interface graphique. Il existe par exemple "FunctionTest",
  57     "AdjointTest"... Voir plus loin la liste des algorithmes et des paramètres
  58     associés, chacun décrit par une sous-section.
  59
  60   AlgorithmParameters
  61     *Commande optionnelle*. Elle permet d'ajouter des paramètres optionnels pour
  62     contrôler l'algorithme d'assimilation de données ou d'optimisation. Sa
  63     valeur est définie comme un objet de type "*Dict*". Voir la
  64     :ref:`section_ref_options_AlgorithmParameters` pour l'usage correct de cette
  65     commande.
  66
  67   CheckingPoint
  68     *Commande obligatoire*. Elle définit le vecteur utilisé comme l'état autour
  69     duquel réaliser le test requis, noté :math:`\mathbf{x}` et similaire à
  70     l'ébauche :math:`\mathbf{x}^b`. Sa valeur est définie comme un objet de type
  71     "*Vector*".
  72
  73   Debug
  74     *Commande optionnelle*. Elle définit le niveau de sorties et d'informations
  75     intermédiaires de débogage. Les choix sont limités entre 0 (pour False) et
  76     1 (pour True).
  77
  78   ObservationOperator
  79     *Commande obligatoire*. Elle indique l'opérateur d'observation, noté
  80     précédemment :math:`H`, qui transforme les paramètres d'entrée
  81     :math:`\mathbf{x}` en résultats :math:`\mathbf{y}` qui sont à comparer aux
  82     observations :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de
  83     type "*Function*" ou de type "*Matrix*". Dans le cas du type "*Function*",
  84     différentes formes fonctionnelles peuvent être utilisées, comme décrit dans
  85     la section :ref:`section_ref_operator_requirements`. Si un contrôle
  86     :math:`U` est inclus dans le modèle d'observation, l'opérateur doit être
  87     appliqué à une paire :math:`(X,U)`.
  88
  89   Observers
  90     *Commande optionnelle*. Elle permet de définir des observateurs internes,
  91     qui sont des fonctions liées à une variable particulière, qui sont exécutées
  92     chaque fois que cette variable est modifiée. C'est une manière pratique de
  93     suivre des variables d'intérêt durant le processus d'assimilation de données
  94     ou d'optimisation, en l'affichant ou en la traçant, etc. Des exemples
  95     courants (squelettes) sont fournis pour aider l'utilisateur ou pour
  96     faciliter l'élaboration d'un cas.
  97
  98   Study_name
  99     *Commande obligatoire*. C'est une chaîne de caractères quelconque pour
 100     décrire l'étude ADAO par un nom ou une déclaration.
 101
 102   Study_repertory
 103     *Commande optionnelle*. S'il existe, ce répertoire est utilisé comme base
 104     pour les calculs, et il est utilisé pour trouver les fichiers de script,
 105     donnés par nom sans répertoire, qui peuvent être utilisés pour définir
 106     certaines variables.
 107
 108   UserDataInit
 109     *Commande optionnelle*. Elle permet d'initialiser certains paramètres ou
 110     certaines données automatiquement avant le traitement de données d'entrée
 111     pour l'assimilation de données ou l'optimisation. Pour cela, elle indique un
 112     nom de fichier de script à exécuter avant d'entrer dans l'initialisation des
 113     variables choisies.