doc/en/ref_algorithm_LinearityTest.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: LinearityTest
  25 .. _section_ref_algorithm_LinearityTest:
  26
  27 Checking algorithm "*LinearityTest*"
  28 ------------------------------------
  29
  30 Description
  31 +++++++++++
  32
  33 This algorithm allows to check the linear quality of the 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 "CenteredDL" residue
  41 ********************
  42
  43 One observe the following residue, coming from the centered difference of the
  44 :math:`F` values at nominal point and at perturbed points, normalized by the
  45 value at the nominal point:
  46
  47 .. math:: R(\alpha) = \frac{|| F(\mathbf{x}+\alpha*\mathbf{dx}) + F(\mathbf{x}-\alpha*\mathbf{dx}) - 2*F(\mathbf{x}) ||}{|| F(\mathbf{x}) ||}
  48
  49 If it stays constantly really small with respect to 1, the linearity hypothesis
  50 of :math:`F` is verified.
  51
  52 If the residue is varying, or if it is of order 1 or more, and it is small only
  53 at a certain order of increment, the linearity hypothesis of :math:`F` is not
  54 verified.
  55
  56 If the residue is decreasing and the decrease change in :math:`\alpha^2` with
  57 respect to :math:`\alpha`, it signifies that the gradient is correctly
  58 calculated until the stopping level of the quadratic decrease.
  59
  60 "Taylor" residue
  61 ****************
  62
  63 One observe the residue coming from the Taylor development of the :math:`F`
  64 function, normalized by the value at the nominal point:
  65
  66 .. math:: R(\alpha) = \frac{|| F(\mathbf{x}+\alpha*\mathbf{dx}) - F(\mathbf{x}) - \alpha * \nabla_xF(\mathbf{dx}) ||}{|| F(\mathbf{x}) ||}
  67
  68 If it stay constantly really small with respect to 1, the linearity hypothesis
  69 of :math:`F` is verified.
  70
  71 If the residue is varying, or if it is of order 1 or more, and it is small only
  72 at a certain order of increment, the linearity hypothesis of :math:`F` is not
  73 verified.
  74
  75 If the residue is decreasing and the decrease change in :math:`\alpha^2` with
  76 respect to :math:`\alpha`, it signifies that the gradient is correctly
  77 calculated until the stopping level of the quadratic decrease.
  78
  79 "NominalTaylor" residue
  80 ***********************
  81
  82 One observe the residue build from two approximations of order 1 of
  83 :math:`F(\mathbf{x})`, normalized by the value at the nominal point:
  84
  85 .. math:: R(\alpha) = \max(|| F(\mathbf{x}+\alpha*\mathbf{dx}) - \alpha * F(\mathbf{dx}) || / || F(\mathbf{x}) ||,|| F(\mathbf{x}-\alpha*\mathbf{dx}) + \alpha * F(\mathbf{dx}) || / || F(\mathbf{x}) ||)
  86
  87 If the residue stays constant equal to 1 at less than 2 or 3 percents (that that
  88 :math:`|R-1|` stays equal to 2 or 3 percents), the linearity hypothesis of
  89 :math:`F` is verified.
  90
  91 If it is equal to 1 only on part of the variation domain of increment
  92 :math:`\alpha`, it is on this sub-domain that the linearity hypothesis of
  93 :math:`F` is verified.
  94
  95 "NominalTaylorRMS" residue
  96 **************************
  97
  98 One observe the residue build from two approximations of order 1 of
  99 :math:`F(\mathbf{x})`, normalized by the value at the nominal point, on which
 100 one estimate the quadratic root mean square (RMS) with the value at the nominal
 101 point:
 102
 103 .. math:: R(\alpha) = \max(RMS( F(\mathbf{x}), F(\mathbf{x}+\alpha*\mathbf{dx}) - \alpha * F(\mathbf{dx}) ) / || F(\mathbf{x}) ||,RMS( F(\mathbf{x}), F(\mathbf{x}-\alpha*\mathbf{dx}) + \alpha * F(\mathbf{dx}) ) / || F(\mathbf{x}) ||)
 104
 105 If it stay constantly equal to 0 at less than 1 or 2 percents, the linearity
 106 hypothesis of :math:`F` is verified.
 107
 108 If it is equal to 0 only on part of the variation domain of increment
 109 :math:`\alpha`, it is on this sub-domain that the linearity hypothesis of
 110 :math:`F` is verified.
 111
 112 Optional and required commands
 113 ++++++++++++++++++++++++++++++
 114
 115 .. index:: single: CheckingPoint
 116 .. index:: single: ObservationOperator
 117 .. index:: single: AmplitudeOfInitialDirection
 118 .. index:: single: EpsilonMinimumExponent
 119 .. index:: single: InitialDirection
 120 .. index:: single: ResiduFormula
 121 .. index:: single: SetSeed
 122
 123 The general required commands, available in the editing user interface, are the
 124 following:
 125
 126   CheckingPoint
 127     *Required command*. This indicates the vector used as the state around which
 128     to perform the required check, noted :math:`\mathbf{x}` and similar to the
 129     background :math:`\mathbf{x}^b`. It is defined as a "*Vector*" type object.
 130
 131   ObservationOperator
 132     *Required command*. This indicates the observation operator, previously
 133     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
 134     results :math:`\mathbf{y}` to be compared to observations
 135     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
 136     a "*Matrix*" type one. In the case of "*Function*" type, different
 137     functional forms can be used, as described in the section
 138     :ref:`section_ref_operator_requirements`. If there is some control
 139     :math:`U` included in the observation, the operator has to be applied to a
 140     pair :math:`(X,U)`.
 141
 142 The general optional commands, available in the editing user interface, are
 143 indicated in :ref:`section_ref_assimilation_keywords`. In particular, the
 144 optional command "*AlgorithmParameters*" allows to choose the specific options,
 145 described hereafter, of the algorithm. See
 146 :ref:`section_ref_options_AlgorithmParameters` for the good use of this command.
 147
 148 The options of the algorithm are the following:
 149
 150   AmplitudeOfInitialDirection
 151     This key indicates the scaling of the initial perturbation build as a vector
 152     used for the directional derivative around the nominal checking point. The
 153     default is 1, that means no scaling.
 154
 155     Example : ``{"AmplitudeOfInitialDirection":0.5}``
 156
 157   EpsilonMinimumExponent
 158     This key indicates the minimal exponent value of the power of 10 coefficient
 159     to be used to decrease the increment multiplier. The default is -8, and it
 160     has to be between 0 and -20. For example, its default value leads to
 161     calculate the residue of the scalar product formula with a fixed increment
 162     multiplied from 1.e0 to 1.e-8.
 163
 164     Example : ``{"EpsilonMinimumExponent":-12}``
 165
 166   InitialDirection
 167     This key indicates the vector direction used for the directional derivative
 168     around the nominal checking point. It has to be a vector. If not specified,
 169     this direction defaults to a random perturbation around zero of the same
 170     vector size than the checking point.
 171
 172     Example : ``{"InitialDirection":[0.1,0.1,100.,3}``
 173
 174   ResiduFormula
 175     This key indicates the residue formula that has to be used for the test. The
 176     default choice is "CenteredDL", and the possible ones are "CenteredDL"
 177     (residue of the difference between the function at nominal point and the
 178     values with positive and negative increments, which has to stay very small),
 179     "Taylor" (residue of the Taylor development of the operator normalized by
 180     the nominal value, which has to stay very small), "NominalTaylor" (residue
 181     of the order 1 approximations of the operator, normalized to the nominal
 182     point, which has to stay close to 1), and "NominalTaylorRMS" (residue of the
 183     order 1 approximations of the operator, normalized by RMS to the nominal
 184     point, which has to stay close to 0).
 185
 186     Example : ``{"ResiduFormula":"CenteredDL"}``
 187
 188   SetSeed
 189     This key allow to give an integer in order to fix the seed of the random
 190     generator used to generate the ensemble. A convenient value is for example
 191     1000. By default, the seed is left uninitialized, and so use the default
 192     initialization from the computer.
 193
 194     Example : ``{"SetSeed":1000}``
 195
 196 See also
 197 ++++++++
 198
 199 References to other sections:
 200   - :ref:`section_ref_algorithm_FunctionTest`