doc/en/ref_algorithm_GradientTest.rst

   1 ..
   2    Copyright (C) 2008-2015 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: GradientTest
  25 .. _section_ref_algorithm_GradientTest:
  26
  27 Checking algorithm "*GradientTest*"
  28 -----------------------------------
  29
  30 Description
  31 +++++++++++
  32
  33 This algorithm allows to check the quality of the adjoint operator, by
  34 calculating a residue with known theoretical properties. Different residue
  35 formula are available.
  36
  37 In any cases, one take :math:`\mathbf{dx}_0=Normal(0,\mathbf{x})` and
  38 :math:`\mathbf{dx}=\alpha*\mathbf{dx}_0`. :math:`F` is the calculation code.
  39
  40 "Taylor" residue
  41 ****************
  42
  43 One observe the residue coming from the Taylor development of the :math:`F`
  44 function, normalized by the value at the nominal point:
  45
  46 .. math:: R(\alpha) = \frac{|| F(\mathbf{x}+\alpha*\mathbf{dx}) - F(\mathbf{x}) - \alpha * \nabla_xF(\mathbf{dx}) ||}{|| F(\mathbf{x}) ||}
  47
  48 If the residue is decreasing and the decrease change in :math:`\alpha^2` with
  49 respect to :math:`\alpha`, it signifies that the gradient is well calculated
  50 until the stopping precision of the quadratic decrease, and that :math:`F` is
  51 not linear.
  52
  53 If the residue is decreasing and the decrease change in :math:`\alpha` with
  54 respect to :math:`\alpha`, until a certain level after which the residue remains
  55 small and constant, it signifies that the :math:`F` is linear and that the
  56 residue is decreasing due to the error coming from :math:`\nabla_xF` term
  57 calculation.
  58
  59 "TaylorOnNorm" residue
  60 **********************
  61
  62 One observe the residue coming from the Taylor development of the :math:`F`
  63 function, with respect to the :math:`\alpha` parameter to the square:
  64
  65 .. math:: R(\alpha) = \frac{|| F(\mathbf{x}+\alpha*\mathbf{dx}) - F(\mathbf{x}) - \alpha * \nabla_xF(\mathbf{dx}) ||}{\alpha^2}
  66
  67 This is a residue essentialy similar to the classical Taylor criterion
  68 previously described, but its behaviour can differ depending on the numerical
  69 properties of the calculation.
  70
  71 If the residue is constant until a certain level after which the residue will
  72 growth, it signifies that the gradient is well calculated until this stopping
  73 precision, and that :math:`F` is not linear.
  74
  75 If the residue is systematicaly growing from a very smal value with respect to
  76 :math:`||F(\mathbf{x})||`, it signifies that :math:`F` is (quasi-)linear and
  77 that the gradient calculation is correct until the precision for which the
  78 residue reachs the numerical order of :math:`||F(\mathbf{x})||`.
  79
  80 "Norm" residue
  81 **************
  82
  83 One observe the residue based on the gradient approximation:
  84
  85 .. math:: R(\alpha) = \frac{|| F(\mathbf{x}+\alpha*\mathbf{dx}) - F(\mathbf{x}) ||}{\alpha}
  86
  87 which has to remain stable until the calculation precision is reached.
  88
  89 Optional and required commands
  90 ++++++++++++++++++++++++++++++
  91
  92 .. index:: single: AlgorithmParameters
  93 .. index:: single: CheckingPoint
  94 .. index:: single: ObservationOperator
  95 .. index:: single: AmplitudeOfInitialDirection
  96 .. index:: single: EpsilonMinimumExponent
  97 .. index:: single: InitialDirection
  98 .. index:: single: ResiduFormula
  99 .. index:: single: SetSeed
 100
 101 The general required commands, available in the editing user interface, are the
 102 following:
 103
 104   CheckingPoint
 105     *Required command*. This indicates the vector used as the state around which
 106     to perform the required check, noted :math:`\mathbf{x}` and similar to the
 107     background :math:`\mathbf{x}^b`. It is defined as a "*Vector*" type object.
 108
 109   ObservationOperator
 110     *Required command*. This indicates the observation operator, previously
 111     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
 112     results :math:`\mathbf{y}` to be compared to observations
 113     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
 114     a "*Matrix*" type one. In the case of "*Function*" type, different
 115     functional forms can be used, as described in the section
 116     :ref:`section_ref_operator_requirements`. If there is some control
 117     :math:`U` included in the observation, the operator has to be applied to a
 118     pair :math:`(X,U)`.
 119
 120 The general optional commands, available in the editing user interface, are
 121 indicated in :ref:`section_ref_assimilation_keywords`. Moreover, the parameters
 122 of the command "*AlgorithmParameters*" allow to choose the specific options,
 123 described hereafter, of the algorithm. See
 124 :ref:`section_ref_options_Algorithm_Parameters` for the good use of this
 125 command.
 126
 127 The options of the algorithm are the following:
 128
 129   AmplitudeOfInitialDirection
 130     This key indicates the scaling of the initial perturbation build as a vector
 131     used for the directional derivative around the nominal checking point. The
 132     default is 1, that means no scaling.
 133
 134     Example : ``{"AmplitudeOfInitialDirection":0.5}``
 135
 136   EpsilonMinimumExponent
 137     This key indicates the minimal exponent value of the power of 10 coefficient
 138     to be used to decrease the increment multiplier. The default is -8, and it
 139     has to be between 0 and -20. For example, its default value leads to
 140     calculate the residue of the scalar product formula with a fixed increment
 141     multiplied from 1.e0 to 1.e-8.
 142
 143     Example : ``{"EpsilonMinimumExponent":-12}``
 144
 145   InitialDirection
 146     This key indicates the vector direction used for the directional derivative
 147     around the nominal checking point. It has to be a vector. If not specified,
 148     this direction defaults to a random perturbation around zero of the same
 149     vector size than the checking point.
 150
 151     Example : ``{"InitialDirection":[0.1,0.1,100.,3}``
 152
 153   ResiduFormula
 154     This key indicates the residue formula that has to be used for the test. The
 155     default choice is "Taylor", and the possible ones are "Taylor" (normalized
 156     residue of the Taylor development of the operator, which has to decrease
 157     with the square power of the perturbation), "TaylorOnNorm" (residue of the
 158     Taylor development of the operator with respect to the pertibation to the
 159     square, which has to remain constant) and "Norm" (residue obtained by taking
 160     the norm of the Taylor development at zero order approximation, which
 161     approximate the gradient, and which has to remain constant).
 162
 163     Example : ``{"ResiduFormula":"Taylor"}``
 164
 165   SetSeed
 166     This key allow to give an integer in order to fix the seed of the random
 167     generator used to generate the ensemble. A convenient value is for example
 168     1000. By default, the seed is left uninitialized, and so use the default
 169     initialization from the computer.
 170
 171     Example : ``{"SetSeed":1000}``
 172
 173 See also
 174 ++++++++
 175
 176 References to other sections:
 177   - :ref:`section_ref_algorithm_FunctionTest`
 178   - :ref:`section_ref_algorithm_TangentTest`
 179   - :ref:`section_ref_algorithm_AdjointTest`