Salome HOME
Adding CurrentIterationNumber to user information and documentation
[modules/adao.git] / doc / fr / ref_algorithm_NonLinearLeastSquares.rst
1 ..
2    Copyright (C) 2008-2020 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: NonLinearLeastSquares
25 .. _section_ref_algorithm_NonLinearLeastSquares:
26
27 Algorithme de calcul "*NonLinearLeastSquares*"
28 ----------------------------------------------
29
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
32
33 Cet algorithme réalise une estimation d'état par minimisation variationnelle de
34 la fonctionnelle :math:`J` d'écart classique de "Moindres Carrés" pondérés:
35
36 .. math:: J(\mathbf{x})=(\mathbf{y}^o-\mathbf{H}.\mathbf{x})^T.\mathbf{R}^{-1}.(\mathbf{y}^o-\mathbf{H}.\mathbf{x})
37
38 Il est similaire à l':ref:`section_ref_algorithm_3DVAR` privé de sa partie
39 ébauche. L'ébauche, requise dans l'interface, ne sert que de point initial pour
40 la minimisation variationnelle.
41
42 Dans tous les cas, il est recommandé de lui préférer
43 l':ref:`section_ref_algorithm_3DVAR` pour sa stabilité comme pour son
44 comportement lors de l'optimisation.
45
46 .. ------------------------------------ ..
47 .. include:: snippets/Header2Algo02.rst
48
49 .. include:: snippets/Background.rst
50
51 .. include:: snippets/Observation.rst
52
53 .. include:: snippets/ObservationError.rst
54
55 .. include:: snippets/ObservationOperator.rst
56
57 .. ------------------------------------ ..
58 .. include:: snippets/Header2Algo03AdOp.rst
59
60 Minimizer
61   .. index:: single: Minimizer
62
63   Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
64   défaut est "LBFGSB", et les choix possibles sont "LBFGSB" (minimisation non
65   linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
66   (minimisation non linéaire sous contraintes), "CG" (minimisation non
67   linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
68   contraintes), "NCG" (minimisation de type gradient conjugué de Newton), "LM"
69   (minimisation non linéaire de type Levenberg-Marquard). Il est fortement
70   conseillé de conserver la valeur par défaut.
71
72   Exemple :
73   ``{"Minimizer":"LBFGSB"}``
74
75 .. include:: snippets/BoundsWithNone.rst
76
77 .. include:: snippets/MaximumNumberOfSteps.rst
78
79 .. include:: snippets/CostDecrementTolerance.rst
80
81 .. include:: snippets/ProjectedGradientTolerance.rst
82
83 .. include:: snippets/GradientNormTolerance.rst
84
85 StoreSupplementaryCalculations
86   .. index:: single: StoreSupplementaryCalculations
87
88   Cette liste indique les noms des variables supplémentaires qui peuvent être
89   disponibles à la fin de l'algorithme, si elles sont initialement demandées par
90   l'utilisateur. Cela implique potentiellement des calculs ou du stockage
91   coûteux. La valeur par défaut est une liste vide, aucune de ces variables
92   n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
93   Les noms possibles sont dans la liste suivante : [
94   "Analysis",
95   "BMA",
96   "CostFunctionJ",
97   "CostFunctionJAtCurrentOptimum",
98   "CostFunctionJb",
99   "CostFunctionJbAtCurrentOptimum",
100   "CostFunctionJo",
101   "CostFunctionJoAtCurrentOptimum",
102   "CurrentIterationNumber",
103   "CurrentOptimum",
104   "CurrentState",
105   "IndexOfOptimum",
106   "Innovation",
107   "InnovationAtCurrentState",
108   "OMA",
109   "OMB",
110   "SimulatedObservationAtBackground",
111   "SimulatedObservationAtCurrentOptimum",
112   "SimulatedObservationAtCurrentState",
113   "SimulatedObservationAtOptimum",
114   ].
115
116   Exemple :
117   ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
118
119 *Astuce pour cet algorithme :*
120
121     Comme la commande *"BackgroundError"* est requise pour TOUS les algorithmes
122     de calcul dans l'interface graphique EFICAS d'ADAO, vous devez fournir une
123     valeur, malgré le fait que cette commande ne soit pas nécessaire pour cet
124     algorithme, et n'est donc pas utilisée. La manière la plus simple est de
125     donner "1" comme un STRING.
126
127 .. ------------------------------------ ..
128 .. include:: snippets/Header2Algo04.rst
129
130 .. include:: snippets/Analysis.rst
131
132 .. include:: snippets/CostFunctionJ.rst
133
134 .. include:: snippets/CostFunctionJb.rst
135
136 .. include:: snippets/CostFunctionJo.rst
137
138 .. ------------------------------------ ..
139 .. include:: snippets/Header2Algo05.rst
140
141 .. include:: snippets/Analysis.rst
142
143 .. include:: snippets/BMA.rst
144
145 .. include:: snippets/CostFunctionJ.rst
146
147 .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
148
149 .. include:: snippets/CostFunctionJb.rst
150
151 .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
152
153 .. include:: snippets/CostFunctionJo.rst
154
155 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
156
157 .. include:: snippets/CurrentIterationNumber.rst
158
159 .. include:: snippets/CurrentOptimum.rst
160
161 .. include:: snippets/CurrentState.rst
162
163 .. include:: snippets/IndexOfOptimum.rst
164
165 .. include:: snippets/Innovation.rst
166
167 .. include:: snippets/InnovationAtCurrentState.rst
168
169 .. include:: snippets/OMA.rst
170
171 .. include:: snippets/OMB.rst
172
173 .. include:: snippets/SimulatedObservationAtBackground.rst
174
175 .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
176
177 .. include:: snippets/SimulatedObservationAtCurrentState.rst
178
179 .. include:: snippets/SimulatedObservationAtOptimum.rst
180
181 .. ------------------------------------ ..
182 .. include:: snippets/Header2Algo09.rst
183
184 .. literalinclude:: scripts/simple_NonLinearLeastSquares.py
185
186 .. include:: snippets/Header2Algo10.rst
187
188 .. literalinclude:: scripts/simple_NonLinearLeastSquares.res
189
190 .. ------------------------------------ ..
191 .. include:: snippets/Header2Algo06.rst
192
193 - :ref:`section_ref_algorithm_3DVAR`
194
195 .. ------------------------------------ ..
196 .. include:: snippets/Header2Algo07.rst
197
198 - [Byrd95]_
199 - [Morales11]_
200 - [Zhu97]_