src/daComposant/daAlgorithms/LinearityTest.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2018 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 sys, logging
  24 from daCore import BasicObjects, PlatformInfo
  25 import numpy, math
  26 mpr = PlatformInfo.PlatformInfo().MachinePrecision()
  27 if sys.version_info.major > 2:
  28     unicode = str
  29
  30 # ==============================================================================
  31 class ElementaryAlgorithm(BasicObjects.Algorithm):
  32     def __init__(self):
  33         BasicObjects.Algorithm.__init__(self, "LINEARITYTEST")
  34         self.defineRequiredParameter(
  35             name     = "ResiduFormula",
  36             default  = "CenteredDL",
  37             typecast = str,
  38             message  = "Formule de résidu utilisée",
  39             listval  = ["CenteredDL", "Taylor", "NominalTaylor", "NominalTaylorRMS"],
  40             )
  41         self.defineRequiredParameter(
  42             name     = "EpsilonMinimumExponent",
  43             default  = -8,
  44             typecast = int,
  45             message  = "Exposant minimal en puissance de 10 pour le multiplicateur d'incrément",
  46             minval   = -20,
  47             maxval   = 0,
  48             )
  49         self.defineRequiredParameter(
  50             name     = "InitialDirection",
  51             default  = [],
  52             typecast = list,
  53             message  = "Direction initiale de la dérivée directionnelle autour du point nominal",
  54             )
  55         self.defineRequiredParameter(
  56             name     = "AmplitudeOfInitialDirection",
  57             default  = 1.,
  58             typecast = float,
  59             message  = "Amplitude de la direction initiale de la dérivée directionnelle autour du point nominal",
  60             )
  61         self.defineRequiredParameter(
  62             name     = "AmplitudeOfTangentPerturbation",
  63             default  = 1.e-2,
  64             typecast = float,
  65             message  = "Amplitude de la perturbation pour le calcul de la forme tangente",
  66             minval   = 1.e-10,
  67             maxval   = 1.,
  68             )
  69         self.defineRequiredParameter(
  70             name     = "SetSeed",
  71             typecast = numpy.random.seed,
  72             message  = "Graine fixée pour le générateur aléatoire",
  73             )
  74         self.defineRequiredParameter(
  75             name     = "ResultTitle",
  76             default  = "",
  77             typecast = str,
  78             message  = "Titre du tableau et de la figure",
  79             )
  80         self.defineRequiredParameter(
  81             name     = "StoreSupplementaryCalculations",
  82             default  = [],
  83             typecast = tuple,
  84             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
  85             listval  = ["CurrentState", "Residu", "SimulatedObservationAtCurrentState"]
  86             )
  87         self.requireInputArguments(
  88             mandatory= ("Xb", "HO"),
  89             )
  90
  91     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
  92         self._pre_run(Parameters, Xb, Y, R, B, Q)
  93         #
  94         def RMS(V1, V2):
  95             import math
  96             return math.sqrt( ((numpy.ravel(V2) - numpy.ravel(V1))**2).sum() / float(numpy.ravel(V1).size) )
  97         #
  98         # Operateurs
  99         # ----------
 100         Hm = HO["Direct"].appliedTo
 101         if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
 102             Ht = HO["Tangent"].appliedInXTo
 103         #
 104         # Construction des perturbations
 105         # ------------------------------
 106         Perturbations = [ 10**i for i in range(self._parameters["EpsilonMinimumExponent"],1) ]
 107         Perturbations.reverse()
 108         #
 109         # Calcul du point courant
 110         # -----------------------
 111         Xn      = numpy.asmatrix(numpy.ravel( Xb )).T
 112         FX      = numpy.asmatrix(numpy.ravel( Hm( Xn ) )).T
 113         NormeX  = numpy.linalg.norm( Xn )
 114         NormeFX = numpy.linalg.norm( FX )
 115         if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 116             self.StoredVariables["CurrentState"].store( numpy.ravel(Xn) )
 117         if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 118             self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX) )
 119         #
 120         # Fabrication de la direction de l'increment dX
 121         # ---------------------------------------------
 122         if len(self._parameters["InitialDirection"]) == 0:
 123             dX0 = []
 124             for v in Xn.A1:
 125                 if abs(v) > 1.e-8:
 126                     dX0.append( numpy.random.normal(0.,abs(v)) )
 127                 else:
 128                     dX0.append( numpy.random.normal(0.,Xn.mean()) )
 129         else:
 130             dX0 = numpy.ravel( self._parameters["InitialDirection"] )
 131         #
 132         dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
 133         #
 134         # Calcul du gradient au point courant X pour l'increment dX
 135         # ---------------------------------------------------------
 136         if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
 137             dX1      = float(self._parameters["AmplitudeOfTangentPerturbation"]) * dX0
 138             GradFxdX = Ht( (Xn, dX1) )
 139             GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
 140             GradFxdX = float(1./self._parameters["AmplitudeOfTangentPerturbation"]) * GradFxdX
 141         #
 142         # Entete des resultats
 143         # --------------------
 144         __marge =  12*u" "
 145         __precision = u"""
 146             Remarque : les nombres inferieurs a %.0e (environ) representent un zero
 147                        a la precision machine.\n"""%mpr
 148         if self._parameters["ResiduFormula"] == "CenteredDL":
 149             __entete = u"  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)  log10( R )"
 150             __msgdoc = u"""
 151             On observe le residu provenant de la difference centree des valeurs de F
 152             au point nominal et aux points perturbes, normalisee par la valeur au
 153             point nominal :
 154
 155                          || F(X+Alpha*dX) + F(X-Alpha*dX) - 2*F(X) ||
 156               R(Alpha) = --------------------------------------------
 157                                          || F(X) ||
 158
 159             S'il reste constamment tres faible par rapport a 1, l'hypothese de linearite
 160             de F est verifiee.
 161
 162             Si le residu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
 163             faible qu'a partir d'un certain ordre d'increment, l'hypothese de linearite
 164             de F n'est pas verifiee.
 165
 166             Si le residu decroit et que la decroissance se fait en Alpha**2 selon Alpha,
 167             cela signifie que le gradient est calculable jusqu'a la precision d'arret
 168             de la decroissance quadratique.
 169
 170             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
 171         if self._parameters["ResiduFormula"] == "Taylor":
 172             __entete = u"  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)  log10( R )"
 173             __msgdoc = u"""
 174             On observe le residu issu du developpement de Taylor de la fonction F,
 175             normalisee par la valeur au point nominal :
 176
 177                          || F(X+Alpha*dX) - F(X) - Alpha * GradientF_X(dX) ||
 178               R(Alpha) = ----------------------------------------------------
 179                                          || F(X) ||
 180
 181             S'il reste constamment tres faible par rapport a 1, l'hypothese de linearite
 182             de F est verifiee.
 183
 184             Si le residu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
 185             faible qu'a partir d'un certain ordre d'increment, l'hypothese de linearite
 186             de F n'est pas verifiee.
 187
 188             Si le residu decroit et que la decroissance se fait en Alpha**2 selon Alpha,
 189             cela signifie que le gradient est bien calcule jusqu'a la precision d'arret
 190             de la decroissance quadratique.
 191
 192             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
 193         if self._parameters["ResiduFormula"] == "NominalTaylor":
 194             __entete = u"  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)   |R-1| en %"
 195             __msgdoc = u"""
 196             On observe le residu obtenu a partir de deux approximations d'ordre 1 de F(X),
 197             normalisees par la valeur au point nominal :
 198
 199               R(Alpha) = max(
 200                 || F(X+Alpha*dX) - Alpha * F(dX) || / || F(X) ||,
 201                 || F(X-Alpha*dX) + Alpha * F(dX) || / || F(X) ||,
 202               )
 203
 204             S'il reste constamment egal a 1 a moins de 2 ou 3 pourcents pres (c'est-a-dire
 205             que |R-1| reste egal a 2 ou 3 pourcents), c'est que l'hypothese de linearite
 206             de F est verifiee.
 207
 208             S'il est egal a 1 sur une partie seulement du domaine de variation de
 209             l'increment Alpha, c'est sur cette partie que l'hypothese de linearite de F
 210             est verifiee.
 211
 212             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
 213         if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
 214             __entete = u"  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)    |R| en %"
 215             __msgdoc = u"""
 216             On observe le residu obtenu a partir de deux approximations d'ordre 1 de F(X),
 217             normalisees par la valeur au point nominal :
 218
 219               R(Alpha) = max(
 220                 RMS( F(X), F(X+Alpha*dX) - Alpha * F(dX) ) / || F(X) ||,
 221                 RMS( F(X), F(X-Alpha*dX) + Alpha * F(dX) ) / || F(X) ||,
 222               )
 223
 224             S'il reste constamment egal a 0 a moins de 1 ou 2 pourcents pres, c'est
 225             que l'hypothese de linearite de F est verifiee.
 226
 227             S'il est egal a 0 sur une partie seulement du domaine de variation de
 228             l'increment Alpha, c'est sur cette partie que l'hypothese de linearite de F
 229             est verifiee.
 230
 231             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
 232         #
 233         if len(self._parameters["ResultTitle"]) > 0:
 234             __rt = unicode(self._parameters["ResultTitle"])
 235             msgs  = u"\n"
 236             msgs += __marge + "====" + "="*len(__rt) + "====\n"
 237             msgs += __marge + "    " + __rt + "\n"
 238             msgs += __marge + "====" + "="*len(__rt) + "====\n"
 239         else:
 240             msgs  = u""
 241         msgs += __msgdoc
 242         #
 243         __nbtirets = len(__entete) + 2
 244         msgs += "\n" + __marge + "-"*__nbtirets
 245         msgs += "\n" + __marge + __entete
 246         msgs += "\n" + __marge + "-"*__nbtirets
 247         #
 248         # Boucle sur les perturbations
 249         # ----------------------------
 250         for i,amplitude in enumerate(Perturbations):
 251             dX      = amplitude * dX0
 252             #
 253             if self._parameters["ResiduFormula"] == "CenteredDL":
 254                 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 255                     self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
 256                     self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
 257                 #
 258                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 259                 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
 260                 #
 261                 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 262                     self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
 263                     self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
 264                 #
 265                 Residu = numpy.linalg.norm( FX_plus_dX + FX_moins_dX - 2 * FX ) / NormeFX
 266                 #
 267                 self.StoredVariables["Residu"].store( Residu )
 268                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %9.3e   %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
 269                 msgs += "\n" + __marge + msg
 270             #
 271             if self._parameters["ResiduFormula"] == "Taylor":
 272                 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 273                     self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
 274                 #
 275                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 276                 #
 277                 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 278                     self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
 279                 #
 280                 Residu = numpy.linalg.norm( FX_plus_dX - FX - amplitude * GradFxdX ) / NormeFX
 281                 #
 282                 self.StoredVariables["Residu"].store( Residu )
 283                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %9.3e   %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
 284                 msgs += "\n" + __marge + msg
 285             #
 286             if self._parameters["ResiduFormula"] == "NominalTaylor":
 287                 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 288                     self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
 289                     self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
 290                     self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
 291                 #
 292                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 293                 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
 294                 FdX         = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
 295                 #
 296                 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 297                     self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
 298                     self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
 299                     self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
 300                 #
 301                 Residu = max(
 302                     numpy.linalg.norm( FX_plus_dX  - amplitude * FdX ) / NormeFX,
 303                     numpy.linalg.norm( FX_moins_dX + amplitude * FdX ) / NormeFX,
 304                     )
 305                 #
 306                 self.StoredVariables["Residu"].store( Residu )
 307                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %9.3e   %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*abs(Residu-1.),"%")
 308                 msgs += "\n" + __marge + msg
 309             #
 310             if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
 311                 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 312                     self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
 313                     self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
 314                     self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
 315                 #
 316                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 317                 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
 318                 FdX         = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
 319                 #
 320                 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 321                     self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
 322                     self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
 323                     self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
 324                 #
 325                 Residu = max(
 326                     RMS( FX, FX_plus_dX   - amplitude * FdX ) / NormeFX,
 327                     RMS( FX, FX_moins_dX  + amplitude * FdX ) / NormeFX,
 328                     )
 329                 #
 330                 self.StoredVariables["Residu"].store( Residu )
 331                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %9.3e   %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*Residu,"%")
 332                 msgs += "\n" + __marge + msg
 333         #
 334         msgs += "\n" + __marge + "-"*__nbtirets
 335         msgs += "\n"
 336         #
 337         # Sorties eventuelles
 338         # -------------------
 339         print("\nResults of linearity check by \"%s\" formula:"%self._parameters["ResiduFormula"])
 340         print(msgs)
 341         #
 342         self._post_run(HO)
 343         return 0
 344
 345 # ==============================================================================
 346 if __name__ == "__main__":
 347     print('\n AUTODIAGNOSTIC \n')