Salome HOME
Documentation for sampling update and examples improvement
[modules/adao.git] / doc / fr / ref_algorithm_SamplingTest.rst
1 ..
2    Copyright (C) 2008-2023 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: SamplingTest
25 .. _section_ref_algorithm_SamplingTest:
26
27 Algorithme de vérification "*SamplingTest*"
28 -------------------------------------------
29
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
32
33 Cet algorithme de test permet d'établir la collection des valeurs d'une
34 fonctionnelle d'erreur :math:`J` de type :math:`L^1`, :math:`L^2` ou
35 :math:`L^{\infty}`, avec ou sans pondérations, à l'aide de l'opérateur
36 d'observation :math:`\mathcal{H}`, pour un échantillon donné a priori d'états
37 :math:`\mathbf{x}`. La fonctionnelle d'erreur par défaut est celle de moindres
38 carrés pondérés augmentés, classiquement utilisée en assimilation de données,
39 utilisant en plus des observations :math:`\mathbf{y}^o`.
40
41 Ce test est utile pour analyser la sensibilité de la fonctionnelle :math:`J`
42 aux variations de l'état :math:`\mathbf{x}` en particulier.
43
44 L'échantillonnage des états :math:`\mathbf{x}` peut être fourni explicitement
45 ou sous la forme d'hypercubes, explicites ou échantillonnés selon des
46 distributions courantes, ou à l'aide d'un échantillonnage par hypercube latin
47 (LHS). Les calculs sont optimisés selon les ressources informatiques
48 disponibles et les options demandées par l'utilisateur. On pourra se reporter
49 aux :ref:`section_ref_sampling_requirements` pour une illustration de
50 l'échantillonnage. Attention à la taille de l'hypercube (et donc au nombre de
51 calculs) qu'il est possible d'atteindre, elle peut rapidement devenir
52 importante. Lorsqu'un état n'est pas observable, une valeur *"NaN"* est
53 retournée.
54
55 Il est aussi possible de fournir un ensemble de simulations :math:`\mathbf{y}`
56 déjà établies par ailleurs (donc sans besoin explicite d'un opérateur
57 :math:`\mathcal{H}`), qui sont implicitement associées à un ensemble
58 d'échantillons d'états :math:`\mathbf{x}`. Dans ce cas où l'ensemble de
59 simulations est fourni, il est impératif de fournir aussi l'ensemble des états
60 :math:`\mathbf{x}` par un échantillonnage explicite, dont l'ordre des états
61 correspond à l'ordre des simulations :math:`\mathbf{y}`.
62
63 Pour accéder aux informations calculées, les résultats de l'échantillonnage ou
64 des simulations doivent être demandés **explicitement** pour éviter les
65 difficultés de stockage (en l'absence de résultats demandés, rien n'est
66 disponible). On utilise pour cela, sur la variable désirée, la sauvegarde
67 finale à l'aide du mot-clé "*UserPostAnalysis*" ou le traitement en cours de
68 calcul à l'aide des "*observer*" adaptés.
69
70 .. ------------------------------------ ..
71 .. include:: snippets/Header2Algo02.rst
72
73 .. include:: snippets/CheckingPoint.rst
74
75 .. include:: snippets/BackgroundError.rst
76
77 .. include:: snippets/Observation.rst
78
79 .. include:: snippets/ObservationError.rst
80
81 .. include:: snippets/ObservationOperator.rst
82
83 .. ------------------------------------ ..
84 .. include:: snippets/Header2Algo03Chck.rst
85
86 .. include:: snippets/EnsembleOfSnapshots.rst
87
88 .. include:: snippets/QualityCriterion.rst
89
90 .. include:: snippets/SampleAsExplicitHyperCube.rst
91
92 .. include:: snippets/SampleAsIndependantRandomVariables.rst
93
94 .. include:: snippets/SampleAsMinMaxLatinHyperCube.rst
95
96 .. include:: snippets/SampleAsMinMaxStepHyperCube.rst
97
98 .. include:: snippets/SampleAsnUplet.rst
99
100 .. include:: snippets/SetDebug.rst
101
102 .. include:: snippets/SetSeed.rst
103
104 StoreSupplementaryCalculations
105   .. index:: single: StoreSupplementaryCalculations
106
107   *Liste de noms*. Cette liste indique les noms des variables supplémentaires,
108   qui peuvent être disponibles au cours du déroulement ou à la fin de
109   l'algorithme, si elles sont initialement demandées par l'utilisateur. Leur
110   disponibilité implique, potentiellement, des calculs ou du stockage coûteux.
111   La valeur par défaut est donc une liste vide, aucune de ces variables n'étant
112   calculée et stockée par défaut (sauf les variables inconditionnelles). Les
113   noms possibles pour les variables supplémentaires sont dans la liste suivante
114   (la description détaillée de chaque variable nommée est donnée dans la suite
115   de cette documentation par algorithme spécifique, dans la sous-partie
116   "*Informations et variables disponibles à la fin de l'algorithme*") : [
117   "CostFunctionJ",
118   "CostFunctionJb",
119   "CostFunctionJo",
120   "CurrentState",
121   "EnsembleOfSimulations",
122   "EnsembleOfStates",
123   "Innovation",
124   "InnovationAtCurrentState",
125   "SimulatedObservationAtCurrentState",
126   ].
127
128   Exemple :
129   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
130
131 .. ------------------------------------ ..
132 .. include:: snippets/Header2Algo04.rst
133
134 .. include:: snippets/CostFunctionJ.rst
135
136 .. include:: snippets/CostFunctionJb.rst
137
138 .. include:: snippets/CostFunctionJo.rst
139
140 .. ------------------------------------ ..
141 .. include:: snippets/Header2Algo05.rst
142
143 .. include:: snippets/CostFunctionJ.rst
144
145 .. include:: snippets/CostFunctionJb.rst
146
147 .. include:: snippets/CostFunctionJo.rst
148
149 .. include:: snippets/CurrentState.rst
150
151 .. include:: snippets/EnsembleOfSimulations.rst
152
153 .. include:: snippets/EnsembleOfStates.rst
154
155 .. include:: snippets/Innovation.rst
156
157 .. include:: snippets/InnovationAtCurrentState.rst
158
159 .. include:: snippets/SimulatedObservationAtCurrentState.rst
160
161 .. ------------------------------------ ..
162 .. _section_ref_algorithm_SamplingTest_examples:
163
164 .. include:: snippets/Header2Algo06.rst
165
166 - :ref:`section_ref_algorithm_FunctionTest`
167 - :ref:`section_ref_algorithm_LocalSensitivityTest`
168
169 .. ------------------------------------ ..
170 .. include:: snippets/Header2Algo08.rst
171
172 - OPENTURNS, voir le *Guide utilisateur du module OPENTURNS* dans le menu principal *Aide* de l'environnement SALOME