]> SALOME platform Git repositories - modules/adao.git/blob - src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py
Salome HOME
Documentation and code update for PSO
[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, eosg
26
27 # ==============================================================================
28 class ElementaryAlgorithm(BasicObjects.Algorithm):
29     def __init__(self):
30         BasicObjects.Algorithm.__init__(self, "MEASUREMENTSOPTIMALPOSITIONING")
31         self.defineRequiredParameter(
32             name     = "Variant",
33             default  = "PositioningBylcEIM",
34             typecast = str,
35             message  = "Variant ou formulation de la méthode",
36             listval  = [
37                 "PositioningByEIM",
38                 "PositioningBylcEIM",
39                 ],
40             )
41         self.defineRequiredParameter(
42             name     = "EnsembleOfSnapshots",
43             default  = [],
44             typecast = numpy.array,
45             message  = "Ensemble de vecteurs d'état physique (snapshots), 1 état par colonne",
46             )
47         self.defineRequiredParameter(
48             name     = "MaximumNumberOfLocations",
49             default  = 1,
50             typecast = int,
51             message  = "Nombre maximal de positions",
52             minval   = 0,
53             )
54         self.defineRequiredParameter(
55             name     = "ExcludeLocations",
56             default  = [],
57             typecast = tuple,
58             message  = "Liste des indices ou noms de positions exclues selon l'ordre interne d'un snapshot",
59             )
60         self.defineRequiredParameter(
61             name     = "NameOfLocations",
62             default  = [],
63             typecast = tuple,
64             message  = "Liste des noms de positions selon l'ordre interne d'un snapshot",
65             )
66         self.defineRequiredParameter(
67             name     = "ErrorNorm",
68             default  = "L2",
69             typecast = str,
70             message  = "Norme d'erreur utilisée pour le critère d'optimalité des positions",
71             listval  = ["L2", "Linf"]
72             )
73         self.defineRequiredParameter(
74             name     = "ErrorNormTolerance",
75             default  = 1.e-7,
76             typecast = float,
77             message  = "Valeur limite inférieure du critère d'optimalité forçant l'arrêt",
78             minval   = 0.,
79             )
80         self.defineRequiredParameter(
81             name     = "SampleAsnUplet",
82             default  = [],
83             typecast = tuple,
84             message  = "Points de calcul définis par une liste de n-uplet",
85             )
86         self.defineRequiredParameter(
87             name     = "SampleAsExplicitHyperCube",
88             default  = [],
89             typecast = tuple,
90             message  = "Points de calcul définis par un hyper-cube dont on donne la liste des échantillonnages de chaque variable comme une liste",
91             )
92         self.defineRequiredParameter(
93             name     = "SampleAsMinMaxStepHyperCube",
94             default  = [],
95             typecast = tuple,
96             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]",
97             )
98         self.defineRequiredParameter(
99             name     = "SampleAsIndependantRandomVariables",
100             default  = [],
101             typecast = tuple,
102             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]",
103             )
104         self.defineRequiredParameter(
105             name     = "SetDebug",
106             default  = False,
107             typecast = bool,
108             message  = "Activation du mode debug lors de l'exécution",
109             )
110         self.defineRequiredParameter(
111             name     = "StoreSupplementaryCalculations",
112             default  = [],
113             typecast = tuple,
114             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
115             listval  = [
116                 "EnsembleOfSimulations",
117                 "EnsembleOfStates",
118                 "ExcludedPoints",
119                 "OptimalPoints",
120                 "ReducedBasis",
121                 "Residus",
122                 ]
123             )
124         self.defineRequiredParameter(
125             name     = "SetSeed",
126             typecast = numpy.random.seed,
127             message  = "Graine fixée pour le générateur aléatoire",
128             )
129         self.requireInputArguments(
130             mandatory= (),
131             optional = ("Xb", "HO"),
132             )
133         self.setAttributes(tags=(
134             "Reduction",
135             "Checking",
136             ))
137
138     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
139         self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q)
140         #
141         #--------------------------
142         if   self._parameters["Variant"] == "PositioningBylcEIM":
143             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
144                 if self._toStore("EnsembleOfSimulations"):
145                     self.StoredVariables["EnsembleOfSimulations"].store( self._parameters["EnsembleOfSnapshots"] )
146                 ecweim.EIM_offline(self, self._parameters["EnsembleOfSnapshots"])
147             elif isinstance(HO, dict):
148                 ecweim.EIM_offline(self, eosg.eosg(self, Xb, HO))
149             else:
150                 raise ValueError("Snapshots or Operator have to be given in order to launch the analysis")
151         #
152         elif self._parameters["Variant"] == "PositioningByEIM":
153             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
154                 if self._toStore("EnsembleOfSimulations"):
155                     self.StoredVariables["EnsembleOfSimulations"].store( self._parameters["EnsembleOfSnapshots"] )
156                 ecweim.EIM_offline(self, self._parameters["EnsembleOfSnapshots"])
157             elif isinstance(HO, dict):
158                 ecweim.EIM_offline(self, eosg.eosg(self, Xb, HO))
159             else:
160                 raise ValueError("Snapshots or Operator have to be given in order to launch the analysis")
161         #
162         #--------------------------
163         else:
164             raise ValueError("Error in Variant name: %s"%self._parameters["Variant"])
165         #
166         self._post_run(HO)
167         return 0
168
169 # ==============================================================================
170 if __name__ == "__main__":
171     print('\n AUTODIAGNOSTIC\n')