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