doc/en/ref_algorithm_TangentTest.rst

   1 ..
   2    Copyright (C) 2008-2023 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: TangentTest
  25 .. _section_ref_algorithm_TangentTest:
  26
  27 Checking algorithm "*TangentTest*"
  28 ----------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  32
  33 This algorithm allows to check the quality of the tangent operator, by
  34 calculating a residue with known theoretical properties.
  35
  36 One can observe the following residue, which is the comparison of increments
  37 using the tangent linear operator:
  38
  39 .. math:: R(\alpha) = \frac{|| F(\mathbf{x}+\alpha*\mathbf{dx}) - F(\mathbf{x}) ||}{|| \alpha * TangentF_x * \mathbf{dx} ||}
  40
  41 which has to remain stable in :math:`1+O(\alpha)` until the calculation
  42 precision is reached.
  43
  44 When :math:`|R-1|/\alpha` is less or equal to a stable value when :math:`\alpha`
  45 is varying, the tangent is valid, until the calculation precision is reached.
  46
  47 If :math:`|R-1|/\alpha` is really small, the calculation code :math:`F` is
  48 almost linear or quasi-linear (which can be verified by the
  49 :ref:`section_ref_algorithm_LinearityTest`), and the tangent is valid until the
  50 calculation precision is reached.
  51
  52 One take :math:`\mathbf{dx}_0=Normal(0,\mathbf{x})` and
  53 :math:`\mathbf{dx}=\alpha*\mathbf{dx}_0`. :math:`F` is the calculation code.
  54
  55 .. ------------------------------------ ..
  56 .. include:: snippets/Header2Algo02.rst
  57
  58 .. include:: snippets/CheckingPoint.rst
  59
  60 .. include:: snippets/ObservationOperator.rst
  61
  62 .. ------------------------------------ ..
  63 .. include:: snippets/Header2Algo03Chck.rst
  64
  65 .. include:: snippets/AmplitudeOfInitialDirection.rst
  66
  67 .. include:: snippets/AmplitudeOfTangentPerturbation.rst
  68
  69 .. include:: snippets/EpsilonMinimumExponent.rst
  70
  71 .. include:: snippets/InitialDirection.rst
  72
  73 .. include:: snippets/SetSeed.rst
  74
  75 StoreSupplementaryCalculations
  76   .. index:: single: StoreSupplementaryCalculations
  77
  78   *List of names*. This list indicates the names of the supplementary
  79   variables, that can be available during or at the end of the algorithm, if
  80   they are initially required by the user. Their avalability involves,
  81   potentially, costly calculations or memory consumptions. The default is then
  82   a void list, none of these variables being calculated and stored by default
  83   (excepted the unconditionnal variables). The possible names are in the
  84   following list (the detailed description of each named variable is given in
  85   the following part of this specific algorithmic documentation, in the
  86   sub-section "*Information and variables available at the end of the
  87   algorithm*"): [
  88   "CurrentState",
  89   "Residu",
  90   "SimulatedObservationAtCurrentState",
  91   ].
  92
  93   Example :
  94   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
  95
  96 .. ------------------------------------ ..
  97 .. include:: snippets/Header2Algo04.rst
  98
  99 .. include:: snippets/Residu.rst
 100
 101 .. ------------------------------------ ..
 102 .. include:: snippets/Header2Algo05.rst
 103
 104 .. include:: snippets/CurrentState.rst
 105
 106 .. include:: snippets/Residu.rst
 107
 108 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 109
 110 .. ------------------------------------ ..
 111 .. _section_ref_algorithm_TangentTest_examples:
 112 .. include:: snippets/Header2Algo06.rst
 113
 114 - :ref:`section_ref_algorithm_FunctionTest`
 115 - :ref:`section_ref_algorithm_LinearityTest`
 116 - :ref:`section_ref_algorithm_AdjointTest`
 117 - :ref:`section_ref_algorithm_GradientTest`
 118 - :ref:`section_ref_algorithm_LocalSensitivityTest`