doc/en/ref_algorithm_FunctionTest.rst

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