Code and documentation update for ControledFunctionTest

[modules/adao.git] / doc / fr / ref_algorithm_ParallelFunctionTest.rst

diff --git a/doc/fr/ref_algorithm_ParallelFunctionTest.rst b/doc/fr/ref_algorithm_ParallelFunctionTest.rst
index 7e9b1d5c0dd1c373e441e5004092b64f700cc706..89af1e6d301b663f00b9ea079414ae01f0b42ff7 100644 (file)
--- a/doc/fr/ref_algorithm_ParallelFunctionTest.rst
+++ b/doc/fr/ref_algorithm_ParallelFunctionTest.rst
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2019 EDF R&D
+   Copyright (C) 2008-2023 EDF R&D
 
    This file is part of SALOME ADAO module.
 
@@ -30,17 +30,19 @@ Algorithme de vérification "*ParallelFunctionTest*"
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo01.rst
 
-Cet algorithme permet de vérifier que l'opérateur d'observation fonctionne
-correctement en parallèle et que son appel se déroule de manière compatible
-avec son usage dans les algorithmes d'ADAO. De manière pratique, il permet
-d'appeler une ou plusieurs fois l'opérateur en parallèle, en activant ou non le
-mode "debug" lors de l'exécution.
+Cet algorithme permet de vérifier qu'un opérateur :math:`F` quelconque, dont en
+particulier celui d'observation, fonctionne correctement en parallèle et que
+son appel se déroule de manière compatible avec son usage dans les algorithmes
+d'ADAO. De manière pratique, il permet d'appeler une ou plusieurs fois
+l'opérateur en parallèle, en activant ou non le mode "debug" lors de
+l'exécution.
 
 Une statistique sur les vecteurs en entrée et en sortie de chaque exécution de
 l'opérateur est indiquée, et une autre globale est fournie de manière
 récapitulative à la fin de l'algorithme de vérification. La précision
 d'affichage est contrôlable pour permettre l'automatisation des tests
-d'opérateur.
+d'opérateur. Il peut être aussi utile de vérifier préalablement les entrées
+elles-mêmes avec le test prévu :ref:`section_ref_algorithm_InputValuesTest`.
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo02.rst
@@ -58,26 +60,32 @@ d'opérateur.
 
 .. include:: snippets/SetDebug.rst
 
+.. include:: snippets/ShowElementarySummary.rst
+
 StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
-  Cette liste indique les noms des variables supplémentaires qui peuvent être
-  disponibles à la fin de l'algorithme, si elles sont initialement demandées par
-  l'utilisateur. Cela implique potentiellement des calculs ou du stockage
-  coûteux. La valeur par défaut est une liste vide, aucune de ces variables
-  n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
-  Les noms possibles sont dans la liste suivante : [
+  *Liste de noms*. Cette liste indique les noms des variables supplémentaires,
+  qui peuvent être disponibles au cours du déroulement ou à la fin de
+  l'algorithme, si elles sont initialement demandées par l'utilisateur. Leur
+  disponibilité implique, potentiellement, des calculs ou du stockage coûteux.
+  La valeur par défaut est donc une liste vide, aucune de ces variables n'étant
+  calculée et stockée par défaut (sauf les variables inconditionnelles). Les
+  noms possibles pour les variables supplémentaires sont dans la liste suivante
+  (la description détaillée de chaque variable nommée est donnée dans la suite
+  de cette documentation par algorithme spécifique, dans la sous-partie
+  "*Informations et variables disponibles à la fin de l'algorithme*") : [
   "CurrentState",
   "SimulatedObservationAtCurrentState",
   ].
 
   Exemple :
-  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
 
-*Aucune*
+.. include:: snippets/NoUnconditionalOutput.rst
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo05.rst
@@ -86,8 +94,25 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 
+.. ------------------------------------ ..
+.. _section_ref_algorithm_ParallelFunctionTest_examples:
+
+.. include:: snippets/Header2Algo09.rst
+
+.. include:: scripts/simple_ParallelFunctionTest.rst
+
+.. literalinclude:: scripts/simple_ParallelFunctionTest.py
+
+.. include:: snippets/Header2Algo10.rst
+
+.. literalinclude:: scripts/simple_ParallelFunctionTest.res
+    :language: none
+
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo06.rst
 
-- :ref:`section_ref_algorithm_FunctionTest`
+- :ref:`section_ref_algorithm_InputValuesTest`
 - :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_FunctionTest`
+- :ref:`section_ref_algorithm_ControledFunctionTest`
+- :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`