Salome HOME
Documentation improvements and post analysis
[modules/adao.git] / doc / fr / ref_algorithm_3DVAR.rst
index bb53d388a09cb3381eb8cddab14825f1a23a0a65..faf5b493b2255d340d762745be747b09048297ec 100644 (file)
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2018 EDF R&D
+   Copyright (C) 2008-2021 EDF R&D
 
    This file is part of SALOME ADAO module.
 
    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
 
 .. index:: single: 3DVAR
+.. index:: single: 3D-Var
 .. _section_ref_algorithm_3DVAR:
 
 Algorithme de calcul "*3DVAR*"
 ------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation d'état par minimisation variationnelle de
 la fonctionnelle :math:`J` d'écart classique en assimilation de données
@@ -36,165 +37,222 @@ statique:
 
 .. math:: J(\mathbf{x})=(\mathbf{x}-\mathbf{x}^b)^T.\mathbf{B}^{-1}.(\mathbf{x}-\mathbf{x}^b)+(\mathbf{y}^o-H(\mathbf{x}))^T.\mathbf{R}^{-1}.(\mathbf{y}^o-H(\mathbf{x}))
 
-qui est usuellement désignée comme la fonctionnelle "*3D-VAR*" (voir par exemple
-[Talagrand97]_).
+qui est usuellement désignée comme la fonctionnelle "*3D-Var*" (voir par
+exemple [Talagrand97]_). Les dénominations "*3D-Var*", "*3D-VAR*" et "*3DVAR*"
+sont équivalentes.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+Il existe diverses variantes de cet algorithme. On propose ici les formulations
+stables et robustes suivantes :
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. index::
+    pair: Variant ; 3DVAR
+    pair: Variant ; 3DVAR-VAN
+    pair: Variant ; 3DVAR-Incr
+    pair: Variant ; 3DVAR-PSAS
 
-  .. include:: snippets/Background.rst
+- "3DVAR" (3D Variational analysis, voir [Lorenc86]_, [LeDimet86]_, [Talagrand97]_), algorithme classique d'origine, très robuste, opérant dans l'espace du modèle,
+- "3DVAR-VAN" (3D Variational Analysis with No inversion of B, voir [Lorenc88]_), algorithme similaire, opérant dans l'espace du modèle, mais permettant d'éviter l'inversion de la matrice de covariance B,
+- "3DVAR-Incr" (Incremental 3DVAR, voir [Courtier94]_), algorithme plus économique que les précédents, mais impliquant une approximation des opérateurs non-linéaires,
+- "3DVAR-PSAS" (Physical-space Statistical Analysis Scheme for 3DVAR, voir [Courtier97]_, [Cohn98]_), algorithme parfois plus économique car opérant dans l'espace des observations, mais impliquant une approximation des opérateurs non-linéaires.
 
-  .. include:: snippets/BackgroundError.rst
+On recommande fortement d'utiliser le "3DVAR" d'origine. Les algorithmes
+"3DVAR" et "3DVAR-Incr" (et pas les autres) permettent la modification du point
+initial de leur minimisation, mais ce n'est pas recommandé.
 
-  .. include:: snippets/Observation.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. include:: snippets/BackgroundError.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/Observation.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/ObservationError.rst
 
-  Minimizer
-    .. index:: single: Minimizer
+.. include:: snippets/ObservationOperator.rst
 
