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, ecwdeim, 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  = "lcEIM",
  34             typecast = str,
  35             message  = "Variant ou formulation de la méthode",
  36             listval  = [
  37                 "EIM",    "PositioningByEIM",
  38                 "lcEIM",  "PositioningBylcEIM",
  39                 "DEIM",   "PositioningByDEIM",
  40                 "lcDEIM", "PositioningBylcDEIM",
  41                 ],
  42             )
  43         self.defineRequiredParameter(
  44             name     = "EnsembleOfSnapshots",
  45             default  = [],
  46             typecast = numpy.array,
  47             message  = "Ensemble de vecteurs d'état physique (snapshots), 1 état par colonne (Training Set)",
  48             )
  49         self.defineRequiredParameter(
  50             name     = "MaximumNumberOfLocations",
  51             default  = 1,
  52             typecast = int,
  53             message  = "Nombre maximal de positions",
  54             minval   = 0,
  55             )
  56         self.defineRequiredParameter(
  57             name     = "ExcludeLocations",
  58             default  = [],
  59             typecast = tuple,
  60             message  = "Liste des indices ou noms de positions exclues selon l'ordre interne d'un snapshot",
  61             )
  62         self.defineRequiredParameter(
  63             name     = "NameOfLocations",
  64             default  = [],
  65             typecast = tuple,
  66             message  = "Liste des noms de positions selon l'ordre interne d'un snapshot",
  67             )
  68         self.defineRequiredParameter(
  69             name     = "ErrorNorm",
  70             default  = "L2",
  71             typecast = str,
  72             message  = "Norme d'erreur utilisée pour le critère d'optimalité des positions",
  73             listval  = ["L2", "Linf"]
  74             )
  75         self.defineRequiredParameter(
  76             name     = "ErrorNormTolerance",
  77             default  = 1.e-7,
  78             typecast = float,
  79             message  = "Valeur limite inférieure du critère d'optimalité forçant l'arrêt",
  80             minval   = 0.,
  81             )
  82         self.defineRequiredParameter(
  83             name     = "SampleAsnUplet",
  84             default  = [],
  85             typecast = tuple,
  86             message  = "Points de calcul définis par une liste de n-uplet",
  87             )
  88         self.defineRequiredParameter(
  89             name     = "SampleAsExplicitHyperCube",
  90             default  = [],
  91             typecast = tuple,
  92             message  = "Points de calcul définis par un hyper-cube dont on donne la liste des échantillonnages explicites de chaque variable comme une liste",
  93             )
  94         self.defineRequiredParameter(
  95             name     = "SampleAsMinMaxStepHyperCube",
  96             default  = [],
  97             typecast = tuple,
  98             message  = "Points de calcul définis par un hyper-cube dont on donne la liste des échantillonnages implicites de chaque variable par un triplet [min,max,step]",
  99             )
 100         self.defineRequiredParameter(
 101             name     = "SampleAsMinMaxLatinHyperCube",
 102             default  = [],
 103             typecast = tuple,
 104             message  = "Points de calcul définis par un hyper-cube Latin dont on donne les bornes de chaque variable par une paire [min,max], suivi du nombre de points demandés",
 105             )
 106         self.defineRequiredParameter(
 107             name     = "SampleAsIndependantRandomVariables",
 108             default  = [],
 109             typecast = tuple,
 110             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]",
 111             )
 112         self.defineRequiredParameter(
 113             name     = "SetDebug",
 114             default  = False,
 115             typecast = bool,
 116             message  = "Activation du mode debug lors de l'exécution",
 117             )
 118         self.defineRequiredParameter(
 119             name     = "StoreSupplementaryCalculations",
 120             default  = [],
 121             typecast = tuple,
 122             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
 123             listval  = [
 124                 "EnsembleOfSimulations",
 125                 "EnsembleOfStates",
 126                 "ExcludedPoints",
 127                 "OptimalPoints",
 128                 "ReducedBasis",
 129                 "Residus",
 130                 "SingularValues",
 131                 ]
 132             )
 133         self.defineRequiredParameter(
 134             name     = "SetSeed",
 135             typecast = numpy.random.seed,
 136             message  = "Graine fixée pour le générateur aléatoire",
 137             )
 138         self.requireInputArguments(
 139             mandatory= (),
 140             optional = ("Xb", "HO"),
 141             )
 142         self.setAttributes(tags=(
 143             "Reduction",
 144             "Checking",
 145             ))
 146
 147     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
 148         self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q)
 149         #
 150         #--------------------------
 151         if   self._parameters["Variant"] in ["lcEIM", "PositioningBylcEIM"]:
 152             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
 153                 if self._toStore("EnsembleOfSimulations"):
 154                     self.StoredVariables["EnsembleOfSimulations"].store( self._parameters["EnsembleOfSnapshots"] )
 155                 ecweim.EIM_offline(self, self._parameters["EnsembleOfSnapshots"])
 156             elif isinstance(HO, dict):
 157                 ecweim.EIM_offline(self, eosg.eosg(self, Xb, HO))
 158             else:
 159                 raise ValueError("Snapshots or Operator have to be given in order to launch the analysis")
 160         #
 161         elif self._parameters["Variant"] in ["EIM", "PositioningByEIM"]:
 162             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
 163                 if self._toStore("EnsembleOfSimulations"):
 164                     self.StoredVariables["EnsembleOfSimulations"].store( self._parameters["EnsembleOfSnapshots"] )
 165                 ecweim.EIM_offline(self, self._parameters["EnsembleOfSnapshots"])
 166             elif isinstance(HO, dict):
 167                 ecweim.EIM_offline(self, eosg.eosg(self, Xb, HO))
 168             else:
 169                 raise ValueError("Snapshots or Operator have to be given in order to launch the analysis")
 170         #
 171         #--------------------------
 172         elif self._parameters["Variant"] in ["lcDEIM", "PositioningBylcDEIM"]:
 173             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
 174                 if self._toStore("EnsembleOfSimulations"):
 175                     self.StoredVariables["EnsembleOfSimulations"].store( self._parameters["EnsembleOfSnapshots"] )
 176                 ecwdeim.DEIM_offline(self, self._parameters["EnsembleOfSnapshots"])
 177             elif isinstance(HO, dict):
 178                 ecwdeim.DEIM_offline(self, eosg.eosg(self, Xb, HO))
 179             else:
 180                 raise ValueError("Snapshots or Operator have to be given in order to launch the analysis")
 181         #
 182         elif self._parameters["Variant"] in ["DEIM", "PositioningByDEIM"]:
 183             if len(self._parameters["EnsembleOfSnapshots"]) > 0:
 184                 if self._toStore("EnsembleOfSimulations"):
 185                     self.StoredVariables["EnsembleOfSimulations"].store( self._parameters["EnsembleOfSnapshots"] )
 186                 ecwdeim.DEIM_offline(self, self._parameters["EnsembleOfSnapshots"])
 187             elif isinstance(HO, dict):
 188                 ecwdeim.DEIM_offline(self, eosg.eosg(self, Xb, HO))
 189             else:
 190                 raise ValueError("Snapshots or Operator have to be given in order to launch the analysis")
 191         #
 192         #--------------------------
 193         else:
 194             raise ValueError("Error in Variant name: %s"%self._parameters["Variant"])
 195         #
 196         self._post_run(HO)
 197         return 0
 198
 199 # ==============================================================================
 200 if __name__ == "__main__":
 201     print("\n AUTODIAGNOSTIC\n")