src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py

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