doc/en/ref_algorithm_EnsembleBlue.rst

   1 ..
   2    Copyright (C) 2008-2023 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 .. index:: single: EnsembleBlue
  25 .. _section_ref_algorithm_EnsembleBlue:
  26
  27 Calculation algorithm "*EnsembleBlue*"
  28 --------------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  32
  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.
  37
  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`.
  42
  43 .. ------------------------------------ ..
  44 .. include:: snippets/Header2Algo02.rst
  45
  46 .. include:: snippets/Background.rst
  47
  48 .. include:: snippets/BackgroundError.rst
  49
  50 .. include:: snippets/Observation.rst
  51
  52 .. include:: snippets/ObservationError.rst
  53
  54 .. include:: snippets/ObservationOperator.rst
  55
  56 .. ------------------------------------ ..
  57 .. include:: snippets/Header2Algo03AdOp.rst
  58
  59 .. include:: snippets/SetSeed.rst
  60
  61 StoreSupplementaryCalculations
  62   .. index:: single: StoreSupplementaryCalculations
  63
  64   *List of names*. This list indicates the names of the supplementary
  65   variables, that can be available during or at the end of the algorithm, if
  66   they are initially required by the user. Their avalability involves,
  67   potentially, costly calculations or memory consumptions. The default is then
  68   a void list, none of these variables being calculated and stored by default
  69   (excepted the unconditionnal variables). The possible names are in the
  70   following list (the detailed description of each named variable is given in
  71   the following part of this specific algorithmic documentation, in the
  72   sub-section "*Information and variables available at the end of the
  73   algorithm*"): [
  74   "Analysis",
  75   "CurrentOptimum",
  76   "CurrentState",
  77   "Innovation",
  78   "SimulatedObservationAtBackground",
  79   "SimulatedObservationAtCurrentState",
  80   "SimulatedObservationAtOptimum",
  81   ].
  82
  83   Example :
  84   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
  85
  86 .. ------------------------------------ ..
  87 .. include:: snippets/Header2Algo04.rst
  88
  89 .. include:: snippets/Analysis.rst
  90
  91 .. include:: snippets/CurrentState.rst
  92
  93 .. include:: snippets/Innovation.rst
  94
  95 .. ------------------------------------ ..
  96 .. include:: snippets/Header2Algo05.rst
  97
  98 .. include:: snippets/Analysis.rst
  99
 100 .. include:: snippets/CurrentOptimum.rst
 101
 102 .. include:: snippets/CurrentState.rst
 103
 104 .. include:: snippets/Innovation.rst
 105
 106 .. include:: snippets/SimulatedObservationAtBackground.rst
 107
 108 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 109
 110 .. include:: snippets/SimulatedObservationAtOptimum.rst
 111
 112 .. ------------------------------------ ..
 113 .. _section_ref_algorithm_EnsembleBlue_examples:
 114 .. include:: snippets/Header2Algo06.rst
 115
 116 - :ref:`section_ref_algorithm_Blue`
 117 - :ref:`section_ref_algorithm_EnsembleKalmanFilter`