2 Copyright (C) 2008-2019 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: Blue
25 .. _section_ref_algorithm_Blue:
27 Calculation algorithm "*Blue*"
28 ------------------------------
33 This algorithm realizes a BLUE (Best Linear Unbiased Estimator) type estimation
34 of the state of a system. More precisely, it is an Aitken estimator.
36 This algorithm is always the fastest of all the assimilation algorithms of ADAO.
37 It is theoretically reserved for observation operator cases which are linear,
38 even if it sometimes works in "slightly" non-linear cases. One can verify the
39 linearity of the observation operator with the help of the
40 :ref:`section_ref_algorithm_LinearityTest`.
42 In case of non-linearity, even slightly marked, it will be easily preferred the
43 :ref:`section_ref_algorithm_ExtendedBlue` or the
44 :ref:`section_ref_algorithm_3DVAR`.
46 Optional and required commands
47 ++++++++++++++++++++++++++++++
50 The general required commands, available in the editing user interface, are the
53 .. include:: snippets/Background.rst
55 .. include:: snippets/BackgroundError.rst
57 .. include:: snippets/Observation.rst
59 .. include:: snippets/ObservationError.rst
61 .. include:: snippets/ObservationOperator.rst
63 The general optional commands, available in the editing user interface, are
64 indicated in :ref:`section_ref_assimilation_keywords`. Moreover, the parameters
65 of the command "*AlgorithmParameters*" allows to choose the specific options,
66 described hereafter, of the algorithm. See
67 :ref:`section_ref_options_Algorithm_Parameters` for the good use of this
70 The options of the algorithm are the following:
72 StoreSupplementaryCalculations
73 .. index:: single: StoreSupplementaryCalculations
75 This list indicates the names of the supplementary variables that can be
76 available at the end of the algorithm. It involves potentially costly
77 calculations or memory consumptions. The default is a void list, none of
78 these variables being calculated and stored by default. The possible names
79 are in the following list: ["APosterioriCorrelations",
80 "APosterioriCovariance", "APosterioriStandardDeviations",
81 "APosterioriVariances", "BMA", "OMA", "OMB", "CurrentState",
82 "CostFunctionJ", "CostFunctionJb", "CostFunctionJo", "Innovation",
83 "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles",
84 "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
85 "SimulatedObservationAtOptimum"].
88 ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
90 .. include:: snippets/Quantiles.rst
92 .. include:: snippets/SetSeed.rst
94 .. include:: snippets/NumberOfSamplesForQuantiles.rst
96 .. include:: snippets/SimulationForQuantiles.rst
98 Information and variables available at the end of the algorithm
99 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
101 At the output, after executing the algorithm, there are variables and
102 information originating from the calculation. The description of
103 :ref:`section_ref_output_variables` show the way to obtain them by the method
104 named ``get`` of the variable "*ADD*" of the post-processing. The input
105 variables, available to the user at the output in order to facilitate the
106 writing of post-processing procedures, are described in the
107 :ref:`subsection_r_o_v_Inventaire`.
109 The unconditional outputs of the algorithm are the following:
111 .. include:: snippets/Analysis.rst
113 The conditional outputs of the algorithm are the following:
115 .. include:: snippets/APosterioriCorrelations.rst
117 .. include:: snippets/APosterioriCovariance.rst
119 .. include:: snippets/APosterioriStandardDeviations.rst
121 .. include:: snippets/APosterioriVariances.rst
123 .. include:: snippets/BMA.rst
125 .. include:: snippets/CostFunctionJ.rst
127 .. include:: snippets/CostFunctionJb.rst
129 .. include:: snippets/CostFunctionJo.rst
131 .. include:: snippets/Innovation.rst
133 .. include:: snippets/MahalanobisConsistency.rst
135 .. include:: snippets/OMA.rst
137 .. include:: snippets/OMB.rst
139 .. include:: snippets/SigmaBck2.rst
141 .. include:: snippets/SigmaObs2.rst
143 .. include:: snippets/SimulatedObservationAtBackground.rst
145 .. include:: snippets/SimulatedObservationAtOptimum.rst
147 .. include:: snippets/SimulationQuantiles.rst
153 References to other sections:
154 - :ref:`section_ref_algorithm_ExtendedBlue`
155 - :ref:`section_ref_algorithm_3DVAR`
156 - :ref:`section_ref_algorithm_LinearityTest`
158 Bibliographical references: