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