doc/fr/ref_assimilation_keywords.rst

   1 ..
   2    Copyright (C) 2008-2018 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: ASSIMILATION_STUDY
  25 .. _section_ref_assimilation_keywords:
  26
  27 Liste des commandes et mots-clés pour un cas d'assimilation de données ou d'optimisation
  28 ----------------------------------------------------------------------------------------
  29
  30 .. index:: single: Algorithm
  31 .. index:: single: AlgorithmParameters
  32 .. index:: single: ControlInput
  33 .. index:: single: Debug
  34 .. index:: single: InputVariables
  35 .. index:: single: Observer
  36 .. index:: single: Observers
  37 .. index:: single: Observer Template
  38 .. index:: single: OutputVariables
  39 .. index:: single: StudyName
  40 .. index:: single: StudyRepertory
  41 .. index:: single: UserDataInit
  42 .. index:: single: UserPostAnalysis
  43 .. index:: single: UserPostAnalysis Template
  44
  45 Ce jeu de commandes est lié à la description d'un cas de calcul, qui est une
  46 procédure d'*Assimilation de Données* ou d'*Optimisation*. Les termes sont
  47 classés par ordre alphabétique, sauf le premier, qui décrit le choix entre le
  48 calcul ou la vérification.
  49
  50 Les différentes commandes sont les suivantes:
  51
  52   **ASSIMILATION_STUDY**
  53     *Commande obligatoire*. C'est la commande générale qui décrit le cas
  54     d'assimilation de données ou d'optimisation. Elle contient hiérarchiquement
  55     toutes les autres commandes.
  56
  57   AlgorithmParameters
  58     *Commande obligatoire*. Elle définit l'algorithme d'assimilation de données
  59     ou d'optimisation choisi par le mot-clé "*Algorithm*", et ses éventuels
  60     paramètres optionnels. Les choix d'algorithmes sont disponibles à travers
  61     l'interface graphique. Il existe par exemple le "3DVAR", le "Blue"... Chaque
  62     algorithme est défini, plus loin, par une sous-section spécifique. De
  63     manière facultative, la commande permet aussi d'ajouter des paramètres pour
  64     contrôler l'algorithme. Leurs valeurs sont définies explicitement ou dans un
  65     objet de type "*Dict*". On se reportera à la
  66     :ref:`section_ref_options_Algorithm_Parameters` pour l'usage détaillé de
  67     cette partie de la commande.
  68
  69   .. include:: snippets/Background.rst
  70
  71   .. include:: snippets/BackgroundError.rst
  72
  73   ControlInput
  74     *Commande optionnelle*. Elle indique le vecteur de contrôle utilisé pour
  75     forcer le modèle d'évolution à chaque pas, usuellement noté
  76     :math:`\mathbf{U}`. Sa valeur est définie comme un objet de type "*Vector*"
  77     ou de type "*VectorSerie*". Lorsqu'il n'y a pas de contrôle, sa valeur doit
  78     être une chaîne vide ''.
  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   .. include:: snippets/EvolutionError.rst
  86
  87   .. include:: snippets/EvolutionModel.rst
  88
  89   InputVariables
  90     *Commande optionnelle*. Elle permet d'indiquer le nom et la taille des
  91     variables physiques qui sont rassemblées dans le vecteur d'état. Cette
  92     information est destinée à être utilisée dans le traitement algorithmique
  93     interne des données.
  94
  95   .. include:: snippets/Observation.rst
  96
  97   .. include:: snippets/ObservationError.rst
  98
  99   .. include:: snippets/ObservationOperator.rst
 100
 101   Observers
 102     *Commande optionnelle*. Elle permet de définir des observateurs internes,
 103     qui sont des fonctions liées à une variable particulière, qui sont exécutées
 104     chaque fois que cette variable est modifiée. C'est une manière pratique de
 105     suivre des variables d'intérêt durant le processus d'assimilation de données
 106     ou d'optimisation, en l'affichant ou en la traçant, etc. Des exemples
 107     courants (squelettes) sont fournis pour aider l'utilisateur ou pour
 108     faciliter l'élaboration d'un cas.
 109
 110   OutputVariables
 111     *Commande optionnelle*. Elle permet d'indiquer le nom et la taille des
 112     variables physiques qui sont rassemblées dans le vecteur d'observation.
 113     Cette information est destinée à être utilisée dans le traitement
 114     algorithmique interne des données.
 115
 116   StudyName
 117     *Commande obligatoire*. C'est une chaîne de caractères quelconque pour
 118     décrire l'étude ADAO par un nom ou une déclaration.
 119
 120   StudyRepertory
 121     *Commande optionnelle*. S'il existe, ce répertoire est utilisé comme base
 122     pour les calculs, et il est utilisé pour trouver les fichiers de script,
 123     donnés par nom sans répertoire, qui peuvent être utilisés pour définir
 124     certaines variables.
 125
 126   UserDataInit
 127     *Commande optionnelle*. Elle permet d'initialiser certains paramètres ou
 128     certaines données automatiquement avant le traitement de données d'entrée
 129     pour l'assimilation de données ou l'optimisation. Pour cela, elle indique un
 130     nom de fichier de script à exécuter avant d'entrer dans l'initialisation des
 131     variables choisies.
 132
 133   UserPostAnalysis
 134     *Commande optionnelle*. Elle permet de traiter des paramètres ou des
 135     résultats après le déroulement de l'algorithme d'assimilation de données ou
 136     d'optimisation. Sa valeur est définie comme un fichier script ou une chaîne
 137     de caractères, permettant de produire directement du code de post-processing
 138     dans un cas ADAO. Des exemples courants (squelettes) sont fournis pour aider
 139     l'utilisateur ou pour faciliter l'élaboration d'un cas.