Salome HOME
Documentation update with features and review corrections
[modules/adao.git] / doc / fr / ref_algorithm_LocalSensitivityTest.rst
1 ..
2    Copyright (C) 2008-2024 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/Header2Algo01.rst
32
33 Cet algorithme permet d'établir la valeur de la Jacobienne de l'opérateur
34 d'observation :math:`\mathcal{H}` par rapport aux variables d'entrée
35 :math:`\mathbf{x}`. Cet opérateur intervient dans la relation :
36
37 .. math:: \mathbf{y} = \mathcal{H}(\mathbf{x})
38
39 (voir :ref:`section_theory` pour de plus amples explications). Cette jacobienne
40 est l'opérateur linéarisé (ou opérateur tangent) :math:`\mathbf{H}` de
41 :math:`\mathcal{H}` autour du point de vérification choisi.
42
43 .. ------------------------------------ ..
44 .. include:: snippets/Header2Algo12.rst
45
46 .. include:: snippets/FeaturePropDerivativeNeeded.rst
47
48 .. include:: snippets/FeaturePropParallelDerivativesOnly.rst
49
50 .. ------------------------------------ ..
51 .. include:: snippets/Header2Algo02.rst
52
53 .. include:: snippets/CheckingPoint.rst
54
55 .. include:: snippets/Observation.rst
56
57 *Remarque : l'observation n'étant utilisé que pour renforcer la vérification
58 des dimensions, elle peut donc être fournie comme un vecteur non réaliste de
59 la bonne taille.
60 Exemple :* ``numpy.ones(<nombre d'observations>)``
61
62 .. include:: snippets/ObservationOperator.rst
63
64 .. ------------------------------------ ..
65 .. include:: snippets/Header2Algo03Chck.rst
66
67 .. include:: snippets/SetDebug.rst
68
69 StoreSupplementaryCalculations
70   .. index:: single: StoreSupplementaryCalculations
71
72   *Liste de noms*. Cette liste indique les noms des variables supplémentaires,
73   qui peuvent être disponibles au cours du déroulement ou à la fin de
74   l'algorithme, si elles sont initialement demandées par l'utilisateur. Leur
75   disponibilité implique, potentiellement, des calculs ou du stockage coûteux.
76   La valeur par défaut est donc une liste vide, aucune de ces variables n'étant
77   calculée et stockée par défaut (sauf les variables inconditionnelles). Les
78   noms possibles pour les variables supplémentaires sont dans la liste suivante
79   (la description détaillée de chaque variable nommée est donnée dans la suite
80   de cette documentation par algorithme spécifique, dans la sous-partie
81   "*Informations et variables disponibles à la fin de l'algorithme*") : [
82   "CurrentState",
83   "JacobianMatrixAtCurrentState",
84   "SimulatedObservationAtCurrentState",
85   ].
86
87   Exemple :
88   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
89
90 .. ------------------------------------ ..
91 .. include:: snippets/Header2Algo04.rst
92
93 .. include:: snippets/JacobianMatrixAtCurrentState.rst
94
95 .. ------------------------------------ ..
96 .. include:: snippets/Header2Algo05.rst
97
98 .. include:: snippets/CurrentState.rst
99
100 .. include:: snippets/JacobianMatrixAtCurrentState.rst
101
102 .. include:: snippets/SimulatedObservationAtCurrentState.rst
103
104 .. ------------------------------------ ..
105 .. _section_ref_algorithm_LocalSensitivityTest_examples:
106
107 .. include:: snippets/Header2Algo06.rst
108
109 - :ref:`section_ref_algorithm_FunctionTest`
110 - :ref:`section_ref_algorithm_GradientTest`