]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Documentation examples tuning (3)
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Wed, 11 Nov 2020 14:13:25 +0000 (15:13 +0100)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Wed, 11 Nov 2020 14:13:25 +0000 (15:13 +0100)
12 files changed:
doc/en/ref_algorithm_Blue.rst
doc/en/ref_algorithm_ExtendedBlue.rst
doc/en/ref_algorithm_NonLinearLeastSquares.rst
doc/en/scripts/simple_Blue.rst [new file with mode: 0644]
doc/en/scripts/simple_ExtendedBlue.rst [new file with mode: 0644]
doc/en/scripts/simple_NonLinearLeastSquares.rst [new file with mode: 0644]
doc/fr/ref_algorithm_Blue.rst
doc/fr/ref_algorithm_ExtendedBlue.rst
doc/fr/ref_algorithm_NonLinearLeastSquares.rst
doc/fr/scripts/simple_Blue.rst [new file with mode: 0644]
doc/fr/scripts/simple_ExtendedBlue.rst [new file with mode: 0644]
doc/fr/scripts/simple_NonLinearLeastSquares.rst [new file with mode: 0644]

index 73e96d477110c5994f1301fbb79ba57a65e62be7..28ad983f6bb884cab3e8118a71470b2c61f8f613 100644 (file)
@@ -167,6 +167,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo09.rst
 
+.. include:: scripts/simple_Blue.rst
+
 .. literalinclude:: scripts/simple_Blue.py
 
 .. include:: snippets/Header2Algo10.rst
index 5a2b0b77204d52b707d984d7f61ace6cdad3056b..126cef10412e3fe52404bab427fbe4354ab1b615 100644 (file)
@@ -165,6 +165,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo09.rst
 
+.. include:: scripts/simple_ExtendedBlue.rst
+
 .. literalinclude:: scripts/simple_ExtendedBlue.py
 
 .. include:: snippets/Header2Algo10.rst
index 953e82bfb828f411f862a8c229a718e5cf403199..05ef5bc694050b778b05d74e2dcd4ca4501d7438 100644 (file)
@@ -167,6 +167,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo09.rst
 
+.. include:: scripts/simple_NonLinearLeastSquares.rst
+
 .. literalinclude:: scripts/simple_NonLinearLeastSquares.py
 
 .. include:: snippets/Header2Algo10.rst
diff --git a/doc/en/scripts/simple_Blue.rst b/doc/en/scripts/simple_Blue.rst
new file mode 100644 (file)
index 0000000..458f4d5
--- /dev/null
@@ -0,0 +1,9 @@
+.. index:: single: Blue (example)
+
+This example describes the interpolation between two physical states. These two
+vector fields, of identical discretization, are the observation
+:math:`\mathbf{y}^o` and the background state :math:`\mathbf{x}^b`. The
+confidence in errors on the two information are considered identical. The
+:math:`H` model fully observe the available field, it is a matrix selection
+operator.
+
diff --git a/doc/en/scripts/simple_ExtendedBlue.rst b/doc/en/scripts/simple_ExtendedBlue.rst
new file mode 100644 (file)
index 0000000..936fb69
--- /dev/null
@@ -0,0 +1,9 @@
+.. index:: single: ExtendedBlue (example)
+
+This example describes the interpolation between two physical states. These two
+vector fields, of identical discretization, are the observation
+:math:`\mathbf{y}^o` and the background state :math:`\mathbf{x}^b`. The
+confidence in errors on the two information are considered identical. The
+:math:`H` model fully observe the available field, it is a matrix selection
+operator.
+
diff --git a/doc/en/scripts/simple_NonLinearLeastSquares.rst b/doc/en/scripts/simple_NonLinearLeastSquares.rst
new file mode 100644 (file)
index 0000000..1aefa58
--- /dev/null
@@ -0,0 +1,14 @@
+.. index:: single: NonLinearLeastSquares (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.
+
+The adjustment is carried out by displaying intermediate results during
+iterative optimization.
index 51d720b553c53b3b402aaef834cdee09afd6bf59..b35e3816b25ec6f90be01cd57624f8e05e8f1cc9 100644 (file)
@@ -169,6 +169,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo09.rst
 
+.. include:: scripts/simple_Blue.rst
+
 .. literalinclude:: scripts/simple_Blue.py
 
 .. include:: snippets/Header2Algo10.rst
index f9db29912c753812f84b00af0ba57eafb897fee9..995953ff5b7194898b711914292450d00d3888f5 100644 (file)
@@ -166,6 +166,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo09.rst
 
+.. include:: scripts/simple_ExtendedBlue.rst
+
 .. literalinclude:: scripts/simple_ExtendedBlue.py
 
 .. include:: snippets/Header2Algo10.rst
index c32e8bbc969eeecc6515e34d4313914972ef0788..8fced14922e58cc834999b9a3c13fb4c2e79f74e 100644 (file)
@@ -170,6 +170,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo09.rst
 
+.. include:: scripts/simple_NonLinearLeastSquares.rst
+
 .. literalinclude:: scripts/simple_NonLinearLeastSquares.py
 
 .. include:: snippets/Header2Algo10.rst
diff --git a/doc/fr/scripts/simple_Blue.rst b/doc/fr/scripts/simple_Blue.rst
new file mode 100644 (file)
index 0000000..97f5167
--- /dev/null
@@ -0,0 +1,9 @@
+.. index:: single: Blue (exemple)
+
+Cet exemple décrit l'interpolation entre deux états physiques. Ces deux champs
+vectoriels, de discrétisation identique, sont l'observation
+:math:`\mathbf{y}^o` et l'état d'ébauche a priori :math:`\mathbf{x}^b`. Les
+confiances dans les erreurs sur les deux informations sont considérées comme
+identiques. Le modèle :math:`H` observe complètement le champ disponible, c'est
+un opérateur de sélection matriciel.
+
diff --git a/doc/fr/scripts/simple_ExtendedBlue.rst b/doc/fr/scripts/simple_ExtendedBlue.rst
new file mode 100644 (file)
index 0000000..ab66c00
--- /dev/null
@@ -0,0 +1,9 @@
+.. index:: single: ExtendedBlue (exemple)
+
+Cet exemple décrit l'interpolation entre deux états physiques. Ces deux champs
+vectoriels, de discrétisation identique, sont l'observation
+:math:`\mathbf{y}^o` et l'état d'ébauche a priori :math:`\mathbf{x}^b`. Les
+confiances dans les erreurs sur les deux informations sont considérées comme
+identiques. Le modèle :math:`H` observe complètement le champ disponible, c'est
+un opérateur de sélection matriciel.
+
diff --git a/doc/fr/scripts/simple_NonLinearLeastSquares.rst b/doc/fr/scripts/simple_NonLinearLeastSquares.rst
new file mode 100644 (file)
index 0000000..32bf45a
--- /dev/null
@@ -0,0 +1,14 @@
+.. index:: single: NonLinearLeastSquares (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.
+
+L'ajustement s'effectue en affichant des résultats intermédiaires lors de
+l'optimisation itérative.