doc/en/ref_algorithm_FunctionTest.rst

   1 ..
   2    Copyright (C) 2008-2018 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 Description
  31 +++++++++++
  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 Optional and required commands
  44 ++++++++++++++++++++++++++++++
  45
  46 The general required commands, available in the editing user interface, are the
  47 following:
  48
  49   .. include:: snippets/CheckingPoint.rst
  50
  51   .. include:: snippets/ObservationOperator.rst
  52
  53 The general optional commands, available in the editing user interface, are
  54 indicated in :ref:`section_ref_assimilation_keywords`. Moreover, the parameters
  55 of the command "*AlgorithmParameters*" allow to choose the specific options,
  56 described hereafter, of the algorithm. See
  57 :ref:`section_ref_options_Algorithm_Parameters` for the good use of this
  58 command.
  59
  60 The options of the algorithm are the following:
  61
  62   .. include:: snippets/NumberOfPrintedDigits.rst
  63
  64   .. include:: snippets/NumberOfRepetition.rst
  65
  66   .. include:: snippets/SetDebug.rst
  67
  68   StoreSupplementaryCalculations
  69     .. index:: single: StoreSupplementaryCalculations
  70
  71     This list indicates the names of the supplementary variables that can be
  72     available at the end of the algorithm. It involves potentially costly
  73     calculations or memory consumptions. The default is a void list, none of
  74     these variables being calculated and stored by default. The possible names
  75     are in the following list: ["CurrentState",
  76     "SimulatedObservationAtCurrentState"].
  77
  78     Example :
  79     ``{"StoreSupplementaryCalculations":["CurrentState"]}``
  80
  81 Information and variables available at the end of the algorithm
  82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  83
  84 At the output, after executing the algorithm, there are variables and
  85 information originating from the calculation. The description of
  86 :ref:`section_ref_output_variables` show the way to obtain them by the method
  87 named ``get`` of the variable "*ADD*" of the post-processing. The input
  88 variables, available to the user at the output in order to facilitate the
  89 writing of post-processing procedures, are described in the
  90 :ref:`subsection_r_o_v_Inventaire`.
  91
  92 The conditional outputs of the algorithm are the following:
  93
  94   .. include:: snippets/CurrentState.rst
  95
  96   .. include:: snippets/SimulatedObservationAtCurrentState.rst
  97
  98 See also
  99 ++++++++
 100
 101 References to other sections:
 102   - :ref:`section_ref_algorithm_LinearityTest`