..
- Copyright (C) 2008-2018 EDF R&D
+ Copyright (C) 2008-2021 EDF R&D
This file is part of SALOME ADAO module.
Algorithme de vérification "*AdjointTest*"
------------------------------------------
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
Cet algorithme permet de vérifier la qualité de l'opérateur adjoint, en
calculant un résidu dont les propriétés théoriques sont connues.
qui doit rester constamment égal à zéro à la précision du calcul. On prend
:math:`\mathbf{dx}_0=Normal(0,\mathbf{x})` et
:math:`\mathbf{dx}=\alpha*\mathbf{dx}_0`. :math:`F` est le code de calcul.
-:math:`\mathbf{y}` doit être dans l'image de :math:`F`. S'il n'est pas donné, on
-prend :math:`\mathbf{y} = F(\mathbf{x})`.
+:math:`\mathbf{y}` doit être dans l'image de :math:`F`. S'il n'est pas donné,
+on prend :math:`\mathbf{y} = F(\mathbf{x})`.
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/CheckingPoint.rst
- .. include:: snippets/CheckingPoint.rst
+.. include:: snippets/ObservationOperator.rst
- .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03Chck.rst
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_checking_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/AmplitudeOfInitialDirection.rst
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/EpsilonMinimumExponent.rst
- .. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/InitialDirection.rst
- .. include:: snippets/EpsilonMinimumExponent.rst
+.. include:: snippets/SetSeed.rst
- .. include:: snippets/InitialDirection.rst
+StoreSupplementaryCalculations
+ .. index:: single: StoreSupplementaryCalculations
- .. include:: snippets/SetSeed.rst
+ *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 : [
+ "CurrentState",
+ "Residu",
+ "SimulatedObservationAtCurrentState",
+ ].
- StoreSupplementaryCalculations
- .. index:: single: StoreSupplementaryCalculations
+ Exemple :
+ ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
- 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 : ["CurrentState", "Residu",
- "SimulatedObservationAtCurrentState"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
- Exemple :
- ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+.. include:: snippets/Residu.rst
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.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/CurrentState.rst
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/Residu.rst
- .. include:: snippets/Residu.rst
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
- .. include:: snippets/CurrentState.rst
-
- .. include:: snippets/SimulatedObservationAtCurrentState.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
- - :ref:`section_ref_algorithm_FunctionTest`
- - :ref:`section_ref_algorithm_LinearityTest`
- - :ref:`section_ref_algorithm_TangentTest`
- - :ref:`section_ref_algorithm_GradientTest`
+- :ref:`section_ref_algorithm_FunctionTest`
+- :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_TangentTest`
+- :ref:`section_ref_algorithm_GradientTest`
+- :ref:`section_ref_algorithm_LocalSensitivityTest`
