]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Documentation minor corrections
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 5 May 2014 07:04:16 +0000 (09:04 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 5 May 2014 07:04:16 +0000 (09:04 +0200)
doc/en/reference.rst
doc/fr/reference.rst

index 0b89bc0016f52694cd47e056ea575cc0a5f32094..2b98d48322dba6daf4537d4231699c09529ffdbf 100644 (file)
@@ -720,8 +720,9 @@ commands are the following:
     algorithms`_.
 
 **CheckingPoint**
-    *Required command*. This indicates the vector used, previously noted as
-    :math:`\mathbf{x}^b`. It is defined as a "*Vector*" type object.
+    *Required command*. This indicates the vector used as the state around which
+    to perform the required check, noted :math:`\mathbf{x}` and similar to the
+    background :math:`\mathbf{x}^b`. It is defined as a "*Vector*" type object.
 
 **Debug**
     *Optional command*. This define the level of trace and intermediary debug
@@ -738,6 +739,14 @@ commands are the following:
     control :math:`U` included in the observation, the operator has to be
     applied to a pair :math:`(X,U)`.
 
+**Observers**
+    *Optional command*. This command allows to set internal observers, that are
+    functions linked with a particular variable, which will be executed each
+    time this variable is modified. It is a convenient way to monitor variables
+    of interest during the data assimilation or optimization process, by
+    printing or plotting it, etc. Common templates are provided to help the user
+    to start or to quickly make his case.
+
 **Study_name**
     *Required command*. This is an open string to describe the study by a name
     or a sentence.
index 5fbaf736487ab417a93455f1668c116b9fc63073..dca5ac8182e46e91c9fdbeb326082e4f0db1ee27 100644 (file)
@@ -753,8 +753,10 @@ v
     optionnelles et requises pour les algorithmes de vérification`_.
 
 **CheckingPoint**
-    *Commande obligatoire*. Elle définit le vecteur utilisé, noté précédemment
-    :math:`\mathbf{x}`. Sa valeur est définie comme un objet de type "*Vector*".
+    *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*".
 
 **Debug**
     *Commande optionnelle*. Elle définit le niveau de sorties et d'informations
@@ -771,6 +773,15 @@ v
     décrivant un opérateur`_. 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)`.
 
+**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
+    courants (squelettes) sont fournis pour aider l'utilisateur ou pour
+    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.