2 Copyright (C) 2008-2024 EDF R&D
4 This file is part of SALOME ADAO module.
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.
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.
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
20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
24 .. index:: single: ControledFunctionTest
25 .. _section_ref_algorithm_ControledFunctionTest:
27 Algorithme de vérification "*ControledFunctionTest*"
28 ----------------------------------------------------
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
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}`.
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.
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`.
55 .. ------------------------------------ ..
56 .. include:: snippets/Header2Algo12.rst
58 .. include:: snippets/FeaturePropDerivativeFree.rst
60 .. include:: snippets/FeaturePropParallelFree.rst
62 .. ------------------------------------ ..
63 .. include:: snippets/Header2Algo02.rst
65 .. include:: snippets/CheckingPoint.rst
67 .. include:: snippets/ObservationOperator.rst
69 .. include:: snippets/ControlInput.rst
71 .. ------------------------------------ ..
72 .. include:: snippets/Header2Algo03Chck.rst
74 .. include:: snippets/NumberOfPrintedDigits.rst
76 .. include:: snippets/NumberOfRepetition.rst
78 .. include:: snippets/SetDebug.rst
80 .. include:: snippets/ShowElementarySummary.rst
82 StoreSupplementaryCalculations
83 .. index:: single: StoreSupplementaryCalculations
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*") : [
96 "SimulatedObservationAtCurrentState",
100 ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
102 .. ------------------------------------ ..
103 .. include:: snippets/Header2Algo04.rst
105 .. include:: snippets/NoUnconditionalOutput.rst
107 .. ------------------------------------ ..
108 .. include:: snippets/Header2Algo05.rst
110 .. include:: snippets/CurrentState.rst
112 .. include:: snippets/SimulatedObservationAtCurrentState.rst
114 .. ------------------------------------ ..
115 .. _section_ref_algorithm_ControledFunctionTest_examples:
117 .. include:: snippets/Header2Algo09.rst
120 .. include:: scripts/simple_ControledFunctionTest1.rst
122 .. literalinclude:: scripts/simple_ControledFunctionTest1.py
124 .. include:: snippets/Header2Algo10.rst
126 .. literalinclude:: scripts/simple_ControledFunctionTest1.res
130 .. include:: scripts/simple_ControledFunctionTest2.rst
132 .. literalinclude:: scripts/simple_ControledFunctionTest2.py
134 .. include:: snippets/Header2Algo10.rst
136 .. literalinclude:: scripts/simple_ControledFunctionTest2.res
139 .. ------------------------------------ ..
140 .. include:: snippets/Header2Algo06.rst
142 - :ref:`section_ref_algorithm_InputValuesTest`
143 - :ref:`section_ref_algorithm_LinearityTest`
144 - :ref:`section_ref_algorithm_FunctionTest`
145 - :ref:`section_ref_algorithm_ParallelFunctionTest`