doc/en/ref_algorithm_FunctionTest.rst

   1 ..
   2    Copyright (C) 2008-2019 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: FunctionTest
  25 .. _section_ref_algorithm_FunctionTest:
  26
  27 Checking algorithm "*FunctionTest*"
  28 -----------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  32
  33 This algorithm allows to verify that the observation operator is working
  34 correctly and that its call is compatible with its usage in ADAO algorithms. In
  35 practice, it allows to call one or several times the operator, activating or not
  36 the "debug" mode during execution.
  37
  38 Statistics on input and output vectors for each execution of operator are given,
  39 and an another global statistic is given at the end of the checking algorithm.
  40 The precision of printed outputs can be controlled to facilitate automatic tests
  41 of operator.
  42
  43 .. ------------------------------------ ..
  44 .. include:: snippets/Header2Algo02.rst
  45
  46 .. include:: snippets/CheckingPoint.rst
  47
  48 .. include:: snippets/ObservationOperator.rst
  49
  50 .. ------------------------------------ ..
  51 .. include:: snippets/Header2Algo03Chck.rst
  52
  53 .. include:: snippets/NumberOfPrintedDigits.rst
  54
  55 .. include:: snippets/NumberOfRepetition.rst
  56
  57 .. include:: snippets/SetDebug.rst
  58
  59 StoreSupplementaryCalculations
  60   .. index:: single: StoreSupplementaryCalculations
  61
  62   This list indicates the names of the supplementary variables that can be
  63   available at the end of the algorithm, if they are initially required by the
  64   user. It involves potentially costly calculations or memory consumptions. The
  65   default is a void list, none of these variables being calculated and stored
  66   by default excepted the unconditionnal variables. The possible names are in
  67   the following list: [
  68   "CurrentState",
  69   "SimulatedObservationAtCurrentState",
  70   ].
  71
  72   Example :
  73   ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
  74
  75 .. ------------------------------------ ..
  76 .. include:: snippets/Header2Algo04.rst
  77
  78 *None*
  79
  80 .. ------------------------------------ ..
  81 .. include:: snippets/Header2Algo05.rst
  82
  83 .. include:: snippets/CurrentState.rst
  84
  85 .. include:: snippets/SimulatedObservationAtCurrentState.rst
  86
  87 .. ------------------------------------ ..
  88 .. include:: snippets/Header2Algo06.rst
  89
  90 - :ref:`section_ref_algorithm_LinearityTest`
  91 - :ref:`section_ref_algorithm_ParallelFunctionTest`