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