doc/en/ref_algorithm_SamplingTest.rst

   1 ..
   2    Copyright (C) 2008-2024 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: SamplingTest
  25 .. _section_ref_algorithm_SamplingTest:
  26
  27 Checking algorithm "*SamplingTest*"
  28 -----------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  32
  33 This test algorithm is used to establish the collection of values of an error
  34 functional :math:`J` of type :math:`L^1`, :math:`L^2` or :math:`L^{\infty}`,
  35 with or without weights, using the observation operator :math:`\mathcal{H}`,
  36 for an a priori given sample of states :math:`\mathbf{x}`. The default error
  37 functional is the augmented weighted least squares functional, classically used
  38 in data assimilation, using in addition to observations :math:`\mathbf{y}^o`.
  39
  40 This test is useful for analyzing the sensitivity of the functional :math:`J`
  41 to variations in the state :math:`\mathbf{x}` in particular.
  42
  43 The sampling of the states :math:`\mathbf{x}` can be given explicitly or under
  44 form of hypercubes, explicit or sampled according to classic distributions, or
  45 using Latin hypercube sampling (LHS) or Sobol sequences. The computations are
  46 optimized according to the computer resources available and the options
  47 requested by the user. You can refer to the
  48 :ref:`section_ref_sampling_requirements` for an illustration of sampling.
  49 Beware of the size of the hypercube (and then to the number of computations)
  50 that can be reached, it can grow quickly to be quite large. When a state is not
  51 observable, a *"NaN"* value is returned.
  52
  53 It is also possible to supply a set of simulations :math:`\mathbf{y}` already
  54 established elsewhere (so there's no explicit need for an operator
  55 :math:`\mathcal{H}`), which are implicitly associated with a set of state
  56 samples :math:`\mathbf{x}`. In this case where the set of simulations is
  57 provided, it is imperative to also provide the set of states :math:`\mathbf{x}`
  58 by explicit sampling, whose state order corresponds to the order of the
  59 simulations :math:`\mathbf{y}`.
  60
  61 To access the calculated information, the results of the sampling or
  62 simulations must be requested **explicitly** to avoid storage difficulties (if
  63 no results are requested, nothing is available). One use for that, on the
  64 desired variable, the final saving through "*UserPostAnalysis*" or the
  65 treatment during the calculation by well suited "*observer*".
  66
  67 .. ------------------------------------ ..
  68 .. include:: snippets/Header2Algo12.rst
  69
  70 .. include:: snippets/FeaturePropDerivativeFree.rst
  71
  72 .. include:: snippets/FeaturePropParallelAlgorithm.rst
  73
  74 .. ------------------------------------ ..
  75 .. include:: snippets/Header2Algo02.rst
  76
  77 .. include:: snippets/CheckingPoint.rst
  78
  79 .. include:: snippets/BackgroundError.rst
  80
  81 .. include:: snippets/Observation.rst
  82
  83 .. include:: snippets/ObservationError.rst
  84
  85 .. include:: snippets/ObservationOperator.rst
  86
  87 .. ------------------------------------ ..
  88 .. include:: snippets/Header2Algo03Chck.rst
  89
  90 .. include:: snippets/EnsembleOfSnapshots.rst
  91
  92 .. include:: snippets/QualityCriterion.rst
  93
  94 .. include:: snippets/SampleAsExplicitHyperCube.rst
  95
  96 .. include:: snippets/SampleAsIndependantRandomVariables.rst
  97
  98 .. include:: snippets/SampleAsMinMaxLatinHyperCube.rst
  99
 100 .. include:: snippets/SampleAsMinMaxSobolSequence.rst
 101
 102 .. include:: snippets/SampleAsMinMaxStepHyperCube.rst
 103
 104 .. include:: snippets/SampleAsnUplet.rst
 105
 106 .. include:: snippets/SetDebug.rst
 107
 108 .. include:: snippets/SetSeed.rst
 109
 110 StoreSupplementaryCalculations
 111   .. index:: single: StoreSupplementaryCalculations
 112
 113   *List of names*. This list indicates the names of the supplementary
 114   variables, that can be available during or at the end of the algorithm, if
 115   they are initially required by the user. Their availability involves,
 116   potentially, costly calculations or memory consumptions. The default is then
 117   a void list, none of these variables being calculated and stored by default
 118   (excepted the unconditional variables). The possible names are in the
 119   following list (the detailed description of each named variable is given in
 120   the following part of this specific algorithmic documentation, in the
 121   sub-section "*Information and variables available at the end of the
 122   algorithm*"): [
 123   "CostFunctionJ",
 124   "CostFunctionJb",
 125   "CostFunctionJo",
 126   "CurrentState",
 127   "EnsembleOfSimulations",
 128   "EnsembleOfStates",
 129   "Innovation",
 130   "InnovationAtCurrentState",
 131   "SimulatedObservationAtCurrentState",
 132   ].
 133
 134   Example :
 135   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
 136
 137 .. ------------------------------------ ..
 138 .. include:: snippets/Header2Algo04.rst
 139
 140 .. include:: snippets/CostFunctionJ.rst
 141
 142 .. include:: snippets/CostFunctionJb.rst
 143
 144 .. include:: snippets/CostFunctionJo.rst
 145
 146 .. ------------------------------------ ..
 147 .. include:: snippets/Header2Algo05.rst
 148
 149 .. include:: snippets/CostFunctionJ.rst
 150
 151 .. include:: snippets/CostFunctionJb.rst
 152
 153 .. include:: snippets/CostFunctionJo.rst
 154
 155 .. include:: snippets/CurrentState.rst
 156
 157 .. include:: snippets/EnsembleOfSimulations.rst
 158
 159 .. include:: snippets/EnsembleOfStates.rst
 160
 161 .. include:: snippets/Innovation.rst
 162
 163 .. include:: snippets/InnovationAtCurrentState.rst
 164
 165 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 166
 167 .. ------------------------------------ ..
 168 .. _section_ref_algorithm_SamplingTest_examples:
 169
 170 .. include:: snippets/Header2Algo06.rst
 171
 172 - :ref:`section_ref_algorithm_FunctionTest`
 173 - :ref:`section_ref_algorithm_LocalSensitivityTest`
 174
 175 .. ------------------------------------ ..
 176 .. include:: snippets/Header2Algo08.rst
 177
 178 - OPENTURNS, see the *User guide of OPENTURNS module* in the main "*Help*" menu of SALOME platform