Salome HOME
Adding multi-functions input capabilities (2)
[modules/adao.git] / doc / en / glossary.rst
1 ..
2    Copyright (C) 2008-2018 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 .. _section_glossary:
25
26 Glossary
27 ========
28
29 .. glossary::
30    :sorted:
31
32    case
33       One ADAO case is defined by a set of data and of choices, packed together
34       through the user interface of the module. The data are physical
35       measurements that have technically to be available before or during the
36       case execution. The simulation code(s) and the data assimilation or
37       optimization method, and their parameters, has to be chosen, they define
38       the execution properties of the case.
39
40    iteration
41       One iteration occurs when using iterative optimizers (e.g. 3DVAR), and it
42       is entirely hidden in the main YACS OptimizerLoop Node named
43       "*compute_bloc*". Nevertheless, the user can watch the iterative process
44       through the "*YACS Container Log*" window, which is updated during the
45       process, and using "*Observers*" attached to calculation variables.
46
47    APosterioriCovariance
48       Keyword to indicate the covariance matrix of *a posteriori* analysis
49       errors.
50
51    APosterioriCorrelations
52       Keyword to indicate the correlation matrix of *a posteriori* analysis
53       errors.
54
55    APosterioriVariances
56       Keyword to indicate the variances diagonal matrix of *a posteriori*
57       analysis errors.
58
59    APosterioriStandardDeviations
60       Keyword to indicate the standard errors diagonal matrix of *a posteriori*
61       analysis errors.
62
63    BMA (Background minus Analysis)
64       Difference between the background state and the optimal state estimation,
65       noted as :math:`\mathbf{x}^b - \mathbf{x}^a`.
66
67    OMA (Observation minus Analysis)
68       Difference between the observations and the result of the simulation based
69       on the optimal state estimation, the analysis, filtered to be compatible
70       with the observation, noted as :math:`\mathbf{y}^o -
71       \mathbf{H}\mathbf{x}^a`.
72
73    OMB (Observation minus Background)
74       Difference between the observations and the result of the simulation based
75       on the background state, filtered to be compatible with the observation,
76       noted as :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^b`.
77
78    SigmaBck2
79       Keyword to indicate the Desroziers-Ivanov parameter measuring the
80       background part consistency of the data assimilation optimal state
81       estimation. Its value can be compared to 1, a "good" estimation leading to
82       a parameter "close" to 1.
83
84    SigmaObs2
85       Keyword to indicate the Desroziers-Ivanov parameter measuring the
86       observation part consistency of the data assimilation optimal state
87       estimation. Its value can be compared to 1, a "good" estimation leading to
88       a parameter "close" to 1.
89
90    MahalanobisConsistency
91       Keyword to indicate the Mahalanobis parameter measuring the consistency of
92       the data assimilation optimal state estimation. Its value can be compared
93       to 1, a "good" estimation leading to a parameter "close" to 1.
94
95    analysis
96       The optimal state estimation through a data assimilation or optimization
97       procedure.
98
99    background
100       The *a priori* known state, which is not optimal, and is used as a rough
101       estimate, or a "best estimate", before an optimal estimation.
102
103    innovation
104       Difference between the observations and the result of the simulation based
105       on the background state, filtered to be compatible with the observation.
106       It is similar with OMB in static cases.
107
108    CostFunctionJ
109       Keyword to indicate the minimization function, noted as :math:`J`.
110
111    CostFunctionJo
112       Keyword to indicate the observation part of the minimization function,
113       noted as :math:`J^o`.
114
115    CostFunctionJb
116       Keyword to indicate the background part of the minimization function,
117       noted as :math:`J^b`.
118
119    CurrentState
120       Keyword to indicate the current state used during an optimization
121       algorithm procedure.