..
- Copyright (C) 2008-2014 EDF R&D
+ Copyright (C) 2008-2018 EDF R&D
This file is part of SALOME ADAO module.
.. index:: single: CHECKING_STUDY
.. _section_ref_checking_keywords:
-Liste des commandes et mots-clés pour un cas de vérification
+Liste des commandes et mots-clés pour un cas de vérification
------------------------------------------------------------
.. index:: single: Algorithm
.. index:: single: AlgorithmParameters
-.. index:: single: CheckingPoint
-.. index:: single: BackgroundError
.. index:: single: Debug
-.. index:: single: Observation
-.. index:: single: ObservationError
-.. index:: single: ObservationOperator
.. index:: single: Observer
.. index:: single: Observers
.. index:: single: Observer Template
-.. index:: single: Study_name
-.. index:: single: Study_repertory
+.. index:: single: StudyName
+.. index:: single: StudyRepertory
.. index:: single: UserDataInit
-Ce jeu de commandes est lié à la description d'un cas de vérification, qui est
-une procédure pour vérifier les propriétés d'une information requise, utilisée
-ailleurs par un cas de calcul. Les termes sont classés par ordre alphabétique,
-sauf le premier, qui décrit le choix entre le calcul ou la vérification.
+Ce jeu de commandes est lié à la description d'un cas de vérification, qui est
+une procédure pour vérifier les propriétés d'une information requise, utilisée
+ailleurs par un cas de calcul. Les termes sont classés par ordre alphabétique,
+sauf le premier, qui décrit le choix entre le calcul ou la vérification.
-Les différentes commandes sont les suivantes:
+Les différentes commandes sont les suivantes:
**CHECKING_STUDY**
- *Commande obligatoire*. C'est la commande générale qui décrit le cas de
- vérification. Elle contient hiérarchiquement toutes les autres commandes.
-
- Algorithm
- *Commande obligatoire*. C'est une chaîne de caractère qui indique
- l'algorithme de test choisi. Les choix sont limités et disponibles à travers
- l'interface graphique. Il existe par exemple "FunctionTest",
- "AdjointTest"... Voir plus loin la liste des algorithmes et des paramètres
- associés, chacun décrit par une sous-section.
+ *Commande obligatoire*. C'est la commande générale qui décrit le cas de
+ vérification. Elle contient hiérarchiquement toutes les autres commandes.
AlgorithmParameters
- *Commande optionnelle*. Elle permet d'ajouter des paramètres optionnels pour
- contrôler l'algorithme d'assimilation de données ou d'optimisation. Sa
- valeur est définie comme un objet de type "*Dict*". Voir la
- :ref:`section_ref_options_AlgorithmParameters` pour l'usage correct de cette
- commande.
-
- CheckingPoint
- *Commande obligatoire*. Elle définit le vecteur utilisé comme l'état autour
- duquel réaliser le test requis, noté :math:`\mathbf{x}` et similaire à
- l'ébauche :math:`\mathbf{x}^b`. Sa valeur est définie comme un objet de type
- "*Vector*".
-
- BackgroundError
- *Commande obligatoire*. Elle définit la matrice de covariance des erreurs
- d'ébauche, notée précédemment :math:`\mathbf{B}`. Sa valeur est définie
- comme un objet de type "*Matrix*", de type "*ScalarSparseMatrix*", ou de
- type "*DiagonalSparseMatrix*".
+ *Commande obligatoire*. Elle définit l'algorithme de test choisi par le
+ mot-clé "*Algorithm*", et ses éventuels paramètres optionnels. Les choix
+ d'algorithmes sont disponibles à travers l'interface graphique. Il existe
+ par exemple le "FunctionTest", le "GradientTest"... Chaque algorithme est
+ défini, plus loin, par une sous-section spécifique. De manière facultative,
+ la commande permet aussi d'ajouter des paramètres pour contrôler
+ l'algorithme. Leurs valeurs sont définies explicitement ou dans un objet de
+ type "*Dict*". On se reportera à la
+ :ref:`section_ref_options_Algorithm_Parameters` pour l'usage détaillé de
+ cette partie de la commande.
+
+ .. include:: snippets/CheckingPoint.rst
+
+ .. include:: snippets/BackgroundError.rst
Debug
- *Commande optionnelle*. Elle définit le niveau de sorties et d'informations
- intermédiaires de débogage. Les choix sont limités entre 0 (pour False) et
+ *Commande optionnelle*. Elle définit le niveau de sorties et d'informations
+ intermédiaires de débogage. Les choix sont limités entre 0 (pour False) et
1 (pour True).
- Observation
- *Commande obligatoire*. Elle définit le vecteur d'observation utilisé en
- assimilation de données ou en optimisation, et noté précédemment
- :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de type "*Vector*"
- ou de type "*VectorSerie*".
-
- ObservationError
- *Commande obligatoire*. Elle définit la matrice de covariance des erreurs
- d'ébauche, notée précédemment :math:`\mathbf{R}`. Sa valeur est définie
- comme un objet de type "*Matrix*", de type "*ScalarSparseMatrix*", ou de
- type "*DiagonalSparseMatrix*".
-
- ObservationOperator
- *Commande obligatoire*. Elle indique l'opérateur d'observation, noté
- précédemment :math:`H`, qui transforme les paramètres d'entrée
- :math:`\mathbf{x}` en résultats :math:`\mathbf{y}` qui sont à comparer aux
- observations :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de
- type "*Function*" ou de type "*Matrix*". Dans le cas du type "*Function*",
- différentes formes fonctionnelles peuvent être utilisées, comme décrit dans
- la section :ref:`section_ref_operator_requirements`. Si un contrôle
- :math:`U` est inclus dans le modèle d'observation, l'opérateur doit être
- appliqué à une paire :math:`(X,U)`.
+ .. include:: snippets/Observation.rst
+
+ .. include:: snippets/ObservationError.rst
+
+ .. include:: snippets/ObservationOperator.rst
Observers
- *Commande optionnelle*. Elle permet de définir des observateurs internes,
- qui sont des fonctions liées à une variable particulière, qui sont exécutées
- chaque fois que cette variable est modifiée. C'est une manière pratique de
- suivre des variables d'intérêt durant le processus d'assimilation de données
- ou d'optimisation, en l'affichant ou en la traçant, etc. Des exemples
+ *Commande optionnelle*. Elle permet de définir des observateurs internes,
+ qui sont des fonctions liées à une variable particulière, qui sont exécutées
+ chaque fois que cette variable est modifiée. C'est une manière pratique de
+ suivre des variables d'intérêt durant le processus d'assimilation de données
+ ou d'optimisation, en l'affichant ou en la traçant, etc. Des exemples
courants (squelettes) sont fournis pour aider l'utilisateur ou pour
- faciliter l'élaboration d'un cas.
+ faciliter l'élaboration d'un cas.
- Study_name
- *Commande obligatoire*. C'est une chaîne de caractères quelconque pour
- décrire l'étude ADAO par un nom ou une déclaration.
+ StudyName
+ *Commande obligatoire*. C'est une chaîne de caractères quelconque pour
+ décrire l'étude ADAO par un nom ou une déclaration.
- Study_repertory
- *Commande optionnelle*. S'il existe, ce répertoire est utilisé comme base
- pour les calculs, et il est utilisé pour trouver les fichiers de script,
- donnés par nom sans répertoire, qui peuvent être utilisés pour définir
+ StudyRepertory
+ *Commande optionnelle*. S'il existe, ce répertoire est utilisé comme base
+ pour les calculs, et il est utilisé pour trouver les fichiers de script,
+ donnés par nom sans répertoire, qui peuvent être utilisés pour définir
certaines variables.
UserDataInit
- *Commande optionnelle*. Elle permet d'initialiser certains paramètres ou
- certaines données automatiquement avant le traitement de données d'entrée
- pour l'assimilation de données ou l'optimisation. Pour cela, elle indique un
- nom de fichier de script à exécuter avant d'entrer dans l'initialisation des
+ *Commande optionnelle*. Elle permet d'initialiser certains paramètres ou
+ certaines données automatiquement avant le traitement de données d'entrée
+ pour l'assimilation de données ou l'optimisation. Pour cela, elle indique un
+ nom de fichier de script à exécuter avant d'entrer dans l'initialisation des
variables choisies.
