doc/en/ref_algorithm_3DVAR.rst

   1 ..
   2    Copyright (C) 2008-2015 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: 3DVAR
  25 .. _section_ref_algorithm_3DVAR:
  26
  27 Calculation algorithm "*3DVAR*"
  28 -------------------------------
  29
  30 Description
  31 +++++++++++
  32
  33 This algorithm performs a state estimation by variational minimization of the
  34 classical :math:`J` function in static data assimilation:
  35
  36 .. math:: J(\mathbf{x})=(\mathbf{x}-\mathbf{x}^b)^T.\mathbf{B}^{-1}.(\mathbf{x}-\mathbf{x}^b)+(\mathbf{y}^o-\mathbf{H}.\mathbf{x})^T.\mathbf{R}^{-1}.(\mathbf{y}^o-\mathbf{H}.\mathbf{x})
  37
  38 which is usually designed as the "*3D-VAR*" function (see for example
  39 [Talagrand97]_).
  40
  41 Optional and required commands
  42 ++++++++++++++++++++++++++++++
  43
  44 .. index:: single: AlgorithmParameters
  45 .. index:: single: Background
  46 .. index:: single: BackgroundError
  47 .. index:: single: Observation
  48 .. index:: single: ObservationError
  49 .. index:: single: ObservationOperator
  50 .. index:: single: Minimizer
  51 .. index:: single: Bounds
  52 .. index:: single: MaximumNumberOfSteps
  53 .. index:: single: CostDecrementTolerance
  54 .. index:: single: ProjectedGradientTolerance
  55 .. index:: single: GradientNormTolerance
  56 .. index:: single: StoreSupplementaryCalculations
  57 .. index:: single: Quantiles
  58 .. index:: single: SetSeed
  59 .. index:: single: NumberOfSamplesForQuantiles
  60 .. index:: single: SimulationForQuantiles
  61
  62 The general required commands, available in the editing user interface, are the
  63 following:
  64
  65   Background
  66     *Required command*. This indicates the background or initial vector used,
  67     previously noted as :math:`\mathbf{x}^b`. Its value is defined as a
  68     "*Vector*" or a *VectorSerie*" type object.
  69
  70   BackgroundError
  71     *Required command*. This indicates the background error covariance matrix,
  72     previously noted as :math:`\mathbf{B}`. Its value is defined as a "*Matrix*"
  73     type object, a "*ScalarSparseMatrix*" type object, or a
  74     "*DiagonalSparseMatrix*" type object.
  75
  76   Observation
  77     *Required command*. This indicates the observation vector used for data
  78     assimilation or optimization, previously noted as :math:`\mathbf{y}^o`. It
  79     is defined as a "*Vector*" or a *VectorSerie* type object.
  80
  81   ObservationError
  82     *Required command*. This indicates the observation error covariance matrix,
  83     previously noted as :math:`\mathbf{R}`. It is defined as a "*Matrix*" type
  84     object, a "*ScalarSparseMatrix*" type object, or a "*DiagonalSparseMatrix*"
  85     type object.
  86
  87   ObservationOperator
  88     *Required command*. This indicates the observation operator, previously
  89     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
  90     results :math:`\mathbf{y}` to be compared to observations
  91     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
  92     a "*Matrix*" type one. In the case of "*Function*" type, different
  93     functional forms can be used, as described in the section
  94     :ref:`section_ref_operator_requirements`. If there is some control :math:`U`
  95     included in the observation, the operator has to be applied to a pair
  96     :math:`(X,U)`.
  97
  98 The general optional commands, available in the editing user interface, are
  99 indicated in :ref:`section_ref_assimilation_keywords`. Moreover, the parameters
 100 of the command "*AlgorithmParameters*" allows to choose the specific options,
 101 described hereafter, of the algorithm. See
 102 :ref:`section_ref_options_Algorithm_Parameters` for the good use of this
 103 command.
 104
 105 The options of the algorithm are the following:
 106
 107   Minimizer
 108     This key allows to choose the optimization minimizer. The default choice is
 109     "LBFGSB", and the possible ones are "LBFGSB" (nonlinear constrained
 110     minimizer, see [Byrd95]_, [Morales11]_ and [Zhu97]_), "TNC" (nonlinear
 111     constrained minimizer), "CG" (nonlinear unconstrained minimizer), "BFGS"
 112     (nonlinear unconstrained minimizer), "NCG" (Newton CG minimizer). It is
 113     strongly recommended to stay with the default.
 114
 115     Example : ``{"Minimizer":"LBFGSB"}``
 116
 117   Bounds
 118     This key allows to define upper and lower bounds for every state variable
 119     being optimized. Bounds have to be given by a list of list of pairs of
 120     lower/upper bounds for each variable, with possibly ``None`` every time
 121     there is no bound. The bounds can always be specified, but they are taken
 122     into account only by the constrained optimizers.
 123
 124     Example : ``{"Bounds":[[2.,5.],[1.e-2,10.],[-30.,None],[None,None]]}``
 125
 126   MaximumNumberOfSteps
 127     This key indicates the maximum number of iterations allowed for iterative
 128     optimization. The default is 15000, which is very similar to no limit on
 129     iterations. It is then recommended to adapt this parameter to the needs on
 130     real problems. For some optimizers, the effective stopping step can be
 131     slightly different of the limit due to algorithm internal control
 132     requirements.
 133
 134     Example : ``{"MaximumNumberOfSteps":100}``
 135
 136   CostDecrementTolerance
 137     This key indicates a limit value, leading to stop successfully the
 138     iterative optimization process when the cost function decreases less than
 139     this tolerance at the last step. The default is 1.e-7, and it is
 140     recommended to adapt it to the needs on real problems.
 141
 142     Example : ``{"CostDecrementTolerance":1.e-7}``
 143
 144   ProjectedGradientTolerance
 145     This key indicates a limit value, leading to stop successfully the iterative
 146     optimization process when all the components of the projected gradient are
 147     under this limit. It is only used for constrained optimizers. The default is
 148     -1, that is the internal default of each minimizer (generally 1.e-5), and it
 149     is not recommended to change it.
 150
 151     Example : ``{"ProjectedGradientTolerance":-1}``
 152
 153   GradientNormTolerance
 154     This key indicates a limit value, leading to stop successfully the
 155     iterative optimization process when the norm of the gradient is under this
 156     limit. It is only used for non-constrained optimizers.  The default is
 157     1.e-5 and it is not recommended to change it.
 158
 159     Example : ``{"GradientNormTolerance":1.e-5}``
 160
 161   StoreSupplementaryCalculations
 162     This list indicates the names of the supplementary variables that can be
 163     available at the end of the algorithm. It involves potentially costly
 164     calculations or memory consumptions. The default is a void list, none of
 165     these variables being calculated and stored by default. The possible names
 166     are in the following list: ["APosterioriCorrelations",
 167     "APosterioriCovariance", "APosterioriStandardDeviations",
 168     "APosterioriVariances", "BMA", "CostFunctionJ", "CurrentOptimum",
 169     "CurrentState", "IndexOfOptimum", "Innovation", "MahalanobisConsistency",
 170     "OMA", "OMB", "SigmaObs2", "SimulatedObservationAtBackground",
 171     "SimulatedObservationAtCurrentOptimum",
 172     "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum",
 173     "SimulationQuantiles"].
 174
 175     Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 176
 177   Quantiles
 178     This list indicates the values of quantile, between 0 and 1, to be estimated
 179     by simulation around the optimal state. The sampling uses a multivariate
 180     gaussian random sampling, directed by the *a posteriori* covariance matrix.
 181     This option is useful only if the supplementary calculation
 182     "SimulationQuantiles" has been chosen. The default is a void list.
 183
 184     Example : ``{"Quantiles":[0.1,0.9]}``
 185
 186   SetSeed
 187     This key allow to give an integer in order to fix the seed of the random
 188     generator used to generate the ensemble. A convenient value is for example
 189     1000. By default, the seed is left uninitialized, and so use the default
 190     initialization from the computer.
 191
 192     Example : ``{"SetSeed":1000}``
 193
 194   NumberOfSamplesForQuantiles
 195     This key indicates the number of simulation to be done in order to estimate
 196     the quantiles. This option is useful only if the supplementary calculation
 197     "SimulationQuantiles" has been chosen. The default is 100, which is often
 198     sufficient for correct estimation of common quantiles at 5%, 10%, 90% or
 199     95%.
 200
 201     Example : ``{"NumberOfSamplesForQuantiles":100}``
 202
 203   SimulationForQuantiles
 204     This key indicates the type of simulation, linear (with the tangent
 205     observation operator applied to perturbation increments around the optimal
 206     state) or non-linear (with standard observation operator applied to
 207     perturbated states), one want to do for each perturbation. It changes mainly
 208     the time of each elementary calculation, usually longer in non-linear than
 209     in linear. This option is useful only if the supplementary calculation
 210     "SimulationQuantiles" has been chosen. The default value is "Linear", and
 211     the possible choices are "Linear" and "NonLinear".
 212
 213     Example : ``{"SimulationForQuantiles":"Linear"}``
 214
 215 Information and variables available at the end of the algorithm
 216 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 217
 218 At the output, after executing the algorithm, there are variables and
 219 information originating from the calculation. The description of
 220 :ref:`section_ref_output_variables` show the way to obtain them by the method
 221 named ``get`` of the variable "*ADD*" of the post-processing. The input
 222 variables, available to the user at the output in order to facilitate the
 223 writing of post-processing procedures, are described in the
 224 :ref:`subsection_r_o_v_Inventaire`.
 225
 226 The unconditional outputs of the algorithm are the following:
 227
 228   Analysis
 229     *List of vectors*. Each element is an optimal state :math:`\mathbf{x}*` in
 230     optimization or an analysis :math:`\mathbf{x}^a` in data assimilation.
 231
 232     Example : ``Xa = ADD.get("Analysis")[-1]``
 233
 234   CostFunctionJ
 235     *List of values*. Each element is a value of the error function :math:`J`.
 236
 237     Example : ``J = ADD.get("CostFunctionJ")[:]``
 238
 239   CostFunctionJb
 240     *List of values*. Each element is a value of the error function :math:`J^b`,
 241     that is of the background difference part.
 242
 243     Example : ``Jb = ADD.get("CostFunctionJb")[:]``
 244
 245   CostFunctionJo
 246     *List of values*. Each element is a value of the error function :math:`J^o`,
 247     that is of the observation difference part.
 248
 249     Example : ``Jo = ADD.get("CostFunctionJo")[:]``
 250
 251 The conditional outputs of the algorithm are the following:
 252
 253   APosterioriCorrelations
 254     *List of matrices*. Each element is an *a posteriori* error correlations
 255     matrix of the optimal state, coming from the :math:`\mathbf{A}*` covariance
 256     matrix.
 257
 258     Example : ``C = ADD.get("APosterioriCorrelations")[-1]``
 259
 260   APosterioriCovariance
 261     *List of matrices*. Each element is an *a posteriori* error covariance
 262     matrix :math:`\mathbf{A}*` of the optimal state.
 263
 264     Example : ``A = ADD.get("APosterioriCovariance")[-1]``
 265
 266   APosterioriStandardDeviations
 267     *List of matrices*. Each element is an *a posteriori* error standard
 268     errors diagonal matrix of the optimal state, coming from the
 269     :math:`\mathbf{A}*` covariance matrix.
 270
 271     Exemple : ``S = ADD.get("APosterioriStandardDeviations")[-1]``
 272
 273   APosterioriVariances
 274     *List of matrices*. Each element is an *a posteriori* error variance
 275     errors diagonal matrix of the optimal state, coming from the
 276     :math:`\mathbf{A}*` covariance matrix.
 277
 278     Example : ``V = ADD.get("APosterioriVariances")[-1]``
 279
 280   BMA
 281     *List of vectors*. Each element is a vector of difference between the
 282     background and the optimal state.
 283
 284     Example : ``bma = ADD.get("BMA")[-1]``
 285
 286   CurrentOptimum
 287     *List of vectors*. Each element is the optimal state obtained at the current
 288     step of the optimization algorithm. It is not necessarely the last state.
 289
 290     Exemple : ``Xo = ADD.get("CurrentOptimum")[:]``
 291
 292   CurrentState
 293     *List of vectors*. Each element is a usual state vector used during the
 294     optimization algorithm procedure.
 295
 296     Example : ``Xs = ADD.get("CurrentState")[:]``
 297
 298   IndexOfOptimum
 299     *List of integers*. Each element is the iteration index of the optimum
 300     obtained at the current step the optimization algorithm. It is not
 301     necessarely the number of the last iteration.
 302
 303     Exemple : ``i = ADD.get("IndexOfOptimum")[-1]``
 304
 305   Innovation
 306     *List of vectors*. Each element is an innovation vector, which is in static
 307     the difference between the optimal and the background, and in dynamic the
 308     evolution increment.
 309
 310     Example : ``d = ADD.get("Innovation")[-1]``
 311
 312   MahalanobisConsistency
 313     *List of values*. Each element is a value of the Mahalanobis quality
 314     indicator.
 315
 316     Example : ``m = ADD.get("MahalanobisConsistency")[-1]``
 317
 318   OMA
 319     *List of vectors*. Each element is a vector of difference between the
 320     observation and the optimal state in the observation space.
 321
 322     Example : ``oma = ADD.get("OMA")[-1]``
 323
 324   OMB
 325     *List of vectors*. Each element is a vector of difference between the
 326     observation and the background state in the observation space.
 327
 328     Example : ``omb = ADD.get("OMB")[-1]``
 329
 330   SigmaObs2
 331     *List of values*. Each element is a value of the quality indicator
 332     :math:`(\sigma^o)^2` of the observation part.
 333
 334     Example : ``so2 = ADD.get("SigmaObs")[-1]``
 335
 336   SimulatedObservationAtBackground
 337     *List of vectors*. Each element is a vector of observation simulated from
 338     the background :math:`\mathbf{x}^b`.
 339
 340     Example : ``hxb = ADD.get("SimulatedObservationAtBackground")[-1]``
 341
 342   SimulatedObservationAtCurrentOptimum
 343     *List of vectors*. Each element is a vector of observation simulated from
 344     the optimal state obtained at the current step the optimization algorithm,
 345     that is, in the observation space.
 346
 347     Exemple : ``hxo = ADD.get("SimulatedObservationAtCurrentOptimum")[-1]``
 348
 349   SimulatedObservationAtCurrentState
 350     *List of vectors*. Each element is an observed vector at the current state,
 351     that is, in the observation space.
 352
 353     Example : ``hxs = ADD.get("SimulatedObservationAtCurrentState")[-1]``
 354
 355   SimulatedObservationAtOptimum
 356     *List of vectors*. Each element is a vector of observation simulated from
 357     the analysis or optimal state :math:`\mathbf{x}^a`.
 358
 359     Example : ``hxa = ADD.get("SimulatedObservationAtOptimum")[-1]``
 360
 361   SimulationQuantiles
 362     *List of vectors*. Each element is a vector corresponding to the observed
 363     state which realize the required quantile, in the same order than the
 364     quantiles required by the user.
 365
 366     Example : ``sQuantiles = ADD.get("SimulationQuantiles")[:]``
 367
 368 See also
 369 ++++++++
 370
 371 References to other sections:
 372   - :ref:`section_ref_algorithm_Blue`
 373   - :ref:`section_ref_algorithm_ExtendedBlue`
 374   - :ref:`section_ref_algorithm_LinearityTest`
 375
 376 Bibliographical references:
 377   - [Byrd95]_
 378   - [Morales11]_
 379   - [Talagrand97]_