2 Copyright (C) 2008-2018 EDF R&D
4 This file is part of SALOME ADAO module.
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.
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.
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
20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
24 .. index:: single: CHECKING_STUDY
25 .. _section_ref_checking_keywords:
27 List of commands and keywords for an ADAO checking case
28 -------------------------------------------------------
30 .. index:: single: Algorithm
31 .. index:: single: AlgorithmParameters
32 .. index:: single: Debug
33 .. index:: single: Observer
34 .. index:: single: Observers
35 .. index:: single: Observer Template
36 .. index:: single: StudyName
37 .. index:: single: StudyRepertory
38 .. index:: single: UserDataInit
40 This set of commands is related to the description of a checking case, that is a
41 procedure to check required properties on information, used somewhere else by a
42 calculation case. The terms are ordered in alphabetical order, except the first,
43 which describes the choice between calculation or checking.
45 The different commands are the following:
48 *Required command*. This is the general command describing the checking
49 case. It hierarchically contains all the other commands.
52 *Required command*. This indicates the checking algorithm chosen by the
53 keyword "*Algorithm*", and its potential optional parameters. The algorithm
54 choices are available through the GUI. There exists for example
55 "FunctionTest", "GradientTest"... Each algorithm is defined, below, by a
56 specific subsection. Optionaly, the command allows also to add some
57 parameters to control the algorithm. Their values are defined either
58 explicitly or in a "*Dict*" type object. See the
59 :ref:`section_ref_options_Algorithm_Parameters` for the detailed use of this
62 .. include:: snippets/CheckingPoint.rst
64 .. include:: snippets/BackgroundError.rst
67 *Optional command*. This define the level of trace and intermediary debug
68 information. The choices are limited between 0 (for False) and 1 (for
71 .. include:: snippets/Observation.rst
73 .. include:: snippets/ObservationError.rst
75 .. include:: snippets/ObservationOperator.rst
78 *Optional command*. This command allows to set internal observers, that are
79 functions linked with a particular variable, which will be executed each
80 time this variable is modified. It is a convenient way to monitor variables
81 of interest during the data assimilation or optimization process, by
82 printing or plotting it, etc. Common templates are provided to help the user
83 to start or to quickly make his case.
86 *Required command*. This is an open string to describe the ADAO study by a
90 *Optional command*. If available, this directory is used as base name for
91 calculation, and used to find all the script files, given by name without
92 path, that can be used to define some other commands by scripts.
95 *Optional command*. This commands allows to initialize some parameters or
96 data automatically before algorithm input processing. It indicates a script
97 file name to be executed before entering in initialization phase of chosen