..
- Copyright (C) 2008-2018 EDF R&D
+ Copyright (C) 2008-2021 EDF R&D
This file is part of SALOME ADAO module.
Algorithme de calcul "*LinearLeastSquares*"
-------------------------------------------
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
Cet algorithme réalise une estimation linéaire de type "Moindres Carrés"
pondérés. Il est similaire à l':ref:`section_ref_algorithm_Blue`
Cet algorithme est toujours le plus rapide de l'ensemble des algorithmes
d'optimisation d'ADAO. Il est théoriquement réservé aux cas d'opérateurs
-d'observation linéaires, même s'il fonctionne parfois dans les cas "faiblement"
-non-linéaire. On peut vérifier la linéarité de l'opérateur d'observation à
-l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
+d'observation explicitement linéaires, même s'il fonctionne parfois dans les
+cas "faiblement" non-linéaire. On peut vérifier la linéarité de l'opérateur
+d'observation à l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
Dans tous les cas, il est recommandé de lui préférer au minimum
l':ref:`section_ref_algorithm_Blue`, voire
l':ref:`section_ref_algorithm_ExtendedBlue` ou
l':ref:`section_ref_algorithm_3DVAR`.
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
+
+.. include:: snippets/Observation.rst
+
+.. include:: snippets/ObservationError.rst
+
+.. include:: snippets/ObservationOperator.rst
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
+
+StoreSupplementaryCalculations
+ .. index:: single: StoreSupplementaryCalculations
+
+ *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",
+ "CostFunctionJ",
+ "CostFunctionJAtCurrentOptimum",
+ "CostFunctionJb",
+ "CostFunctionJbAtCurrentOptimum",
+ "CostFunctionJo",
+ "CostFunctionJoAtCurrentOptimum",
+ "CurrentOptimum",
+ "CurrentState",
+ "OMA",
+ "SimulatedObservationAtCurrentOptimum",
+ "SimulatedObservationAtCurrentState",
+ "SimulatedObservationAtOptimum",
+ ].
+
+ Exemple :
+ ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+*Astuce pour cet algorithme :*
- .. include:: snippets/Observation.rst
+ Comme les commandes *"Background"* et *"BackgroundError"* sont requises
+ pour TOUS les algorithmes de calcul dans l'interface graphique, vous devez
+ fournir une valeur, malgré le fait que ces commandes ne soient pas
+ nécessaires pour cet algorithme, et ne sont donc pas utilisées. La manière
+ la plus simple est de donner "1" comme un STRING pour les deux.
- .. include:: snippets/ObservationError.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
- .. include:: snippets/ObservationOperator.rst
+.. include:: snippets/Analysis.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/CostFunctionJ.rst
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/CostFunctionJb.rst
- StoreSupplementaryCalculations
- .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/CostFunctionJo.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 : ["OMA", "CurrentState",
- "CostFunctionJ", "CostFunctionJb", "CostFunctionJo",
- "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
- Exemple :
- ``{"StoreSupplementaryCalculations":["OMA", "CurrentState"]}``
+.. include:: snippets/Analysis.rst
-*Astuce pour cet algorithme :*
+.. include:: snippets/CostFunctionJ.rst
- Comme les commandes *"Background"* et *"BackgroundError"* sont requises
- pour TOUS les algorithmes de calcul dans l'interface graphique, vous devez
- fournir une valeur, malgré le fait que ces commandes ne sont pas requises
- pour cet algorithme, et ne seront pas utilisées. La manière la plus simple
- est de donner "1" comme un STRING pour les deux.
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. include:: snippets/CostFunctionJb.rst
-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`.
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/CostFunctionJo.rst
- .. include:: snippets/Analysis.rst
+.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
- .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/CurrentOptimum.rst
- .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CurrentState.rst
- .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/OMA.rst
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
- .. include:: snippets/OMA.rst
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
- .. include:: snippets/SimulatedObservationAtOptimum.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
-Voir aussi
-++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
-Références vers d'autres sections :
- - :ref:`section_ref_algorithm_Blue`
- - :ref:`section_ref_algorithm_ExtendedBlue`
- - :ref:`section_ref_algorithm_3DVAR`
- - :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_Blue`
+- :ref:`section_ref_algorithm_ExtendedBlue`
+- :ref:`section_ref_algorithm_3DVAR`
+- :ref:`section_ref_algorithm_LinearityTest`
