Salome HOME
Adding sampling test algorithm
[modules/adao.git] / doc / fr / ref_algorithm_ObserverTest.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: ObserverTest
25 .. _section_ref_algorithm_ObserverTest:
26
27 Algorithme de vérification "*ObserverTest*"
28 -------------------------------------------
29
30 Description
31 +++++++++++
32
33 Cet algorithme permet de vérifier une fonction externe et fournie par
34 l'utilisateur, utilisée comme un *observer*. Cette fonction externe peut être
35 appliquée à chacune des variables potentiellement observables. Elle n'est
36 activée que sur celles qui sont explicitement associées avec l'*observer* dans
37 l'interface.
38
39 Commandes requises et optionnelles
40 ++++++++++++++++++++++++++++++++++
41
42 .. index:: single: CheckingPoint
43 .. index:: single: ObservationOperator
44 .. index:: single: Observers
45
46 Les commandes requises générales, disponibles dans l'interface en édition, sont
47 les suivantes:
48
49   Observers  
50     *Commande obligatoire*. Elle permet de définir des observateurs internes,
51     qui sont des fonctions liées à une variable particulière, qui sont exécutées
52     chaque fois que cette variable est modifiée. C'est une manière pratique de
53     suivre des variables d'intérêt durant le processus d'assimilation de données
54     ou d'optimisation, en l'affichant ou en la traçant, etc. Des exemples
55     courants (squelettes) sont fournis pour aider l'utilisateur ou pour
56     faciliter l'élaboration d'un cas.
57
58 Les commandes optionnelles générales, disponibles dans l'interface en édition,
59 sont indiquées dans la :ref:`section_ref_checking_keywords`.
60     
61 *Astuce pour cet algorithme :*
62
63     Comme les commandes *"CheckingPoint"* et *"ObservationOperator"* sont
64     requises pour TOUS les algorithmes de vérification dans l'interface, vous
65     devez fournir une valeur, malgré le fait que ces commandes ne sont pas
66     requises pour *"ObserverTest"*, et ne seront pas utilisées. La manière la
67     plus simple est de donner "1" comme un STRING pour les deux,
68     l'*"ObservationOperator"* devant être de type *Matrix*.