2 Copyright (C) 2008-2024 EDF R&D
4 This file is part of SALOME ADAO module.
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.
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.
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
20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
24 .. index:: single: ReducedModelingTest
25 .. _section_ref_algorithm_ReducedModelingTest:
27 Checking algorithm "*ReducedModelingTest*"
28 ------------------------------------------
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo00.rst
33 .. ------------------------------------ ..
34 .. include:: snippets/Header2Algo01.rst
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.
45 Once the analysis is complete, a summary is displayed and, on request, a
46 graphical representation of the same information is produced.
48 .. ------------------------------------ ..
49 .. include:: snippets/Header2Algo12.rst
51 .. include:: snippets/FeaturePropDerivativeFree.rst
53 .. ------------------------------------ ..
54 .. include:: snippets/Header2Algo02.rst
56 .. include:: snippets/EnsembleOfSnapshots.rst
58 .. include:: snippets/ExcludeLocations.rst
60 .. include:: snippets/MaximumNumberOfLocations.rst
62 .. include:: snippets/MaximumNumberOfModes.rst
64 .. include:: snippets/NameOfLocations.rst
66 .. include:: snippets/NumberOfPrintedDigits.rst
68 .. include:: snippets/PlotAndSave.rst
70 .. include:: snippets/SampleAsExplicitHyperCube.rst
72 .. include:: snippets/SampleAsIndependantRandomVariables.rst
74 .. include:: snippets/SampleAsMinMaxLatinHyperCube.rst
76 .. include:: snippets/SampleAsMinMaxSobolSequence.rst
78 .. include:: snippets/SampleAsMinMaxStepHyperCube.rst
80 .. include:: snippets/SampleAsnUplet.rst
82 .. include:: snippets/SetDebug.rst
84 .. include:: snippets/SetSeed.rst
86 .. include:: snippets/ShowElementarySummary.rst
88 StoreSupplementaryCalculations
89 .. index:: single: StoreSupplementaryCalculations
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
101 "EnsembleOfSimulations",
108 ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
110 .. ------------------------------------ ..
111 .. include:: snippets/Header2Algo04.rst
113 .. include:: snippets/NoUnconditionalOutput.rst
115 .. ------------------------------------ ..
116 .. include:: snippets/Header2Algo05.rst
118 .. include:: snippets/EnsembleOfSimulations.rst
120 .. include:: snippets/EnsembleOfStates.rst
122 .. include:: snippets/Residus.rst
124 .. include:: snippets/SingularValues.rst
126 .. ------------------------------------ ..
127 .. _section_ref_algorithm_ReducedModelingTest_examples:
129 .. include:: snippets/Header2Algo06.rst
131 - :ref:`section_ref_algorithm_FunctionTest`
132 - :ref:`section_ref_algorithm_ParallelFunctionTest`
133 - :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`
134 - :ref:`section_ref_algorithm_MeasurementsOptimalPositioningTask`