]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Documentation examples tuning (2)
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Wed, 11 Nov 2020 13:28:00 +0000 (14:28 +0100)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Wed, 11 Nov 2020 13:28:00 +0000 (14:28 +0100)
doc/en/ref_algorithm_3DVAR.rst
doc/en/scripts/simple_3DVAR.rst [new file with mode: 0644]
doc/en/snippets/Header2Algo09.rst
doc/fr/ref_algorithm_3DVAR.rst
doc/fr/scripts/simple_3DVAR.rst [new file with mode: 0644]
doc/fr/snippets/Header2Algo09.rst

index 4a51b3994263cf4266ed54fc8fcb05292738bf38..83985a5870590f67c8b1fa87e41214d7e2cd7b2d 100644 (file)
@@ -195,6 +195,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo09.rst
 
+.. include:: scripts/simple_3DVAR.rst
+
 .. literalinclude:: scripts/simple_3DVAR.py
 
 .. include:: snippets/Header2Algo10.rst
diff --git a/doc/en/scripts/simple_3DVAR.rst b/doc/en/scripts/simple_3DVAR.rst
new file mode 100644 (file)
index 0000000..326ec70
--- /dev/null
@@ -0,0 +1,16 @@
+.. index:: single: 3DVAR (example)
+
+This example describes the calibration of parameters  :math:`\mathbf{x}` of a
+quadratic observation model :math:`H`. This model is here represented as a
+function named ``QuadFunction``. This function get as input the coefficients
+vector :math:`\mathbf{x}`, and return as output the evaluation vector
+:math:`\mathbf{y}` of the quadratic model at the predefined internal control
+points. The calibration is done using an initial coefficient set (background
+state specified by ``Xb`` in the code), and with the information
+:math:`\mathbf{y}^o` (specified by ``Yobs`` in the code) of 5 measures obtained
+in these same internal control points. We choose to emphasize the observations
+versus the background by setting a great variance for the background error,
+here of :math:`10^{6}`.
+
+The adjustment is carried out by displaying intermediate results during
+iterative optimization.
index 8d83c23bb2bd2992ef15c494e5e2a09430397ed1..d7970868fa88bc46a800e0aee091590e4f8251a7 100644 (file)
@@ -1,6 +1,6 @@
 Python (TUI) use example
 ++++++++++++++++++++++++
 
-Here is a very simple use of the given algorithm, written in :ref:`section_tui`,
-and from which input information allow to define an equivalent cas in graphical
-interface.
+Here is a very simple use of the given algorithm and its parameters, written in
+:ref:`section_tui`, and from which input information allow to define an
+equivalent cas in graphical interface.
index 18596279095479cb91791f8c611881570f0caed1..7f64d13217a5b851995e2a1f435e36fd2fb81a2d 100644 (file)
@@ -197,6 +197,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo09.rst
 
+.. include:: scripts/simple_3DVAR.rst
+
 .. literalinclude:: scripts/simple_3DVAR.py
 
 .. include:: snippets/Header2Algo10.rst
diff --git a/doc/fr/scripts/simple_3DVAR.rst b/doc/fr/scripts/simple_3DVAR.rst
new file mode 100644 (file)
index 0000000..1e1f43d
--- /dev/null
@@ -0,0 +1,16 @@
+.. index:: single: 3DVAR (exemple)
+
+Cet exemple décrit le recalage des paramètres :math:`\mathbf{x}` d'un modèle
+d'observation :math:`H` quadratique. Ce modèle est représenté ici comme une
+fonction nommée ``QuadFunction``. Cette fonction accepte en entrée le vecteur
+de coefficients :math:`\mathbf{x}`, et fournit en sortie le vecteur
+:math:`\mathbf{y}` d'évaluation du modèle quadratique aux points de contrôle
+internes prédéfinis dans le modèle. Le calage s'effectue sur la base d'un jeu
+initial de coefficients (état d'ébauche désigné par ``Xb`` dans l'exemple), et
+avec l'information :math:`\mathbf{y}^o` (désignée par ``Yobs`` dans l'exemple)
+de 5 mesures obtenues à ces mêmes points de contrôle internes. On privilégie
+les observations au détriment de l'ébauche par l'indication d'une très
+importante variance d'erreur d'ébauche, ici de :math:`10^{6}`.
+
+L'ajustement s'effectue en affichant des résultats intermédiaires lors de
+l'optimisation itérative.
index 6f464a52b3569867d73f07302307f9c49b382b5c..bb285ba83e7aed0b49ff3edb8fdb22728ac26ce1 100644 (file)
@@ -1,6 +1,6 @@
 Exemple d'utilisation en Python (TUI)
 +++++++++++++++++++++++++++++++++++++
 
-Voici un exemple très simple d'usage de l'algorithme proposé, écrit en
-:ref:`section_tui`, et dont les informations en entrée permettent de définir un
-cas équivalent en interface graphique.
+Voici un exemple très simple d'usage de l'algorithme proposé et de ses
+paramètres, écrit en :ref:`section_tui`, et dont les informations indiquées en
+entrée permettent de définir un cas équivalent en interface graphique.