-    Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
-    défaut est "LBFGSB", et les choix possibles sont "LBFGSB" (minimisation non
-    linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
-    (minimisation non linéaire sous contraintes), "CG" (minimisation non
-    linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
-    contraintes), "NCG" (minimisation de type gradient conjugué de Newton). Il
-    est fortement conseillé de conserver la valeur par défaut.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-    Exemple :
-    ``{"Minimizer":"LBFGSB"}``
+.. include:: snippets/BoundsWithNone.rst
 
-  .. include:: snippets/BoundsWithNone.rst
+.. include:: snippets/CostDecrementTolerance.rst
 
-  .. include:: snippets/MaximumNumberOfSteps.rst
+.. include:: snippets/GradientNormTolerance.rst
 
-  .. include:: snippets/CostDecrementTolerance.rst
+.. include:: snippets/InitializationPoint.rst
 
-  .. include:: snippets/ProjectedGradientTolerance.rst
+.. include:: snippets/MaximumNumberOfSteps.rst
 
-  .. include:: snippets/GradientNormTolerance.rst
+.. include:: snippets/Minimizer_xDVAR.rst
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/NumberOfSamplesForQuantiles.rst
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["APosterioriCorrelations",
-    "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "CostFunctionJ", "CostFunctionJb",
-    "CostFunctionJo", "CostFunctionJAtCurrentOptimum",
-    "CostFunctionJbAtCurrentOptimum", "CostFunctionJoAtCurrentOptimum",
-    "CurrentOptimum", "CurrentState", "IndexOfOptimum", "Innovation",
-    "InnovationAtCurrentState", "MahalanobisConsistency", "OMA", "OMB",
-    "SigmaObs2", "SimulatedObservationAtBackground",
-    "SimulatedObservationAtCurrentOptimum",
-    "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum",
-    "SimulationQuantiles"].
+.. include:: snippets/ProjectedGradientTolerance.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+.. include:: snippets/Quantiles.rst
 
-  .. include:: snippets/Quantiles.rst
+.. include:: snippets/SetSeed.rst
 
-  .. include:: snippets/SetSeed.rst
+.. include:: snippets/SimulationForQuantiles.rst
 
-  .. include:: snippets/NumberOfSamplesForQuantiles.rst
+.. include:: snippets/StateBoundsForQuantilesWithNone.rst
 
-  .. include:: snippets/SimulationForQuantiles.rst
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+  *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+  qui peuvent être disponibles au cours du déroulement ou à la fin de
+  l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+  implique potentiellement des calculs ou du stockage coûteux. La valeur par
+  défaut est une liste vide, aucune de ces variables n'étant calculée et
+  stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+  sont dans la liste suivante : [
+  "Analysis",
+  "APosterioriCorrelations",
+  "APosterioriCovariance",
+  "APosterioriStandardDeviations",
+  "APosterioriVariances",
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
+  "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentIterationNumber",
+  "CurrentOptimum",
+  "CurrentState",
+  "ForecastState",
+  "IndexOfOptimum",
+  "Innovation",
+  "InnovationAtCurrentState",
+  "JacobianMatrixAtBackground",
+  "JacobianMatrixAtOptimum",
+  "KalmanGainAtOptimum",
+  "MahalanobisConsistency",
+  "OMA",
+  "OMB",
+  "SampledStateForQuantiles",
+  "SigmaObs2",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  "SimulationQuantiles",
+  ].
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/Variant_3DVAR.rst
 
-  .. include:: snippets/Analysis.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/CostFunctionJb.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/APosterioriCorrelations.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-  .. include:: snippets/APosterioriCovariance.rst
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/APosterioriStandardDeviations.rst
+.. include:: snippets/APosterioriCorrelations.rst
 
-  .. include:: snippets/APosterioriVariances.rst
+.. include:: snippets/APosterioriCovariance.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/APosterioriStandardDeviations.rst
 
-  .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
+.. include:: snippets/APosterioriVariances.rst
 
-  .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/CurrentOptimum.rst
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
 
-  .. include:: snippets/CurrentState.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/IndexOfOptimum.rst
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
 
-  .. include:: snippets/Innovation.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/InnovationAtCurrentState.rst
+.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-  .. include:: snippets/MahalanobisConsistency.rst
+.. include:: snippets/CurrentIterationNumber.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/CurrentOptimum.rst
 
-  .. include:: snippets/OMB.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/SigmaObs2.rst
+.. include:: snippets/ForecastState.rst
 
-  .. include:: snippets/SimulatedObservationAtBackground.rst
+.. include:: snippets/IndexOfOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
+.. include:: snippets/InnovationAtCurrentState.rst
 
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
+.. include:: snippets/JacobianMatrixAtBackground.rst
 
-  .. include:: snippets/SimulationQuantiles.rst
+.. include:: snippets/JacobianMatrixAtOptimum.rst
 
-Voir aussi
-++++++++++
+.. include:: snippets/KalmanGainAtOptimum.rst
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_Blue`
-  - :ref:`section_ref_algorithm_ExtendedBlue`
-  - :ref:`section_ref_algorithm_LinearityTest`
+.. include:: snippets/MahalanobisConsistency.rst
 
-Références bibliographiques :
-  - [Byrd95]_
-  - [Morales11]_
-  - [Talagrand97]_
-  - [Zhu97]_
+.. include:: snippets/OMA.rst
+
+.. include:: snippets/OMB.rst
+
+.. include:: snippets/SampledStateForQuantiles.rst
+
+.. include:: snippets/SigmaObs2.rst
+
+.. include:: snippets/SimulatedObservationAtBackground.rst
+
+.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
+
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
+
+.. include:: snippets/SimulatedObservationAtOptimum.rst
+
+.. include:: snippets/SimulationQuantiles.rst
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo09.rst
+
+.. include:: scripts/simple_3DVAR.rst
+
+.. literalinclude:: scripts/simple_3DVAR.py
+
+.. include:: snippets/Header2Algo10.rst
+
+.. literalinclude:: scripts/simple_3DVAR.res
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
+
+- :ref:`section_ref_algorithm_Blue`
+- :ref:`section_ref_algorithm_ExtendedBlue`
+- :ref:`section_ref_algorithm_LinearityTest`
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
+
+- [Byrd95]_
+- [Cohn98]_
+- [Courtier94]_
+- [LeDimet86]_
+- [Lorenc86]_
+- [Lorenc88]_
+- [Morales11]_
+- [Talagrand97]_
+- [Zhu97]_