]> SALOME platform Git repositories - modules/adao.git/blob - doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst
Salome HOME
Extending sampling control and output
[modules/adao.git] / doc / en / ref_algorithm_MeasurementsOptimalPositioningTask.rst
1 ..
2    Copyright (C) 2008-2023 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: MeasurementsOptimalPositioningTask
25 .. index:: single: Optimal positioning of measurements
26 .. index:: single: Measurement locations
27 .. index:: single: Measurements (Optimal positioning)
28 .. _section_ref_algorithm_MeasurementsOptimalPositioningTask:
29
30 Task algorithm "*MeasurementsOptimalPositioningTask*"
31 -----------------------------------------------------
32
33 .. ------------------------------------ ..
34 .. include:: snippets/Header2Algo00.rst
35
36 .. warning::
37
38   This algorithm is only available in textual user interface (TUI) and not in
39   graphical user interface (GUI).
40
41 .. ------------------------------------ ..
42 .. include:: snippets/Header2Algo01.rst
43
44 This algorithm provides optimal positioning of measurement points by an EIM
45 (Empirical Interpolation Method) analysis, in a iterative greedy way from a set
46 of given state vectors (usually called "snapshots" in reduced basis
47 methodology) or obtained by a direct simulation during the algorithm. Each of
48 these state vectors are usaully (but not necessarily) the result
49 :math:`\mathbf{y}` of a simulation :math:`H` for a given set of paramters
50 :math:`\mathbf{x}=\mu`.
51
52 There are two ways to use this algorithm:
53
54 #. In its simplest use, if the set of state vectors is pre-existing, it is only
55    necessary to provide it by the option "*SetOfSnapshots*" of algorithm.
56 #. If the set of state vectors is to be obtained by simulations during the
57    course of the algorithm, then one must provide the :math:`H` simulation
58    operator and the parametric :math:`\mathbf{x}` state space design of
59    experiments.
60
61 The sample of states :math:`\mathbf{x}` can be provided explicitly or in the
62 form of hyper-cubes, explicit or sampled according to standard laws. Beware of
63 the size of the hyper-cube (and thus the number of computations) that can be
64 reached, it can quickly become important.
65
66 It is possible to exclude a priori potential positions for optimal measurement
67 points, using the analysis variant "*lcEIM*" for a constrained positioning
68 search.
69
70 .. ------------------------------------ ..
71 .. include:: snippets/Header2Algo02.rst
72
73 *None*
74
75 .. ------------------------------------ ..
76 .. include:: snippets/Header2Algo03Task.rst
77
78 .. include:: snippets/EnsembleOfSnapshots.rst
79
80 .. include:: snippets/ExcludeLocations.rst
81
82 .. include:: snippets/ErrorNorm.rst
83
84 .. include:: snippets/ErrorNormTolerance.rst
85
86 .. include:: snippets/MaximumNumberOfLocations.rst
87
88 .. include:: snippets/SampleAsExplicitHyperCube.rst
89
90 .. include:: snippets/SampleAsIndependantRandomVariables.rst
91
92 .. include:: snippets/SampleAsMinMaxStepHyperCube.rst
93
94 .. include:: snippets/SampleAsnUplet.rst
95
96 .. include:: snippets/SetDebug.rst
97
98 .. include:: snippets/SetSeed.rst
99
100 StoreSupplementaryCalculations
101   .. index:: single: StoreSupplementaryCalculations
102
103   *List of names*. This list indicates the names of the supplementary
104   variables, that can be available during or at the end of the algorithm, if
105   they are initially required by the user. Their avalability involves,
106   potentially, costly calculations or memory consumptions. The default is then
107   a void list, none of these variables being calculated and stored by default
108   (excepted the unconditionnal variables). The possible names are in the
109   following list (the detailed description of each named variable is given in
110   the following part of this specific algorithmic documentation, in the
111   sub-section "*Information and variables available at the end of the
112   algorithm*"): [
113   "EnsembleOfSimulations",
114   "EnsembleOfStates",
115   "OptimalPoints",
116   "ReducedBasis",
117   "Residus",
118   ].
119
120   Example :
121   ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
122
123 .. include:: snippets/Variant_MOP.rst
124
125 .. ------------------------------------ ..
126 .. include:: snippets/Header2Algo04.rst
127
128 .. include:: snippets/OptimalPoints.rst
129
130 .. ------------------------------------ ..
131 .. include:: snippets/Header2Algo05.rst
132
133 .. include:: snippets/EnsembleOfSimulations.rst
134
135 .. include:: snippets/EnsembleOfStates.rst
136
137 .. include:: snippets/OptimalPoints.rst
138
139 .. include:: snippets/ReducedBasis.rst
140
141 .. include:: snippets/Residus.rst
142
143 .. ------------------------------------ ..
144 .. _section_ref_algorithm_MeasurementsOptimalPositioningTask_examples:
145 .. include:: snippets/Header2Algo07.rst
146
147 - [Barrault04]_
148 - [Gong18]_
149 - [Quarteroni16]_