doc/en/ref_algorithm_ControledFunctionTest.rst

   1 ..
   2    Copyright (C) 2008-2024 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: ControledFunctionTest
  25 .. _section_ref_algorithm_ControledFunctionTest:
  26
  27 Checking algorithm "*ControledFunctionTest*"
  28 --------------------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  32
  33 This verification algorithm allows to analyze in a simple way the stability of
  34 an operator :math:`F` during its execution. The operator is any operator, so it
  35 can be the observation operator :math:`\mathcal{H}` as well as the evolution
  36 operator :math:`\mathcal{D}`, as long as it is provided in each case according
  37 to the :ref:`section_ref_operator_requirements`. The operator :math:`F` is
  38 considered as depending on a vector variable :math:`\mathbf{x}` and on a
  39 control vector variable :math:`\mathbf{u}`, the two not necessarily being of
  40 the same size, and returning another vector variable :math:`\mathbf{y}`.
  41
  42 The algorithm verifies that the operator is working correctly and that its call
  43 is compatible with its usage in ADAO algorithms. In practice, it allows to call
  44 one or several times the operator, activating or not the "debug" mode during
  45 execution.
  46
  47 Statistics on :math:`\mathbf{x}` input and :math:`\mathbf{y}` output vectors
  48 are given for each execution of operator, and an another global statistic is
  49 given at the end. The precision of printed outputs can be controlled to
  50 facilitate automatic tests of operator. It may also be useful to check the
  51 entries themselves beforehand with the intended test
  52 :ref:`section_ref_algorithm_InputValuesTest`.
  53
  54 .. ------------------------------------ ..
  55 .. include:: snippets/Header2Algo12.rst
  56
  57 .. include:: snippets/FeaturePropDerivativeFree.rst
  58
  59 .. include:: snippets/FeaturePropParallelFree.rst
  60
  61 .. ------------------------------------ ..
  62 .. include:: snippets/Header2Algo02.rst
  63
  64 .. include:: snippets/CheckingPoint.rst
  65
  66 .. include:: snippets/ObservationOperator.rst
  67
  68 .. include:: snippets/ControlInput.rst
  69
  70 .. ------------------------------------ ..
  71 .. include:: snippets/Header2Algo03Chck.rst
  72
  73 .. include:: snippets/NumberOfPrintedDigits.rst
  74
  75 .. include:: snippets/NumberOfRepetition.rst
  76
  77 .. include:: snippets/SetDebug.rst
  78
  79 .. include:: snippets/ShowElementarySummary.rst
  80
  81 StoreSupplementaryCalculations
  82   .. index:: single: StoreSupplementaryCalculations
  83
  84   *List of names*. This list indicates the names of the supplementary
  85   variables, that can be available during or at the end of the algorithm, if
  86   they are initially required by the user. Their availability involves,
  87   potentially, costly calculations or memory consumptions. The default is then
  88   a void list, none of these variables being calculated and stored by default
  89   (excepted the unconditional variables). The possible names are in the
  90   following list (the detailed description of each named variable is given in
  91   the following part of this specific algorithmic documentation, in the
  92   sub-section "*Information and variables available at the end of the
  93   algorithm*"): [
  94   "CurrentState",
  95   "SimulatedObservationAtCurrentState",
  96   ].
  97
  98   Example :
  99   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
 100
 101 .. ------------------------------------ ..
 102 .. include:: snippets/Header2Algo04.rst
 103
 104 .. include:: snippets/NoUnconditionalOutput.rst
 105
 106 .. ------------------------------------ ..
 107 .. include:: snippets/Header2Algo05.rst
 108
 109 .. include:: snippets/CurrentState.rst
 110
 111 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 112
 113 .. ------------------------------------ ..
 114 .. _section_ref_algorithm_ControledFunctionTest_examples:
 115
 116 .. include:: snippets/Header2Algo09.rst
 117
 118 .. --------- ..
 119 .. include:: scripts/simple_ControledFunctionTest1.rst
 120
 121 .. literalinclude:: scripts/simple_ControledFunctionTest1.py
 122
 123 .. include:: snippets/Header2Algo10.rst
 124
 125 .. literalinclude:: scripts/simple_ControledFunctionTest1.res
 126     :language: none
 127
 128 .. --------- ..
 129 .. include:: scripts/simple_ControledFunctionTest2.rst
 130
 131 .. literalinclude:: scripts/simple_ControledFunctionTest2.py
 132
 133 .. include:: snippets/Header2Algo10.rst
 134
 135 .. literalinclude:: scripts/simple_ControledFunctionTest2.res
 136     :language: none
 137
 138 .. ------------------------------------ ..
 139 .. include:: snippets/Header2Algo06.rst
 140
 141 - :ref:`section_ref_algorithm_InputValuesTest`
 142 - :ref:`section_ref_algorithm_LinearityTest`
 143 - :ref:`section_ref_algorithm_FunctionTest`
 144 - :ref:`section_ref_algorithm_ParallelFunctionTest`