Salome HOME
Adding LocalSensitivityTest algorithm
[modules/adao.git] / doc / fr / ref_algorithm_LocalSensitivityTest.rst
1 ..
2    Copyright (C) 2008-2019 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: LocalSensitivityTest
25 .. _section_ref_algorithm_LocalSensitivityTest:
26
27 Algorithme de vérification "*LocalSensitivityTest*"
28 ---------------------------------------------------
29
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo00.rst
32
33 .. ------------------------------------ ..
34 .. include:: snippets/Header2Algo01.rst
35
36 Cet algorithme permet d'établir la valeur de la Jacobienne de l'opérateur
37 :math:`H` par rapport aux variables d'entrée :math:`\mathbf{x}`. Cet opérateur
38 intervient dans la relation :
39
40 .. math:: \mathbf{y} = H(\mathbf{x})
41
42 (voir :ref:`section_theory` pour de plus amples explications). Cette jacobienne
43 est l'opérateur linéarisé (ou opérateur tangent) :math:`\mathbf{H}` de
44 :math:`H` autour du point de vérification choisi.
45
46 .. ------------------------------------ ..
47 .. include:: snippets/Header2Algo02.rst
48
49 .. include:: snippets/CheckingPoint.rst
50
51 .. include:: snippets/Observation.rst
52
53 *Remarque : l'observation n'étant utilisé que pour renforcer la vérification
54 des dimensions, elle peut donc être fournie comme un vecteur non réaliste de
55 la bonne taille.
56 Exemple :* ``numpy.ones(<nombre d'observations>)``
57
58 .. include:: snippets/ObservationOperator.rst
59
60 .. ------------------------------------ ..
61 .. include:: snippets/Header2Algo03Chck.rst
62
63 .. include:: snippets/SetDebug.rst
64
65 StoreSupplementaryCalculations
66   .. index:: single: StoreSupplementaryCalculations
67
68   Cette liste indique les noms des variables supplémentaires qui peuvent être
69   disponibles à la fin de l'algorithme. Cela implique potentiellement des
70   calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
71   aucune de ces variables n'étant calculée et stockée par défaut. Les noms
72   possibles sont dans la liste suivante : [
73   "CurrentState",
74   "JacobianMatrixAtCurrentState",
75   "SimulatedObservationAtCurrentState",
76   ].
77
78   Exemple :
79   ``{"StoreSupplementaryCalculations":["CurrentState"]}``
80
81 .. ------------------------------------ ..
82 .. include:: snippets/Header2Algo04.rst
83
84 .. include:: snippets/JacobianMatrixAtCurrentState.rst
85
86 .. ------------------------------------ ..
87 .. include:: snippets/Header2Algo05.rst
88
89 .. include:: snippets/CurrentState.rst
90
91 .. include:: snippets/SimulatedObservationAtCurrentState.rst
92
93 .. ------------------------------------ ..
94 .. include:: snippets/Header2Algo06.rst
95
96 - :ref:`section_ref_algorithm_FunctionTest`
97 - :ref:`section_ref_algorithm_GradientTest`