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: ExtendedBlue
25 .. _section_ref_algorithm_ExtendedBlue:
27 Calculation algorithm "*ExtendedBlue*"
28 --------------------------------------
33 This algorithm realizes an extended BLUE (Best Linear Unbiased Estimator) type
34 estimation of the state of a system.
36 This algorithm is a partially non-linear generalization of the
37 :ref:`section_ref_algorithm_Blue`. It is equivalent for a linear observation
38 operator. One can verify the linearity of the observation operator with the help
39 of the :ref:`section_ref_algorithm_LinearityTest`.
41 In case of non-linearity, it is close to the :ref:`section_ref_algorithm_3DVAR`,
42 without being entirely equivalent.
44 Optional and required commands
45 ++++++++++++++++++++++++++++++
47 The general required commands, available in the editing user interface, are the
50 .. include:: snippets/Background.rst
52 .. include:: snippets/BackgroundError.rst
54 .. include:: snippets/Observation.rst
56 .. include:: snippets/ObservationError.rst
58 .. include:: snippets/ObservationOperator.rst
60 The general optional commands, available in the editing user interface, are
61 indicated in :ref:`section_ref_assimilation_keywords`. Moreover, the parameters
62 of the command "*AlgorithmParameters*" allows to choose the specific options,
63 described hereafter, of the algorithm. See
64 :ref:`section_ref_options_Algorithm_Parameters` for the good use of this
67 The options of the algorithm are the following:
69 StoreSupplementaryCalculations
70 .. index:: single: StoreSupplementaryCalculations
72 This list indicates the names of the supplementary variables that can be
73 available at the end of the algorithm. It involves potentially costly
74 calculations or memory consumptions. The default is a void list, none of
75 these variables being calculated and stored by default. The possible names
76 are in the following list: ["APosterioriCorrelations",
77 "APosterioriCovariance", "APosterioriStandardDeviations",
78 "APosterioriVariances", "BMA", "OMA", "OMB", "CurrentState",
79 "CostFunctionJ", "CostFunctionJb", "CostFunctionJo", "Innovation",
80 "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles",
81 "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
82 "SimulatedObservationAtOptimum"].
85 ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
87 .. include:: snippets/Quantiles.rst
89 .. include:: snippets/SetSeed.rst
91 .. include:: snippets/NumberOfSamplesForQuantiles.rst
93 .. include:: snippets/SimulationForQuantiles.rst
95 Information and variables available at the end of the algorithm
96 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
98 At the output, after executing the algorithm, there are variables and
99 information originating from the calculation. The description of
100 :ref:`section_ref_output_variables` show the way to obtain them by the method
101 named ``get`` of the variable "*ADD*" of the post-processing. The input
102 variables, available to the user at the output in order to facilitate the
103 writing of post-processing procedures, are described in the
104 :ref:`subsection_r_o_v_Inventaire`.
106 The unconditional outputs of the algorithm are the following:
108 .. include:: snippets/Analysis.rst
110 The conditional outputs of the algorithm are the following:
112 .. include:: snippets/APosterioriCorrelations.rst
114 .. include:: snippets/APosterioriCovariance.rst
116 .. include:: snippets/APosterioriStandardDeviations.rst
118 .. include:: snippets/APosterioriVariances.rst
120 .. include:: snippets/BMA.rst
122 .. include:: snippets/CostFunctionJ.rst
124 .. include:: snippets/CostFunctionJb.rst
126 .. include:: snippets/CostFunctionJo.rst
128 .. include:: snippets/Innovation.rst
130 .. include:: snippets/MahalanobisConsistency.rst
132 .. include:: snippets/OMA.rst
134 .. include:: snippets/OMB.rst
136 .. include:: snippets/SigmaBck2.rst
138 .. include:: snippets/SigmaObs2.rst
140 .. include:: snippets/SimulatedObservationAtBackground.rst
142 .. include:: snippets/SimulatedObservationAtOptimum.rst
144 .. include:: snippets/SimulationQuantiles.rst
149 References to other sections:
150 - :ref:`section_ref_algorithm_Blue`
151 - :ref:`section_ref_algorithm_3DVAR`
152 - :ref:`section_ref_algorithm_LinearityTest`