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: EnsembleBlue
25 .. _section_ref_algorithm_EnsembleBlue:
27 Calculation algorithm "*EnsembleBlue*"
28 --------------------------------------
33 This algorithm realizes a BLUE (Best Linear Unbiased Estimator, which is here an
34 Aitken estimator) type estimation of the state of a system by an ensemble
35 method. To work, one must give a set of backgrounds, their number determining
36 the size of the ensemble for the estimation.
38 It is theoretically reserved for observation operator cases which are linear,
39 but has to work also in "slightly" non-linear cases. One can verify the
40 linearity of the observation operator with the help of the
41 :ref:`section_ref_algorithm_LinearityTest`.
43 Optional and required commands
44 ++++++++++++++++++++++++++++++
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 .. include:: snippets/SetSeed.rst
71 StoreSupplementaryCalculations
72 .. index:: single: StoreSupplementaryCalculations
74 This list indicates the names of the supplementary variables that can be
75 available at the end of the algorithm. It involves potentially costly
76 calculations or memory consumptions. The default is a void list, none of
77 these variables being calculated and stored by default. The possible names
78 are in the following list: ["CurrentState", "Innovation",
79 "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
80 "SimulatedObservationAtOptimum"].
83 ``{"StoreSupplementaryCalculations":["CurrentState", "Innovation"]}``
85 Information and variables available at the end of the algorithm
86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
88 At the output, after executing the algorithm, there are variables and
89 information originating from the calculation. The description of
90 :ref:`section_ref_output_variables` show the way to obtain them by the method
91 named ``get`` of the variable "*ADD*" of the post-processing. The input
92 variables, available to the user at the output in order to facilitate the
93 writing of post-processing procedures, are described in the
94 :ref:`subsection_r_o_v_Inventaire`.
96 The unconditional outputs of the algorithm are the following:
98 .. include:: snippets/Analysis.rst
100 .. include:: snippets/CurrentState.rst
102 .. include:: snippets/Innovation.rst
107 References to other sections:
108 - :ref:`section_ref_algorithm_Blue`