doc/en/ref_algorithm_Blue.rst

   1 ..
   2    Copyright (C) 2008-2014 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: Blue
  25 .. _section_ref_algorithm_Blue:
  26
  27 Calculation algorithm "*Blue*"
  28 ------------------------------
  29
  30 Description
  31 +++++++++++
  32
  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.
  35
  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`.
  41
  42 In case of non-linearity, even slightly marked, it will be easily prefered the
  43 :ref:`section_ref_algorithm_ExtendedBlue` or the
  44 :ref:`section_ref_algorithm_3DVAR`.
  45
  46 Optional and required commands
  47 ++++++++++++++++++++++++++++++
  48
  49 .. index:: single: Background
  50 .. index:: single: BackgroundError
  51 .. index:: single: Observation
  52 .. index:: single: ObservationError
  53 .. index:: single: ObservationOperator
  54 .. index:: single: StoreInternalVariables
  55 .. index:: single: StoreSupplementaryCalculations
  56
  57 The general required commands, available in the editing user interface, are the
  58 following:
  59
  60   Background
  61     *Required command*. This indicates the background or initial vector used,
  62     previously noted as :math:`\mathbf{x}^b`. Its value is defined as a
  63     "*Vector*" or a *VectorSerie*" type object.
  64
  65   BackgroundError
  66     *Required command*. This indicates the background error covariance matrix,
  67     previously noted as :math:`\mathbf{B}`. Its value is defined as a "*Matrix*"
  68     type object, a "*ScalarSparseMatrix*" type object, or a
  69     "*DiagonalSparseMatrix*" type object.
  70
  71   Observation
  72     *Required command*. This indicates the observation vector used for data
  73     assimilation or optimization, previously noted as :math:`\mathbf{y}^o`. It
  74     is defined as a "*Vector*" or a *VectorSerie* type object.
  75
  76   ObservationError
  77     *Required command*. This indicates the observation error covariance matrix,
  78     previously noted as :math:`\mathbf{R}`. It is defined as a "*Matrix*" type
  79     object, a "*ScalarSparseMatrix*" type object, or a "*DiagonalSparseMatrix*"
  80     type object.
  81
  82   ObservationOperator
  83     *Required command*. This indicates the observation operator, previously
  84     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
  85     results :math:`\mathbf{y}` to be compared to observations
  86     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
  87     a "*Matrix*" type one. In the case of "*Function*" type, different
  88     functional forms can be used, as described in the section
  89     :ref:`section_ref_operator_requirements`. If there is some control :math:`U`
  90     included in the observation, the operator has to be applied to a pair
  91     :math:`(X,U)`.
  92
  93 The general optional commands, available in the editing user interface, are
  94 indicated in :ref:`section_ref_assimilation_keywords`. In particular, the
  95 optional command "*AlgorithmParameters*" allows to choose the specific options,
  96 described hereafter, of the algorithm. See
  97 :ref:`section_ref_options_AlgorithmParameters` for the good use of this command.
  98
  99 The options of the algorithm are the following:
 100
 101   StoreInternalVariables
 102     This Boolean key allows to store default internal variables, mainly the
 103     current state during iterative optimization process. Be careful, this can be
 104     a numerically costly choice in certain calculation cases. The default is
 105     "False".
 106
 107   StoreSupplementaryCalculations
 108     This list indicates the names of the supplementary variables that can be
 109     available at the end of the algorithm. It involves potentially costly
 110     calculations or memory consumptions. The default is a void list, none of
 111     these variables being calculated and stored by default. The possible names
 112     are in the following list: ["APosterioriCovariance", "BMA", "OMA", "OMB",
 113     "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency"].
 114
 115 See also
 116 ++++++++
 117
 118 References to other sections:
 119   - :ref:`section_ref_algorithm_ExtendedBlue`
 120   - :ref:`section_ref_algorithm_3DVAR`
 121   - :ref:`section_ref_algorithm_LinearityTest`
 122
 123 Bibliographical references:
 124   - [Bouttier99]_