2 Copyright (C) 2008-2023 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 verify that a given operator :math:`F`, in particular
34 the observation one, is working correctly and that its call is compatible with
35 its usage in ADAO algorithms. In practice, it allows to call one or several
36 times the operator, activating or not the "debug" mode during execution.
38 Statistics on input and output vectors for each execution of operator are
39 given, and an another global statistic is given at the end of the checking
40 algorithm. The precision of printed outputs can be controlled to facilitate
41 automatic tests of operator. It may also be useful to check the entries
42 themselves beforehand with the intended test
43 :ref:`section_ref_algorithm_InputValuesTest`.
45 .. ------------------------------------ ..
46 .. include:: snippets/Header2Algo02.rst
48 .. include:: snippets/CheckingPoint.rst
50 .. include:: snippets/ObservationOperator.rst
52 .. ------------------------------------ ..
53 .. include:: snippets/Header2Algo03Chck.rst
55 .. include:: snippets/NumberOfPrintedDigits.rst
57 .. include:: snippets/NumberOfRepetition.rst
59 .. include:: snippets/SetDebug.rst
61 .. include:: snippets/ShowElementarySummary.rst
63 StoreSupplementaryCalculations
64 .. index:: single: StoreSupplementaryCalculations
66 *List of names*. This list indicates the names of the supplementary
67 variables, that can be available during or at the end of the algorithm, if
68 they are initially required by the user. Their avalability involves,
69 potentially, costly calculations or memory consumptions. The default is then
70 a void list, none of these variables being calculated and stored by default
71 (excepted the unconditionnal variables). The possible names are in the
72 following list (the detailed description of each named variable is given in
73 the following part of this specific algorithmic documentation, in the
74 sub-section "*Information and variables available at the end of the
77 "SimulatedObservationAtCurrentState",
81 ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
83 .. ------------------------------------ ..
84 .. include:: snippets/Header2Algo04.rst
86 .. include:: snippets/NoUnconditionalOutput.rst
88 .. ------------------------------------ ..
89 .. include:: snippets/Header2Algo05.rst
91 .. include:: snippets/CurrentState.rst
93 .. include:: snippets/SimulatedObservationAtCurrentState.rst
95 .. ------------------------------------ ..
96 .. _section_ref_algorithm_FunctionTest_examples:
98 .. include:: snippets/Header2Algo09.rst
101 .. include:: scripts/simple_FunctionTest1.rst
103 .. literalinclude:: scripts/simple_FunctionTest1.py
105 .. include:: snippets/Header2Algo10.rst
107 .. literalinclude:: scripts/simple_FunctionTest1.res
111 .. include:: scripts/simple_FunctionTest2.rst
113 .. literalinclude:: scripts/simple_FunctionTest2.py
115 .. include:: snippets/Header2Algo10.rst
117 .. literalinclude:: scripts/simple_FunctionTest2.res
120 .. ------------------------------------ ..
121 .. include:: snippets/Header2Algo06.rst
123 - :ref:`section_ref_algorithm_InputValuesTest`
124 - :ref:`section_ref_algorithm_LinearityTest`
125 - :ref:`section_ref_algorithm_ParallelFunctionTest`
126 - :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`