2 Copyright (C) 2008-2023 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: 4DVAR
25 .. index:: single: 4D-Var
26 .. _section_ref_algorithm_4DVAR:
28 Calculation algorithm "*4DVAR*"
29 -------------------------------
31 .. ------------------------------------ ..
32 .. include:: snippets/Header2Algo01.rst
34 This algorithm realizes an estimation of the state of a dynamic system, by a
35 variational minimization method of the classical :math:`J` function in data
38 .. math:: J(\mathbf{x})=(\mathbf{x}-\mathbf{x}^b)^T.\mathbf{B}^{-1}.(\mathbf{x}-\mathbf{x}^b)+\sum_{t\in T}(\mathbf{y^o}(t)-H(\mathbf{x},t))^T.\mathbf{R}^{-1}.(\mathbf{y^o}(t)-H(\mathbf{x},t))
40 which is usually designed as the "*4D-Var*" functional (see for example
41 [Talagrand97]_). The terms "*4D-Var*", "*4D-VAR*" and "*4DVAR*" are equivalent.
42 It is well suited in cases of non-linear observation and evolution operators,
43 its application domain is similar to the one of Kalman filters, specially the
44 :ref:`section_ref_algorithm_ExtendedKalmanFilter` or the
45 :ref:`section_ref_algorithm_UnscentedKalmanFilter`.
47 .. ------------------------------------ ..
48 .. include:: snippets/Header2Algo02.rst
50 .. include:: snippets/Background.rst
52 .. include:: snippets/BackgroundError.rst
54 .. include:: snippets/EvolutionError.rst
56 .. include:: snippets/EvolutionModel.rst
58 .. include:: snippets/Observation.rst
60 .. include:: snippets/ObservationError.rst
62 .. include:: snippets/ObservationOperator.rst
64 .. ------------------------------------ ..
65 .. include:: snippets/Header2Algo03AdOp.rst
67 .. include:: snippets/BoundsWithNone.rst
69 .. include:: snippets/ConstrainedBy.rst
71 .. include:: snippets/CostDecrementTolerance.rst
73 .. include:: snippets/EstimationOf_State.rst
75 .. include:: snippets/GradientNormTolerance.rst
77 .. include:: snippets/InitializationPoint.rst
79 .. include:: snippets/MaximumNumberOfIterations.rst
81 .. include:: snippets/Minimizer_xDVAR.rst
83 .. include:: snippets/ProjectedGradientTolerance.rst
85 StoreSupplementaryCalculations
86 .. index:: single: StoreSupplementaryCalculations
88 *List of names*. This list indicates the names of the supplementary
89 variables, that can be available during or at the end of the algorithm, if
90 they are initially required by the user. Their avalability involves,
91 potentially, costly calculations or memory consumptions. The default is then
92 a void list, none of these variables being calculated and stored by default
93 (excepted the unconditionnal variables). The possible names are in the
94 following list (the detailed description of each named variable is given in
95 the following part of this specific algorithmic documentation, in the
96 sub-section "*Information and variables available at the end of the
101 "CostFunctionJAtCurrentOptimum",
103 "CostFunctionJbAtCurrentOptimum",
105 "CostFunctionJoAtCurrentOptimum",
106 "CurrentIterationNumber",
113 ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
115 .. ------------------------------------ ..
116 .. include:: snippets/Header2Algo04.rst
118 .. include:: snippets/Analysis.rst
120 .. include:: snippets/CostFunctionJ.rst
122 .. include:: snippets/CostFunctionJb.rst
124 .. include:: snippets/CostFunctionJo.rst
126 .. ------------------------------------ ..
127 .. include:: snippets/Header2Algo05.rst
129 .. include:: snippets/Analysis.rst
131 .. include:: snippets/BMA.rst
133 .. include:: snippets/CostFunctionJ.rst
135 .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
137 .. include:: snippets/CostFunctionJb.rst
139 .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
141 .. include:: snippets/CostFunctionJo.rst
143 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
145 .. include:: snippets/CurrentIterationNumber.rst
147 .. include:: snippets/CurrentOptimum.rst
149 .. include:: snippets/CurrentState.rst
151 .. include:: snippets/IndexOfOptimum.rst
153 .. ------------------------------------ ..
154 .. _section_ref_algorithm_4DVAR_examples:
155 .. include:: snippets/Header2Algo06.rst
157 - :ref:`section_ref_algorithm_3DVAR`
158 - :ref:`section_ref_algorithm_KalmanFilter`
159 - :ref:`section_ref_algorithm_ExtendedKalmanFilter`
160 - :ref:`section_ref_algorithm_EnsembleKalmanFilter`
162 .. ------------------------------------ ..
163 .. include:: snippets/Header2Algo07.rst