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: ASSIMILATION_STUDY
25 .. _section_ref_assimilation_keywords:
27 List of commands and keywords for an ADAO calculation case
28 ----------------------------------------------------------
30 .. index:: single: Algorithm
31 .. index:: single: AlgorithmParameters
32 .. index:: single: ControlInput
33 .. index:: single: Debug
34 .. index:: single: InputVariables
35 .. index:: single: Observer
36 .. index:: single: Observers
37 .. index:: single: Observer Template
38 .. index:: single: OutputVariables
39 .. index:: single: StudyName
40 .. index:: single: StudyRepertory
41 .. index:: single: UserDataInit
42 .. index:: single: UserPostAnalysis
43 .. index:: single: UserPostAnalysis Template
45 This set of commands is related to the description of a calculation case,
46 that is a *Data Assimilation* procedure or an *Optimization* procedure. The
47 terms are ordered in alphabetical order, except the first, which describes
48 choice between calculation or checking.
50 The different commands are the following:
52 **ASSIMILATION_STUDY**
53 *Required command*. This is the general command describing the data
54 assimilation or optimization case. It hierarchically contains all the other
58 *Required command*. This indicates the data assimilation or optimization
59 algorithm chosen by the keyword "*Algorithm*", and its potential optional
60 parameters. The algorithm choices are available through the GUI. There
61 exists for example "3DVAR", "Blue"... Each algorithm is defined, below, by a
62 specific subsection. Optionally, the command allows also to add some
63 parameters to control the algorithm. Their values are defined either
64 explicitly or in a "*Dict*" type object. See the
65 :ref:`section_ref_options_Algorithm_Parameters` for the detailed use of this
68 .. include:: snippets/Background.rst
70 .. include:: snippets/BackgroundError.rst
73 *Optional command*. This indicates the control vector used to force the
74 evolution model at each step, usually noted as :math:`\mathbf{U}`. Its value
75 is defined as a "*Vector*" or a *VectorSerie* type object. When there is no
76 control, it has to be a void string ''.
79 *Optional command*. This define the level of trace and intermediary debug
80 information. The choices are limited between 0 (for False) and 1 (for
83 .. include:: snippets/EvolutionError.rst
85 .. include:: snippets/EvolutionModel.rst
88 *Optional command*. This command allows to indicates the name and size of
89 physical variables that are bundled together in the state vector. This
90 information is dedicated to data processed inside an algorithm.
92 .. include:: snippets/Observation.rst
94 .. include:: snippets/ObservationError.rst
96 .. include:: snippets/ObservationOperator.rst
99 *Optional command*. This command allows to set internal observers, that are
100 functions linked with a particular variable, which will be executed each
101 time this variable is modified. It is a convenient way to monitor variables
102 of interest during the data assimilation or optimization process, by
103 printing or plotting it, etc. Common templates are provided to help the user
104 to start or to quickly make his case.
107 *Optional command*. This command allows to indicates the name and size of
108 physical variables that are bundled together in the output observation
109 vector. This information is dedicated to data processed inside an algorithm.
112 *Required command*. This is an open string to describe the ADAO study by a
116 *Optional command*. If available, this directory is used as base name for
117 calculation, and used to find all the script files, given by name without
118 path, that can be used to define some other commands by scripts.
121 *Optional command*. This commands allows to initialize some parameters or
122 data automatically before algorithm input processing. It indicates a script
123 file name to be executed before entering in initialization phase of chosen
127 *Optional command*. This commands allows to process some parameters or data
128 automatically after data assimilation or optimization algorithm processing.
129 Its value is defined as a script file or a string, allowing to put
130 post-processing code directly inside the ADAO case. Common templates are
131 provided to help the user to start or to quickly make his case.