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: FunctionTest
25 .. _section_ref_algorithm_FunctionTest:
27 Checking algorithm "*FunctionTest*"
28 -----------------------------------
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
33 This algorithm allows to analyze in a simple way the stability of an operator
34 :math:`F` during its execution. The operator is any operator, so it can be the
35 observation operator :math:`\mathcal{H}` as well as the evolution operator
36 :math:`\mathcal{D}`, as long as it is provided in each case according to the
37 :ref:`section_ref_operator_requirements`. The operator :math:`F` is considered
38 as depending on a vector variable :math:`\mathbf{x}` and returning another
39 vector variable :math:`\mathbf{y}`.
41 The algorithm verifies that the operator is working correctly and that its call
42 is compatible with its usage in ADAO algorithms. In practice, it allows to call
43 one or several times the operator, activating or not the "debug" mode during
46 Statistics on :math:`\mathbf{x}` input and :math:`\mathbf{y}` output vectors
47 are given for each execution of operator, and an another global statistic is
48 given at the end. The precision of printed outputs can be controlled to
49 facilitate automatic tests of operator. It may also be useful to check the
50 entries themselves beforehand with the intended test
51 :ref:`section_ref_algorithm_InputValuesTest`.
53 .. ------------------------------------ ..
54 .. include:: snippets/Header2Algo12.rst
56 .. include:: snippets/FeaturePropDerivativeFree.rst
58 .. include:: snippets/FeaturePropParallelFree.rst
60 .. ------------------------------------ ..
61 .. include:: snippets/Header2Algo02.rst
63 .. include:: snippets/CheckingPoint.rst
65 .. include:: snippets/ObservationOperator.rst
67 .. ------------------------------------ ..
68 .. include:: snippets/Header2Algo03Chck.rst
70 .. include:: snippets/NumberOfPrintedDigits.rst
72 .. include:: snippets/NumberOfRepetition.rst
74 .. include:: snippets/SetDebug.rst
76 .. include:: snippets/ShowElementarySummary.rst
78 StoreSupplementaryCalculations
79 .. index:: single: StoreSupplementaryCalculations
81 *List of names*. This list indicates the names of the supplementary
82 variables, that can be available during or at the end of the algorithm, if
83 they are initially required by the user. Their availability involves,
84 potentially, costly calculations or memory consumptions. The default is then
85 a void list, none of these variables being calculated and stored by default
86 (excepted the unconditional variables). The possible names are in the
87 following list (the detailed description of each named variable is given in
88 the following part of this specific algorithmic documentation, in the
89 sub-section "*Information and variables available at the end of the
92 "SimulatedObservationAtCurrentState",
96 ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
98 .. ------------------------------------ ..
99 .. include:: snippets/Header2Algo04.rst
101 .. include:: snippets/NoUnconditionalOutput.rst
103 .. ------------------------------------ ..
104 .. include:: snippets/Header2Algo05.rst
106 .. include:: snippets/CurrentState.rst
108 .. include:: snippets/SimulatedObservationAtCurrentState.rst
110 .. ------------------------------------ ..
111 .. _section_ref_algorithm_FunctionTest_examples:
113 .. include:: snippets/Header2Algo09.rst
116 .. include:: scripts/simple_FunctionTest1.rst
118 .. literalinclude:: scripts/simple_FunctionTest1.py
120 .. include:: snippets/Header2Algo10.rst
122 .. literalinclude:: scripts/simple_FunctionTest1.res
126 .. include:: scripts/simple_FunctionTest2.rst
128 .. literalinclude:: scripts/simple_FunctionTest2.py
130 .. include:: snippets/Header2Algo10.rst
132 .. literalinclude:: scripts/simple_FunctionTest2.res
135 .. ------------------------------------ ..
136 .. include:: snippets/Header2Algo06.rst
138 - :ref:`section_ref_algorithm_InputValuesTest`
139 - :ref:`section_ref_algorithm_LinearityTest`
140 - :ref:`section_ref_algorithm_ControledFunctionTest`
141 - :ref:`section_ref_algorithm_ParallelFunctionTest`
142 - :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`
143 - :ref:`section_ref_algorithm_ObservationSimulationComparisonTest`