Salome HOME
Extending sampling control and output
[modules/adao.git] / src / daComposant / daAlgorithms / MeasurementsOptimalPositioningTask.py
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright (C) 2008-2023 EDF R&D
4 #
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License.
9 #
10 # This library is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 # Lesser General Public License for more details.
14 #
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
18 #
19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #
21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
22
23 import numpy
24 from daCore import BasicObjects
25 from daAlgorithms.Atoms import ecweim
26 from daAlgorithms.Atoms import eosg
27
28 # ==============================================================================
29 class ElementaryAlgorithm(BasicObjects.Algorithm):
30     def __init__(self):
31         BasicObjects.Algorithm.__init__(self, "MEASUREMENTSOPTIMALPOSITIONING")
32         self.defineRequiredParameter(
33             name     = "Variant",
34             default  = "PositioningBylcEIM",
35             typecast = str,
36             message  = "Variant ou formulation de la méthode",
37             listval  = [
38                 "PositioningByEIM",
39                 "PositioningBylcEIM",
40                 ],
41             )
42         self.defineRequiredParameter(
43             name     = "EnsembleOfSnapshots",
44             default  = [],
45             typecast = numpy.array,
46             message  = "Ensemble de vecteurs d'état physique (snapshots), 1 état par colonne",
47             )
48         self.defineRequiredParameter(
49             name     = "MaximumNumberOfLocations",
50             default  = 1,
51             typecast = int,
52             message  = "Nombre maximal de positions",
53             minval   = 0,
54             )
55         self.defineRequiredParameter(
56             name     = "ExcludeLocations",
57             default  = [],
58             typecast = tuple,
59             message  = "Liste des positions exclues selon la numérotation interne d'un snapshot",
60             minval   = -1,
61             )
62         self.defineRequiredParameter(
63             name     = "ErrorNorm",
64             default  = "L2",
65             typecast = str,
66             message  = "Norme d'erreur utilisée pour le critère d'optimalité des positions",
67             listval  = ["L2", "Linf"]
68             )
69         self.defineRequiredParameter(
70             name     = "ErrorNormTolerance",
71             default  = 1.e-7,
72             typecast = float,
73             message  = "Valeur limite inférieure du critère d'optimalité forçant l'arrêt",
74             minval   = 0.,
75             )
76         self.defineRequiredParameter(
77             name     = "SampleAsnUplet",
78             default  = [],
79             typecast = tuple,
80             message  = "Points de calcul définis par une liste de n-uplet",
81             )
82         self.defineRequiredParameter(
83             name     = "SampleAsExplicitHyperCube",
84             default  = [],
85             typecast = tuple,
86             message  = "Points de calcul définis par un hyper-cube dont on donne la liste des échantillonnages de chaque variable comme une liste",
87             )
88         self.defineRequiredParameter(
89             name     = "SampleAsMinMaxStepHyperCube",
90             default  = [],
91             typecast = tuple,
92             message  = "Points de calcul définis par un hyper-cube dont on donne la liste des échantillonnages de chaque variable par un triplet [min,max,step]",
93             )
94         self.defineRequiredParameter(
95             name     = "SampleAsIndependantRandomVariables",
96             default  = [],
97             typecast = tuple,
98             message  = "Points de calcul définis par un hyper-cube dont les points sur chaque axe proviennent de l'échantillonnage indépendant de la variable selon la spécification ['distribution',[parametres],nombre]",
99             )
100         self.defineRequiredParameter(
101             name     = "SetDebug",
102             default  = False,
103             typecast = bool,
104             message  = "Activation du mode debug lors de l'exécution",
105             )
106         self.defineRequiredParameter(
107             name     = "StoreSupplementaryCalculations",
108             default  = [],
109             typecast = tuple,
110             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
111             listval  = [
112                 "EnsembleOfSimulations",
113                 "EnsembleOfStates",
114                 "OptimalPoints",
115                 "ReducedBasis",
116                 "Residus",
117                 ]
118             )
119         self.defineRequiredParameter(
120             name     = "SetSeed",
121             typecast = numpy.random.seed,
122             message  = "Graine fixée pour le générateur aléatoire",
123             )
124         self.requireInputArguments(
125             mandatory= (),
126             optional = ("Xb", "HO"),
127             )
128         self.setAttributes(tags=(
129             "Reduction",
130             ))
131
132     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
133         self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q)
134         #
135         #--------------------------
136         if   self._parameters["Variant"] == "PositioningBylcEIM":
137             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
138                 if self._toStore("EnsembleOfSimulations"):
139                     self.StoredVariables["EnsembleOfSimulations"].store( self._parameters["EnsembleOfSnapshots"] )
140                 ecweim.EIM_offline(self, self._parameters["EnsembleOfSnapshots"])
141             elif isinstance(HO, dict):
142                 ecweim.EIM_offline(self, eosg.eosg(self, Xb, HO))
143             else:
144                 raise ValueError("Snapshots or Operator have to be given in order to launch the analysis")
145         #
146         elif self._parameters["Variant"] == "PositioningByEIM":
147             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
148                 if self._toStore("EnsembleOfSimulations"):
149                     self.StoredVariables["EnsembleOfSimulations"].store( self._parameters["EnsembleOfSnapshots"] )
150                 ecweim.EIM_offline(self, self._parameters["EnsembleOfSnapshots"])
151             elif isinstance(HO, dict):
152                 ecweim.EIM_offline(self, eosg.eosg(self, Xb, HO))
153             else:
154                 raise ValueError("Snapshots or Operator have to be given in order to launch the analysis")
155         #
156         #--------------------------
157         else:
158             raise ValueError("Error in Variant name: %s"%self._parameters["Variant"])
159         #
160         self._post_run(HO)
161         return 0
162
163 # ==============================================================================
164 if __name__ == "__main__":
165     print('\n AUTODIAGNOSTIC\n')