Salome HOME
Documentation update with features and review corrections
[modules/adao.git] / doc / fr / ref_algorithm_ObservationSimulationComparisonTest.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: ObservationSimulationComparisonTest
25 .. _section_ref_algorithm_ObservationSimulationComparisonTest:
26
27 Algorithme de vérification "*ObservationSimulationComparisonTest*"
28 ------------------------------------------------------------------
29
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
32
33 Cet algorithme de vérification permet d'analyser de manière simple la stabilité
34 de l'écart entre des mesures et le calcul d'un opérateur :math:`F`, lors de son
35 exécution. L'opérateur est quelconque, et il peut donc être celui d'observation
36 :math:`\mathcal{H}` comme celui d'évolution :math:`\mathcal{D}`, pourvu qu'il
37 soit fourni dans chaque cas selon les :ref:`section_ref_operator_requirements`.
38 L'opérateur :math:`F` est considéré comme dépendant d'une variable vectorielle
39 :math:`\mathbf{x}` et restituant une autre variable vectorielle
40 :math:`\mathbf{y}`.
41
42 L'algorithme vérifie que l'écart est stable, que l'opérateur fonctionne
43 correctement et que son appel se déroule de manière compatible avec son usage
44 dans les algorithmes d'ADAO. De manière pratique, il permet d'appeler une ou
45 plusieurs fois l'opérateur, en activant ou non le mode "debug" lors de
46 l'exécution. Il est très similaire dans son fonctionnement courant à un
47 :ref:`section_ref_algorithm_FunctionTest` mais il teste la stabilité de l'écart
48 mesures-calculs.
49
50 Une statistique sur les vecteurs :math:`\mathbf{x}` en entrée et
51 :math:`\mathbf{y}` en sortie, et potentiellement sur la fonctionnelle d'erreur
52 standard d'assimilation de données :math:`J`, est indiquée lors de chaque
53 exécution de l'opérateur, et une autre statistique globale est fournie de
54 manière récapitulative à la fin. La précision d'affichage est contrôlable pour
55 permettre l'automatisation des tests d'opérateur. Il peut être aussi utile de
56 vérifier préalablement les entrées elles-mêmes avec le test prévu
57 :ref:`section_ref_algorithm_InputValuesTest`.
58
59 .. ------------------------------------ ..
60 .. include:: snippets/Header2Algo12.rst
61
62 .. include:: snippets/FeaturePropDerivativeFree.rst
63
64 .. ------------------------------------ ..
65 .. include:: snippets/Header2Algo02.rst
66
67 .. include:: snippets/CheckingPoint.rst
68
69 .. include:: snippets/BackgroundError.rst
70
71 .. include:: snippets/Observation.rst
72
73 .. include:: snippets/ObservationError.rst
74
75 .. include:: snippets/ObservationOperator.rst
76
77 .. ------------------------------------ ..
78 .. include:: snippets/Header2Algo03Chck.rst
79
80 .. include:: snippets/NumberOfPrintedDigits.rst
81
82 .. include:: snippets/NumberOfRepetition.rst
83
84 .. include:: snippets/SetDebug.rst
85
86 .. include:: snippets/ShowElementarySummary.rst
87
88 StoreSupplementaryCalculations
89   .. index:: single: StoreSupplementaryCalculations
90
91   *Liste de noms*. Cette liste indique les noms des variables supplémentaires,
92   qui peuvent être disponibles au cours du déroulement ou à la fin de
93   l'algorithme, si elles sont initialement demandées par l'utilisateur. Leur
94   disponibilité implique, potentiellement, des calculs ou du stockage coûteux.
95   La valeur par défaut est donc une liste vide, aucune de ces variables n'étant
96   calculée et stockée par défaut (sauf les variables inconditionnelles). Les
97   noms possibles pour les variables supplémentaires sont dans la liste suivante
98   (la description détaillée de chaque variable nommée est donnée dans la suite
99   de cette documentation par algorithme spécifique, dans la sous-partie
100   "*Informations et variables disponibles à la fin de l'algorithme*") : [
101   "CostFunctionJ",
102   "CostFunctionJb",
103   "CostFunctionJo",
104   "CurrentState",
105   "Innovation",
106   "InnovationAtCurrentState",
107   "OMB",
108   "SimulatedObservationAtCurrentState",
109   ].
110
111   Exemple :
112   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
113
114 .. ------------------------------------ ..
115 .. include:: snippets/Header2Algo04.rst
116
117 .. include:: snippets/NoUnconditionalOutput.rst
118
119 .. ------------------------------------ ..
120 .. include:: snippets/Header2Algo05.rst
121
122 .. include:: snippets/CostFunctionJ.rst
123
124 .. include:: snippets/CostFunctionJb.rst
125
126 .. include:: snippets/CostFunctionJo.rst
127
128 .. include:: snippets/CurrentState.rst
129
130 .. include:: snippets/Innovation.rst
131
132 .. include:: snippets/InnovationAtCurrentState.rst
133
134 .. include:: snippets/OMB.rst
135
136 .. include:: snippets/SimulatedObservationAtCurrentState.rst
137
138 .. ------------------------------------ ..
139 .. _section_ref_algorithm_ObservationSimulationComparisonTest_examples:
140
141 .. include:: snippets/Header2Algo09.rst
142
143 .. --------- ..
144 .. include:: scripts/simple_ObservationSimulationComparisonTest1.rst
145
146 .. literalinclude:: scripts/simple_ObservationSimulationComparisonTest1.py
147
148 .. include:: snippets/Header2Algo10.rst
149
150 .. literalinclude:: scripts/simple_ObservationSimulationComparisonTest1.res
151     :language: none
152
153 .. ------------------------------------ ..
154 .. include:: snippets/Header2Algo06.rst
155
156 - :ref:`section_ref_algorithm_FunctionTest`