Salome HOME
Minor documentation and code review corrections (34)
[modules/adao.git] / src / daComposant / daAlgorithms / MeasurementsOptimalPositioningTask.py
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright (C) 2008-2022 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
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 positions exclues selon la numérotation interne d'un snapshot",
59             minval   = -1,
60             )
61         self.defineRequiredParameter(
62             name     = "ErrorNorm",
63             default  = "L2",
64             typecast = str,
65             message  = "Norme d'erreur utilisée pour le critère d'optimalité des positions",
66             listval  = ["L2", "Linf"]
67             )
68         self.defineRequiredParameter(
69             name     = "ErrorNormTolerance",
70             default  = 1.e-7,
71             typecast = float,
72             message  = "Valeur limite inférieure du critère d'optimalité forçant l'arrêt",
73             minval   = 0.,
74             )
75         self.defineRequiredParameter(
76             name     = "StoreSupplementaryCalculations",
77             default  = [],
78             typecast = tuple,
79             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
80             listval  = [
81                 "EnsembleOfSnapshots",
82                 "OptimalPoints",
83                 "ReducedBasis",
84                 "Residus",
85                 ]
86             )
87         self.requireInputArguments(
88             mandatory= (),
89             optional = ("Xb", "HO"),
90             )
91         self.setAttributes(tags=(
92             "Reduction",
93             ))
94
95     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
96         self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q)
97         #
98         #--------------------------
99         if   self._parameters["Variant"] == "PositioningBylcEIM":
100             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
101                 if self._toStore("EnsembleOfSnapshots"):
102                     self.StoredVariables["EnsembleOfSnapshots"].store( self._parameters["EnsembleOfSnapshots"] )
103                 ecweim.EIM_offline(self)
104             else:
105                 raise ValueError("Snapshots have to be given in order to launch the positionning analysis")
106         #
107         elif self._parameters["Variant"] == "PositioningByEIM":
108             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
109                 if self._toStore("EnsembleOfSnapshots"):
110                     self.StoredVariables["EnsembleOfSnapshots"].store( self._parameters["EnsembleOfSnapshots"] )
111                 ecweim.EIM_offline(self)
112             else:
113                 raise ValueError("Snapshots have to be given in order to launch the positionning analysis")
114         #
115         #--------------------------
116         else:
117             raise ValueError("Error in Variant name: %s"%self._parameters["Variant"])
118         #
119         self._post_run(HO)
120         return 0
121
122 # ==============================================================================
123 if __name__ == "__main__":
124     print('\n AUTODIAGNOSTIC\n')