doc/en/ref_algorithm_FunctionTest.rst

   1 ..
   2    Copyright (C) 2008-2014 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 .. index:: single: CheckingPoint
  47 .. index:: single: ObservationOperator
  48 .. index:: single: NumberOfPrintedDigits
  49 .. index:: single: NumberOfRepetition
  50 .. index:: single: SetDebug
  51
  52 The general required commands, available in the editing user interface, are the
  53 following:
  54
  55   CheckingPoint
  56     *Required command*. This indicates the vector used as the state around which
  57     to perform the required check, noted :math:`\mathbf{x}` and similar to the
  58     background :math:`\mathbf{x}^b`. It is defined as a "*Vector*" type object.
  59
  60   ObservationOperator
  61     *Required command*. This indicates the observation operator, previously
  62     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
  63     results :math:`\mathbf{y}` to be compared to observations
  64     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
  65     a "*Matrix*" type one. In the case of "*Function*" type, different
  66     functional forms can be used, as described in the section
  67     :ref:`section_ref_operator_requirements`. If there is some control :math:`U`
  68     included in the observation, the operator has to be applied to a pair
  69     :math:`(X,U)`.
  70
  71 The general optional commands, available in the editing user interface, are
  72 indicated in :ref:`section_ref_assimilation_keywords`. In particular, the
  73 optional command "*AlgorithmParameters*" allows to choose the specific options,
  74 described hereafter, of the algorithm. See
  75 :ref:`section_ref_options_AlgorithmParameters` for the good use of this command.
  76
  77 The options of the algorithm are the following:
  78
  79   NumberOfPrintedDigits
  80     This key indicates the number of digits of precision for floating point
  81     printed output. The default is 5, with a minimum of 0.
  82
  83     Example : ``{"NumberOfPrintedDigits":5}``
  84
  85   NumberOfRepetition
  86     This key indicates the number of time to repeat the function evaluation. The
  87     default is 1.
  88
  89     Example : ``{"NumberOfRepetition":3}``
  90
  91   SetDebug
  92     This key requires the activation, or not, of the debug mode during the
  93     function evaluation. The default is "True", the choices are "True" or
  94     "False".
  95
  96     Example : ``{"SetDebug":False}``
  97
  98 See also
  99 ++++++++
 100
 101 References to other sections:
 102   - :ref:`section_ref_algorithm_LinearityTest`