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