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