doc/en/ref_algorithm_ObserverTest.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: ObserverTest
  25 .. _section_ref_algorithm_ObserverTest:
  26
  27 Checking algorithm "*ObserverTest*"
  28 -----------------------------------
  29
  30 Description
  31 +++++++++++
  32
  33 This algorithm allows to verify an external function, given by the user, used as
  34 an *observer*. This external function can be applied to every of the variables
  35 that can be potentially observed. It is activated only on those who are
  36 explicitly associated with the *observer* in the interface.
  37
  38 Optional and required commands
  39 ++++++++++++++++++++++++++++++
  40
  41 .. index:: single: AlgorithmParameters
  42 .. index:: single: CheckingPoint
  43 .. index:: single: ObservationOperator
  44 .. index:: single: Observers
  45
  46 The general required commands, available in the editing user interface, are the
  47 following:
  48
  49   Observers
  50     *Optional command*. This command allows to set internal observers, that are
  51     functions linked with a particular variable, which will be executed each
  52     time this variable is modified. It is a convenient way to monitor variables
  53     of interest during the data assimilation or optimization process, by
  54     printing or plotting it, etc. Common templates are provided to help the user
  55     to start or to quickly make his case.
  56
  57 The general optional commands, available in the editing user interface, are
  58 indicated in :ref:`section_ref_assimilation_keywords`.
  59
  60 *Tips for this algorithm:*
  61
  62     Because *"CheckingPoint"* and *"ObservationOperator"* are required commands
  63     for ALL checking algorithms in the interface, you have to provide a value
  64     for them, despite the fact that these commands are not required for
  65     *"ObserverTest"*, and will not be used. The easiest way is to give "1" as a
  66     STRING for both, *"ObservationOperator"* having to be of type *Matrix*.