Salome HOME
Documentation corrections and improvements for outputs
[modules/adao.git] / doc / fr / ref_algorithm_LinearLeastSquares.rst
1 ..
2    Copyright (C) 2008-2015 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: LinearLeastSquares
25 .. _section_ref_algorithm_LinearLeastSquares:
26
27 Algorithme de calcul "*LinearLeastSquares*"
28 -------------------------------------------
29
30 Description
31 +++++++++++
32
33 Cet algorithme réalise une estimation linéaire de type "Moindres Carrés"
34 pondérés. Il est similaire à l':ref:`section_ref_algorithm_Blue`
35 amputé de sa partie ébauche.
36
37 Cet algorithme est toujours le plus rapide de l'ensemble des algorithmes
38 d'optimisation d'ADAO. Il est théoriquement réservé aux cas d'opérateurs
39 d'observation linéaires, même s'il fonctionne parfois dans les cas "faiblement"
40 non-linéaire. On peut vérifier la linéarité de l'opérateur d'observation à
41 l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
42
43 Dans tous les cas, il est recommandé de lui préférer au minimum
44 l':ref:`section_ref_algorithm_Blue`, voire
45 l':ref:`section_ref_algorithm_ExtendedBlue` ou
46 l':ref:`section_ref_algorithm_3DVAR`.
47
48 Commandes requises et optionnelles
49 ++++++++++++++++++++++++++++++++++
50
51 .. index:: single: Observation
52 .. index:: single: ObservationError
53 .. index:: single: ObservationOperator
54 .. index:: single: StoreInternalVariables
55 .. index:: single: StoreSupplementaryCalculations
56
57 Les commandes requises générales, disponibles dans l'interface en édition, sont
58 les suivantes:
59
60   Observation
61     *Commande obligatoire*. Elle définit le vecteur d'observation utilisé en
62     assimilation de données ou en optimisation, et noté précédemment
63     :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de type "*Vector*"
64     ou de type "*VectorSerie*".
65
66   ObservationError
67     *Commande obligatoire*. Elle définit la matrice de covariance des erreurs
68     d'ébauche, notée précédemment :math:`\mathbf{R}`. Sa valeur est définie
69     comme un objet de type "*Matrix*", de type "*ScalarSparseMatrix*", ou de
70     type "*DiagonalSparseMatrix*".
71
72   ObservationOperator
73     *Commande obligatoire*. Elle indique l'opérateur d'observation, noté
74     précédemment :math:`H`, qui transforme les paramètres d'entrée
75     :math:`\mathbf{x}` en résultats :math:`\mathbf{y}` qui sont à comparer aux
76     observations :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de
77     type "*Function*" ou de type "*Matrix*". Dans le cas du type "*Function*",
78     différentes formes fonctionnelles peuvent être utilisées, comme décrit dans
79     la section :ref:`section_ref_operator_requirements`. Si un contrôle
80     :math:`U` est inclus dans le modèle d'observation, l'opérateur doit être
81     appliqué à une paire :math:`(X,U)`.
82
83 Les commandes optionnelles générales, disponibles dans l'interface en édition,
84 sont indiquées dans la :ref:`section_ref_assimilation_keywords`. En particulier,
85 la commande optionnelle "*AlgorithmParameters*" permet d'indiquer les options
86 particulières, décrites ci-après, de l'algorithme. On se reportera à la
87 :ref:`section_ref_options_AlgorithmParameters` pour le bon usage de cette
88 commande.
89
90 Les options de l'algorithme sont les suivantes:
91
92   StoreInternalVariables
93     Cette clé booléenne permet de stocker les variables internes par défaut,
94     principalement l'état courant lors d'un processus itératif. Attention, cela
95     peut être un choix numériquement coûteux dans certains cas de calculs. La
96     valeur par défaut est "False".
97
98     Exemple : ``{"StoreInternalVariables":True}``
99
100   StoreSupplementaryCalculations
101     Cette liste indique les noms des variables supplémentaires qui peuvent être
102     disponibles à la fin de l'algorithme. Cela implique potentiellement des
103     calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
104     aucune de ces variables n'étant calculée et stockée par défaut. Les noms
105     possibles sont dans la liste suivante : ["OMA"].
106
107     Exemple : ``{"StoreSupplementaryCalculations":["OMA"]}``
108
109 *Astuce pour cet algorithme :*
110
111     Comme les commandes *"Background"* et *"BackgroundError"* sont requises pour
112     TOUS les algorithmes de calcul dans l'interface, vous devez fournir une
113     valeur, malgré le fait que ces commandes ne sont pas requises pour
114     cet algorithme, et ne seront pas utilisées. La manière la plus simple est
115     de donner "1" comme un STRING pour les deux.
116
117 Informations et variables disponibles à la fin de l'algorithme
118 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
119
120 En sortie, après exécution de l'algorithme, on dispose d'informations et de
121 variables issues du calcul. La description des
122 :ref:`section_ref_output_variables` indique la manière de les obtenir par la
123 méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
124 d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
125 l'écriture des procédures de post-processing, sont décrites dans
126 l':ref:`subsection_r_o_v_Inventaire`.
127
128 Les sorties non conditionnelles de l'algorithme sont les suivantes:
129
130   Analysis
131     *Liste de vecteurs*. Chaque élément est un état optimal :math:`\mathbf{x}*`
132     en optimisation ou une analyse :math:`\mathbf{x}^a` en assimilation de
133     données.
134
135     Exemple : ``Xa = ADD.get("Analysis")[-1]``
136
137   CostFunctionJ
138     *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
139     :math:`J`.
140
141     Exemple : ``J = ADD.get("CostFunctionJ")[:]``
142
143   CostFunctionJb
144     *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
145     :math:`J^b`, c'est-à-dire de la partie écart à l'ébauche.
146
147     Exemple : ``Jb = ADD.get("CostFunctionJb")[:]``
148
149   CostFunctionJo
150     *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
151     :math:`J^o`, c'est-à-dire de la partie écart à l'observation.
152
153     Exemple : ``Jo = ADD.get("CostFunctionJo")[:]``
154
155 Les sorties conditionnelles de l'algorithme sont les suivantes:
156
157   OMA
158     *Liste de vecteurs*. Chaque élément est un vecteur d'écart entre
159     l'observation et l'état optimal dans l'espace des observations.
160
161     Exemple : ``oma = ADD.get("OMA")[-1]``
162
163   SimulatedObservationAtOptimum
164     *Liste de vecteurs*. Chaque élément est un vecteur d'observation simulé à
165     partir de l'analyse ou de l'état optimal :math:`\mathbf{x}^a`.
166
167     Exemple : ``hxa = ADD.get("SimulatedObservationAtOptimum")[-1]``
168
169 Voir aussi
170 ++++++++++
171
172 Références vers d'autres sections :
173   - :ref:`section_ref_algorithm_Blue`
174   - :ref:`section_ref_algorithm_ExtendedBlue`
175   - :ref:`section_ref_algorithm_3DVAR`
176   - :ref:`section_ref_algorithm_LinearityTest`