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: EnsembleOfSimulationGenerationTask
25 .. index:: single: Génération d'ensemble de simulations
26 .. index:: single: Ensemble of simulations
27 .. index:: single: Ensemble of snapshots
28 .. index:: single: Simulations (Ensemble)
29 .. index:: single: Snapshots (Ensemble)
30 .. _section_ref_algorithm_EnsembleOfSimulationGenerationTask:
32 Task algorithm "*EnsembleOfSimulationGenerationTask*"
33 -----------------------------------------------------
35 .. ------------------------------------ ..
36 .. include:: snippets/Header2Algo00.rst
38 .. ------------------------------------ ..
39 .. include:: snippets/Header2Algo01.rst
41 This algorithm allows to generate a set of physical results, of simulation or
42 observation type, using the :math:`H` operator for a design of experiment of
43 the :math:`\mathbf{x}` parametric state space. The result of this algorithm is
44 a homogeneous collection of simulated vectors :math:`\mathbf{y}` (available
45 using the storable variable "*EnsembleOfSimulations*") corresponding directly
46 to the chosen homogeneous collection of state vectors :math:`\mathbf{x}`
47 (available using the storable variable "*EnsembleOfStates*").
49 The sampling of the states :math:`\mathbf{x}` can be given explicitly or under
50 form of hypercubes, explicit or sampled according to classic distributions, or
51 using Latin hypercube sampling (LHS) or Sobol sequences. The computations are
52 optimized according to the computer resources available and the options
53 requested by the user. You can refer to the
54 :ref:`section_ref_sampling_requirements` for an illustration of sampling.
55 Beware of the size of the hypercube (and then to the number of computations)
56 that can be reached, it can grow quickly to be quite large. When a state is not
57 observable, a *"NaN"* value is returned.
59 To be visible by the user while reducing the risk of storage difficulties, the
60 results of sampling or simulations has to be **explicitly** asked for using the
63 The results obtained with this algorithm can be used to feed an
64 :ref:`section_ref_algorithm_MeasurementsOptimalPositioningTask`. In a
65 complementary way, and if the goal is to evaluate the calculation-measurement
66 error, an :ref:`section_ref_algorithm_SamplingTest` uses the same sampling
67 commands to establish a set of error functional values :math:`J` from
68 observations :math:`\mathbf{y}^o`.
70 .. ------------------------------------ ..
71 .. include:: snippets/Header2Algo12.rst
73 .. include:: snippets/FeaturePropDerivativeFree.rst
75 .. include:: snippets/FeaturePropParallelAlgorithm.rst
77 .. ------------------------------------ ..
78 .. include:: snippets/Header2Algo02.rst
80 .. include:: snippets/CheckingPoint.rst
82 .. include:: snippets/ObservationOperator.rst
84 .. ------------------------------------ ..
85 .. include:: snippets/Header2Algo03Task.rst
87 .. include:: snippets/SampleAsExplicitHyperCube.rst
89 .. include:: snippets/SampleAsIndependantRandomVariables.rst
91 .. include:: snippets/SampleAsMinMaxLatinHyperCube.rst
93 .. include:: snippets/SampleAsMinMaxSobolSequence.rst
95 .. include:: snippets/SampleAsMinMaxStepHyperCube.rst
97 .. include:: snippets/SampleAsnUplet.rst
99 .. include:: snippets/SetDebug.rst
101 .. include:: snippets/SetSeed.rst
103 StoreSupplementaryCalculations
104 .. index:: single: StoreSupplementaryCalculations
106 *List of names*. This list indicates the names of the supplementary
107 variables, that can be available during or at the end of the algorithm, if
108 they are initially required by the user. Their availability involves,
109 potentially, costly calculations or memory consumptions. The default is then
110 a void list, none of these variables being calculated and stored by default
111 (excepted the unconditional variables). The possible names are in the
112 following list (the detailed description of each named variable is given in
113 the following part of this specific algorithmic documentation, in the
114 sub-section "*Information and variables available at the end of the
116 "EnsembleOfSimulations",
121 ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
123 .. ------------------------------------ ..
124 .. include:: snippets/Header2Algo04.rst
126 .. include:: snippets/EnsembleOfSimulations.rst
128 .. ------------------------------------ ..
129 .. include:: snippets/Header2Algo05.rst
131 .. include:: snippets/EnsembleOfSimulations.rst
133 .. include:: snippets/EnsembleOfStates.rst
135 .. ------------------------------------ ..
136 .. _section_ref_algorithm_EnsembleOfSimulationGenerationTask_examples:
138 .. include:: snippets/Header2Algo06.rst
140 - :ref:`section_ref_algorithm_FunctionTest`
141 - :ref:`section_ref_algorithm_ParallelFunctionTest`
142 - :ref:`section_ref_algorithm_MeasurementsOptimalPositioningTask`