2 Copyright (C) 2008-2018 EDF R&D
4 This file is part of SALOME ADAO module.
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.
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.
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
20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
24 .. index:: single: AdjointTest
25 .. _section_ref_algorithm_AdjointTest:
27 Checking algorithm "*AdjointTest*"
28 ----------------------------------
33 This algorithm allows to check the quality of the adjoint operator, by
34 calculating a residue with known theoretical properties.
36 One can observe the following residue, which is the difference of two scalar
39 .. math:: R(\alpha) = | < TangentF_x(\mathbf{dx}) , \mathbf{y} > - < \mathbf{dx} , AdjointF_x(\mathbf{y}) > |
41 that has to remain equal to zero at the calculation precision. One take
42 :math:`\mathbf{dx}_0=Normal(0,\mathbf{x})` and
43 :math:`\mathbf{dx}=\alpha*\mathbf{dx}_0`. :math:`F` is the calculation code.
44 :math:`\mathbf{y}` has to be in the image of :math:`F`. If it is not given, one
45 take :math:`\mathbf{y} = F(\mathbf{x})`.
47 Optional and required commands
48 ++++++++++++++++++++++++++++++
51 The general required commands, available in the editing user interface, are the
54 .. include:: snippets/CheckingPoint.rst
56 .. include:: snippets/ObservationOperator.rst
58 The general optional commands, available in the editing user interface, are
59 indicated in :ref:`section_ref_assimilation_keywords`. Moreover, the parameters
60 of the command "*AlgorithmParameters*" allow to choose the specific options,
61 described hereafter, of the algorithm. See
62 :ref:`section_ref_options_Algorithm_Parameters` for the good use of this
65 The options of the algorithm are the following:
67 .. include:: snippets/AmplitudeOfInitialDirection.rst
69 .. include:: snippets/EpsilonMinimumExponent.rst
71 .. include:: snippets/InitialDirection.rst
73 .. include:: snippets/SetSeed.rst
75 StoreSupplementaryCalculations
76 .. index:: single: StoreSupplementaryCalculations
78 This list indicates the names of the supplementary variables that can be
79 available at the end of the algorithm. It involves potentially costly
80 calculations or memory consumptions. The default is a void list, none of
81 these variables being calculated and stored by default. The possible names
82 are in the following list: ["CurrentState", "Residu",
83 "SimulatedObservationAtCurrentState"].
86 ``{"StoreSupplementaryCalculations":["CurrentState"]}``
88 Information and variables available at the end of the algorithm
89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
91 At the output, after executing the algorithm, there are variables and
92 information originating from the calculation. The description of
93 :ref:`section_ref_output_variables` show the way to obtain them by the method
94 named ``get`` of the variable "*ADD*" of the post-processing. The input
95 variables, available to the user at the output in order to facilitate the
96 writing of post-processing procedures, are described in the
97 :ref:`subsection_r_o_v_Inventaire`.
99 The unconditional outputs of the algorithm are the following:
101 .. include:: snippets/Residu.rst
103 The conditional outputs of the algorithm are the following:
105 .. include:: snippets/CurrentState.rst
107 .. include:: snippets/SimulatedObservationAtCurrentState.rst
112 References to other sections:
113 - :ref:`section_ref_algorithm_FunctionTest`
114 - :ref:`section_ref_algorithm_LinearityTest`
115 - :ref:`section_ref_algorithm_TangentTest`
116 - :ref:`section_ref_algorithm_GradientTest`