doc/fr/ref_checking_keywords.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: 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: StudyName
  42 .. index:: single: StudyRepertory
  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   AlgorithmParameters
  57     *Commande obligatoire*. Elle définit l'algorithme de test choisi par le
  58     mot-clé "*Algorithm*", et ses éventuels paramètres optionnels. Les choix
  59     d'algorithmes sont disponibles à travers l'interface graphique. Il existe
  60     par exemple le "FunctionTest", le "GradientTest"... Chaque algorithme est
  61     défini, plus loin, par une sous-section spécifique. De manière facultative,
  62     la commande permet aussi d'ajouter des paramètres pour contrôler
  63     l'algorithme. Leurs valeurs sont définies explicitement ou dans un objet de
  64     type "*Dict*". On se reportera à la
  65     :ref:`section_ref_options_Algorithm_Parameters` pour l'usage détaillé de
  66     cette partie de la commande.
  67
  68   CheckingPoint
  69     *Commande obligatoire*. Elle définit le vecteur utilisé comme l'état autour
  70     duquel réaliser le test requis, noté :math:`\mathbf{x}` et similaire à
  71     l'ébauche :math:`\mathbf{x}^b`. Sa valeur est définie comme un objet de type
  72     "*Vector*".
  73
  74   BackgroundError
  75     *Commande obligatoire*. Elle définit la matrice de covariance des erreurs
  76     d'ébauche, notée précédemment :math:`\mathbf{B}`. Sa valeur est définie
  77     comme un objet de type "*Matrix*", de type "*ScalarSparseMatrix*", ou de
  78     type "*DiagonalSparseMatrix*".
  79
  80   Debug
  81     *Commande optionnelle*. Elle définit le niveau de sorties et d'informations
  82     intermédiaires de débogage. Les choix sont limités entre 0 (pour False) et
  83     1 (pour True).
  84
  85   Observation
  86     *Commande obligatoire*. Elle définit le vecteur d'observation utilisé en
  87     assimilation de données ou en optimisation, et noté précédemment
  88     :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de type "*Vector*"
  89     ou de type "*VectorSerie*".
  90
  91   ObservationError
  92     *Commande obligatoire*. Elle définit la matrice de covariance des erreurs
  93     d'ébauche, notée précédemment :math:`\mathbf{R}`. Sa valeur est définie
  94     comme un objet de type "*Matrix*", de type "*ScalarSparseMatrix*", ou de
  95     type "*DiagonalSparseMatrix*".
  96
  97   ObservationOperator
  98     *Commande obligatoire*. Elle indique l'opérateur d'observation, noté
  99     précédemment :math:`H`, qui transforme les paramètres d'entrée
 100     :math:`\mathbf{x}` en résultats :math:`\mathbf{y}` qui sont à comparer aux
 101     observations :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de
 102     type "*Function*" ou de type "*Matrix*". Dans le cas du type "*Function*",
 103     différentes formes fonctionnelles peuvent être utilisées, comme décrit dans
 104     la section :ref:`section_ref_operator_requirements`. Si un contrôle
 105     :math:`U` est inclus dans le modèle d'observation, l'opérateur doit être
 106     appliqué à une paire :math:`(X,U)`.
 107
 108   Observers
 109     *Commande optionnelle*. Elle permet de définir des observateurs internes,
 110     qui sont des fonctions liées à une variable particulière, qui sont exécutées
 111     chaque fois que cette variable est modifiée. C'est une manière pratique de
 112     suivre des variables d'intérêt durant le processus d'assimilation de données
 113     ou d'optimisation, en l'affichant ou en la traçant, etc. Des exemples
 114     courants (squelettes) sont fournis pour aider l'utilisateur ou pour
 115     faciliter l'élaboration d'un cas.
 116
 117   StudyName
 118     *Commande obligatoire*. C'est une chaîne de caractères quelconque pour
 119     décrire l'étude ADAO par un nom ou une déclaration.
 120
 121   StudyRepertory
 122     *Commande optionnelle*. S'il existe, ce répertoire est utilisé comme base
 123     pour les calculs, et il est utilisé pour trouver les fichiers de script,
 124     donnés par nom sans répertoire, qui peuvent être utilisés pour définir
 125     certaines variables.
 126
 127   UserDataInit
 128     *Commande optionnelle*. Elle permet d'initialiser certains paramètres ou
 129     certaines données automatiquement avant le traitement de données d'entrée
 130     pour l'assimilation de données ou l'optimisation. Pour cela, elle indique un
 131     nom de fichier de script à exécuter avant d'entrer dans l'initialisation des
 132     variables choisies.