Salome HOME
d1f6ecdcd53589379680070541de1cc2ed99abc4
[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 .. index:: single: Ensemble of simulations
29 .. index:: single: Ensemble of snapshots
30 .. index:: single: Simulations (Ensemble)
31 .. index:: single: Snapshots (Ensemble)
32 .. index:: single: Reduced Order Model
33 .. index:: single: ROM
34 .. _section_ref_algorithm_MeasurementsOptimalPositioningTask:
35
36 Task algorithm "*MeasurementsOptimalPositioningTask*"
37 -----------------------------------------------------
38
39 .. ------------------------------------ ..
40 .. include:: snippets/Header2Algo00.rst
41
42 .. ------------------------------------ ..
43 .. include:: snippets/Header2Algo01.rst
44
45 This algorithm provides optimal positioning of measurements of an
46 :math:`\mathbf{y}` physical field, in order to get the best possible
47 interpolation. These optimal measurement positions are determined in an
48 iterative greedy way, from a pre-existing set of state vectors
49 :math:`\mathbf{y}` (usually called "snapshots*" in reduced basis methodology)
50 or obtained by simulating the physical field(s) of interest during the course
51 of the algorithm. Each of these state vectors is usually (but not necessarily)
52 the result :math:`\mathbf{y}` of a simulation using the operator :math:`H` that
53 returns the complete field(s) for a given set of parameters :math:`\mathbf{x}`,
54 or of an explicit observation of the complete field(s) :math:`\mathbf{y}`.
55
56 To determine the optimum positioning of measurements, an Empirical
57 Interpolation Method (EIM [Barrault04]_) or Discrete Empirical Interpolation
58 Method (DEIM [Chaturantabut10]_) is used, which establishes a reduced model of
59 type Reduced Order Model (ROM), with (variant "*lcEIM*" or "*lcDEIM*") or
60 without (variant "*EIM*" or "*DEIM*") positioning constraints. For performance,
61 we recommend using the variant "*lcEIM*" or "*EIM*" when the dimension of the
62 full fields space is large.
63
64 There are two ways to use this algorithm:
65
66 #. In its simplest use, if the set of physical state :math:`\mathbf{y}` vectors
67    is pre-existing, it is only necessary to provide it as an ordered collection
68    by the algorithm option "*EnsembleOfSnapshots*". This is the default
69    situation, for example, if the set of states has been generated by an
70    :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`.
71 #. If the set of physical state :math:`\mathbf{y}` vectors is to be obtained by
72    explicit simulations during the course of the algorithm, then one must
73    provide both the simulation operator of the complete field, here identified
74    with the observation operator :math:`H` of the complete field, and the
75    design of experiment of the space of parametric states :math:`\mathbf{x}`.
76
77 If the design of experiments is supplied, the sampling of the states
78 :math:`\mathbf{x}` can be given as in the
79 :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`, explicitly or
80 under form of hypercubes, explicit or sampled according to classic
81 distributions, or using Latin hypercube sampling (LHS). The computations are
82 optimized according to the computer resources available and the options
83 requested by the user. Beware of the size of the hypercube (and then to the
84 number of computations) that can be reached, it can grow quickly to be quite
85 large.
86
87   .. _mop_determination:
88   .. image:: images/mop_determination.png
89     :align: center
90     :width: 95%
91   .. centered::
92     **General scheme for using the algorithm**
93
94 It is possible to exclude a priori potential positions for measurement
95 positioning, using the analysis variant "*lcEIM*" or "*lcDEIM*" for a
96 constrained positioning search.
97
98 .. ------------------------------------ ..
99 .. include:: snippets/Header2Algo02.rst
100
101 *None*
102
103 .. ------------------------------------ ..
104 .. include:: snippets/Header2Algo03Task.rst
105
106 .. include:: snippets/EnsembleOfSnapshots.rst
107
108 .. include:: snippets/ExcludeLocations.rst
109
110 .. include:: snippets/ErrorNorm.rst
111
112 .. include:: snippets/ErrorNormTolerance.rst
113
114 .. include:: snippets/MaximumNumberOfLocations.rst
115
116 .. include:: snippets/NameOfLocations.rst
117
118 .. include:: snippets/SampleAsExplicitHyperCube.rst
119
120 .. include:: snippets/SampleAsIndependantRandomVariables.rst
121
122 .. include:: snippets/SampleAsMinMaxLatinHyperCube.rst
123
124 .. include:: snippets/SampleAsMinMaxStepHyperCube.rst
125
126 .. include:: snippets/SampleAsnUplet.rst
127
128 .. include:: snippets/SetDebug.rst
129
130 .. include:: snippets/SetSeed.rst
131
132 StoreSupplementaryCalculations
133   .. index:: single: StoreSupplementaryCalculations
134
135   *List of names*. This list indicates the names of the supplementary
136   variables, that can be available during or at the end of the algorithm, if
137   they are initially required by the user. Their availability involves,
138   potentially, costly calculations or memory consumptions. The default is then
139   a void list, none of these variables being calculated and stored by default
140   (excepted the unconditional variables). The possible names are in the
141   following list (the detailed description of each named variable is given in
142   the following part of this specific algorithmic documentation, in the
143   sub-section "*Information and variables available at the end of the
144   algorithm*"): [
145   "EnsembleOfSimulations",
146   "EnsembleOfStates",
147   "ExcludedPoints",
148   "OptimalPoints",
149   "ReducedBasis",
150   "Residus",
151   "SingularValues",
152   ].
153
154   Example :
155   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
156
157 .. include:: snippets/Variant_MOP.rst
158
159 .. ------------------------------------ ..
160 .. include:: snippets/Header2Algo04.rst
161
162 .. include:: snippets/OptimalPoints.rst
163
164 .. ------------------------------------ ..
165 .. include:: snippets/Header2Algo05.rst
166
167 .. include:: snippets/EnsembleOfSimulations.rst
168
169 .. include:: snippets/EnsembleOfStates.rst
170
171 .. include:: snippets/ExcludedPoints.rst
172
173 .. include:: snippets/OptimalPoints.rst
174
175 .. include:: snippets/ReducedBasis.rst
176
177 .. include:: snippets/Residus.rst
178
179 .. include:: snippets/SingularValues.rst
180
181 .. ------------------------------------ ..
182 .. _section_ref_algorithm_MeasurementsOptimalPositioningTask_examples:
183
184 .. include:: snippets/Header2Algo09.rst
185
186 .. --------- ..
187 .. include:: scripts/simple_MeasurementsOptimalPositioningTask1.rst
188
189 .. literalinclude:: scripts/simple_MeasurementsOptimalPositioningTask1.py
190
191 .. include:: snippets/Header2Algo10.rst
192
193 .. literalinclude:: scripts/simple_MeasurementsOptimalPositioningTask1.res
194     :language: none
195
196 .. --------- ..
197 .. include:: scripts/simple_MeasurementsOptimalPositioningTask2.rst
198
199 .. literalinclude:: scripts/simple_MeasurementsOptimalPositioningTask2.py
200
201 .. include:: snippets/Header2Algo10.rst
202
203 .. literalinclude:: scripts/simple_MeasurementsOptimalPositioningTask2.res
204     :language: none
205
206 .. ------------------------------------ ..
207 .. include:: snippets/Header2Algo06.rst
208
209 - :ref:`section_ref_algorithm_FunctionTest`
210 - :ref:`section_ref_algorithm_ParallelFunctionTest`
211 - :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`
212
213 .. ------------------------------------ ..
214 .. include:: snippets/Header2Algo07.rst
215
216 - [Barrault04]_
217 - [Chaturantabut10]_
218 - [Gong18]_
219 - [Quarteroni16]_