doc/en/ref_algorithm_ObserverTest.rst

   1 ..
   2    Copyright (C) 2008-2024 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 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  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 each of the variables
  35 that can be potentially observed. It is activated only on those who are
  36 explicitly associated with the *observer* in its declaration.
  37
  38 .. ------------------------------------ ..
  39 .. include:: snippets/Header2Algo12.rst
  40
  41 .. include:: snippets/FeaturePropDerivativeFree.rst
  42
  43 .. ------------------------------------ ..
  44 .. include:: snippets/Header2Algo02.rst
  45
  46 .. include:: snippets/Observers.rst
  47
  48 The general optional commands, available in the editing user interface, are
  49 indicated in :ref:`section_ref_assimilation_keywords`.
  50
  51 *Tips for this algorithm:*
  52
  53     Because *"CheckingPoint"* and *"ObservationOperator"*, in the graphical
  54     interface, are required commands for ALL checking algorithms, you have to
  55     provide a value for them, despite the fact that these commands are not
  56     required for this test, and will not be used. The easiest way is to give
  57     "1" as a STRING for both, *"ObservationOperator"* having to be of type
  58     sparse *Matrix*.