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