doc/en/ref_algorithm_ReducedModelingTest.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: ReducedModelingTest
  25 .. _section_ref_algorithm_ReducedModelingTest:
  26
  27 Checking algorithm "*ReducedModelingTest*"
  28 ------------------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo00.rst
  32
  33 .. ------------------------------------ ..
  34 .. include:: snippets/Header2Algo01.rst
  35
  36 This checking algorithm provides a simple analysis of the characteristics of
  37 the state collection from the point of view of reduction. It aims to diagnose
  38 the complexity of the information present in the available state collection,
  39 and the possibility to represent this state information in a space smaller than
  40 the entire state collection. Technically, based on a classical SVD (Singular
  41 Value Decomposition) and in the same way as a PCA (Principal Component
  42 Analysis), it evaluates how information decreases with the number of singular
  43 values, either as values or, from a statistical point of view, as remaining
  44 variance.
  45
  46 Once the analysis is complete, a summary is displayed and, on request, a
  47 graphical representation of the same information is produced.
  48
  49 .. ------------------------------------ ..
  50 .. include:: snippets/Header2Algo12.rst
  51
  52 .. include:: snippets/FeaturePropDerivativeFree.rst
  53
  54 .. ------------------------------------ ..
  55 .. include:: snippets/Header2Algo02.rst
  56
  57 .. include:: snippets/EnsembleOfSnapshots.rst
  58
  59 .. include:: snippets/ExcludeLocations.rst
  60
  61 .. include:: snippets/MaximumNumberOfLocations.rst
  62
  63 .. include:: snippets/MaximumNumberOfModes.rst
  64
  65 .. include:: snippets/NameOfLocations.rst
  66
  67 .. include:: snippets/NumberOfPrintedDigits.rst
  68
  69 .. include:: snippets/PlotAndSave.rst
  70
  71 .. include:: snippets/SampleAsExplicitHyperCube.rst
  72
  73 .. include:: snippets/SampleAsIndependantRandomVariables.rst
  74
  75 .. include:: snippets/SampleAsMinMaxLatinHyperCube.rst
  76
  77 .. include:: snippets/SampleAsMinMaxSobolSequence.rst
  78
  79 .. include:: snippets/SampleAsMinMaxStepHyperCube.rst
  80
  81 .. include:: snippets/SampleAsnUplet.rst
  82
  83 .. include:: snippets/SetDebug.rst
  84
  85 .. include:: snippets/SetSeed.rst
  86
  87 .. include:: snippets/ShowElementarySummary.rst
  88
  89 StoreSupplementaryCalculations
  90   .. index:: single: StoreSupplementaryCalculations
  91
  92   *List of names*. This list indicates the names of the supplementary
  93   variables, that can be available during or at the end of the algorithm, if
  94   they are initially required by the user. Their availability involves,
  95   potentially, costly calculations or memory consumptions. The default is then
  96   a void list, none of these variables being calculated and stored by default
  97   (excepted the unconditional variables). The possible names are in the
  98   following list (the detailed description of each named variable is given in
  99   the following part of this specific algorithmic documentation, in the
 100   sub-section "*Information and variables available at the end of the
 101   algorithm*"): [
 102   "EnsembleOfSimulations",
 103   "EnsembleOfStates",
 104   "Residus",
 105   "SingularValues",
 106   ].
 107
 108   Example :
 109   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
 110
 111 .. ------------------------------------ ..
 112 .. include:: snippets/Header2Algo04.rst
 113
 114 .. include:: snippets/NoUnconditionalOutput.rst
 115
 116 .. ------------------------------------ ..
 117 .. include:: snippets/Header2Algo05.rst
 118
 119 .. include:: snippets/EnsembleOfSimulations.rst
 120
 121 .. include:: snippets/EnsembleOfStates.rst
 122
 123 .. include:: snippets/Residus.rst
 124
 125 .. include:: snippets/SingularValues.rst
 126
 127 .. ------------------------------------ ..
 128 .. _section_ref_algorithm_ReducedModelingTest_examples:
 129
 130 .. include:: snippets/Header2Algo06.rst
 131
 132 - :ref:`section_ref_algorithm_FunctionTest`
 133 - :ref:`section_ref_algorithm_ParallelFunctionTest`
 134 - :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`
 135 - :ref:`section_ref_algorithm_MeasurementsOptimalPositioningTask`
 136