src/daComposant/daAlgorithms/LinearityTest.py

   1 #-*-coding:iso-8859-1-*-
   2 #
   3 #  Copyright (C) 2008-2015 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 logging
  24 from daCore import BasicObjects
  25 import numpy, math
  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
  78     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
  79         self._pre_run()
  80         #
  81         # Paramètres de pilotage
  82         # ----------------------
  83         self.setParameters(Parameters)
  84         #
  85         def RMS(V1, V2):
  86             import math
  87             return math.sqrt( ((numpy.ravel(V2) - numpy.ravel(V1))**2).sum() / float(numpy.ravel(V1).size) )
  88         #
  89         # Opérateurs
  90         # ----------
  91         Hm = HO["Direct"].appliedTo
  92         if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
  93             Ht = HO["Tangent"].appliedInXTo
  94         #
  95         # Construction des perturbations
  96         # ------------------------------
  97         Perturbations = [ 10**i for i in xrange(self._parameters["EpsilonMinimumExponent"],1) ]
  98         Perturbations.reverse()
  99         #
 100         # Calcul du point courant
 101         # -----------------------
 102         Xn      = numpy.asmatrix(numpy.ravel( Xb )).T
 103         FX      = numpy.asmatrix(numpy.ravel( Hm( Xn ) )).T
 104         NormeX  = numpy.linalg.norm( Xn )
 105         NormeFX = numpy.linalg.norm( FX )
 106         #
 107         # Fabrication de la direction de  l'incrément dX
 108         # ----------------------------------------------
 109         if len(self._parameters["InitialDirection"]) == 0:
 110             dX0 = []
 111             for v in Xn.A1:
 112                 if abs(v) > 1.e-8:
 113                     dX0.append( numpy.random.normal(0.,abs(v)) )
 114                 else:
 115                     dX0.append( numpy.random.normal(0.,Xn.mean()) )
 116         else:
 117             dX0 = numpy.ravel( self._parameters["InitialDirection"] )
 118         #
 119         dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
 120         #
 121         # Calcul du gradient au point courant X pour l'incrément dX
 122         # ---------------------------------------------------------
 123         if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
 124             dX1      = float(self._parameters["AmplitudeOfTangentPerturbation"]) * dX0
 125             GradFxdX = Ht( (Xn, dX1) )
 126             GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
 127             GradFxdX = float(1./self._parameters["AmplitudeOfTangentPerturbation"]) * GradFxdX
 128         #
 129         # Entete des resultats
 130         # --------------------
 131         __marge =  12*" "
 132         if self._parameters["ResiduFormula"] == "CenteredDL":
 133             __entete = "  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)  log10( R )  "
 134             __msgdoc = """
 135             On observe le résidu provenant de la différence centrée des valeurs de F
 136             au point nominal et aux points perturbés, normalisée par la valeur au
 137             point nominal :
 138
 139                          || F(X+Alpha*dX) + F(X-Alpha*dX) - 2*F(X) ||
 140               R(Alpha) = --------------------------------------------
 141                                          || F(X) ||
 142
 143             S'il reste constamment trés faible par rapport à 1, l'hypothèse de linéarité
 144             de F est vérifiée.
 145
 146             Si le résidu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
 147             faible qu'à partir d'un certain ordre d'incrément, l'hypothèse de linéarité
 148             de F n'est pas vérifiée.
 149
 150             Si le résidu décroit et que la décroissance se fait en Alpha**2 selon Alpha,
 151             cela signifie que le gradient est calculable jusqu'à la précision d'arrêt
 152             de la décroissance quadratique.
 153
 154             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
 155             """
 156         if self._parameters["ResiduFormula"] == "Taylor":
 157             __entete = "  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)  log10( R )  "
 158             __msgdoc = """
 159             On observe le résidu issu du développement de Taylor de la fonction F,
 160             normalisée par la valeur au point nominal :
 161
 162                          || F(X+Alpha*dX) - F(X) - Alpha * GradientF_X(dX) ||
 163               R(Alpha) = ----------------------------------------------------
 164                                          || F(X) ||
 165
 166             S'il reste constamment trés faible par rapport à 1, l'hypothèse de linéarité
 167             de F est vérifiée.
 168
 169             Si le résidu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
 170             faible qu'à partir d'un certain ordre d'incrément, l'hypothèse de linéarité
 171             de F n'est pas vérifiée.
 172
 173             Si le résidu décroit et que la décroissance se fait en Alpha**2 selon Alpha,
 174             cela signifie que le gradient est bien calculé jusqu'à la précision d'arrêt
 175             de la décroissance quadratique.
 176
 177             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
 178             """
 179         if self._parameters["ResiduFormula"] == "NominalTaylor":
 180             __entete = "  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)   |R-1| en %  "
 181             __msgdoc = """
 182             On observe le résidu obtenu à partir de deux approximations d'ordre 1 de F(X),
 183             normalisées par la valeur au point nominal :
 184
 185               R(Alpha) = max(
 186                 || F(X+Alpha*dX) - Alpha * F(dX) || / || F(X) ||,
 187                 || F(X-Alpha*dX) + Alpha * F(dX) || / || F(X) ||,
 188               )
 189
 190             S'il reste constamment égal à 1 à moins de 2 ou 3 pourcents prés (c'est-à-dire
 191             que |R-1| reste égal à 2 ou 3 pourcents), c'est que l'hypothèse de linéarité
 192             de F est vérifiée.
 193
 194             S'il est égal à 1 sur une partie seulement du domaine de variation de
 195             l'incrément Alpha, c'est sur cette partie que l'hypothèse de linéarité de F
 196             est vérifiée.
 197
 198             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
 199             """
 200         if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
 201             __entete = "  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)    |R| en %  "
 202             __msgdoc = """
 203             On observe le résidu obtenu à partir de deux approximations d'ordre 1 de F(X),
 204             normalisées par la valeur au point nominal :
 205
 206               R(Alpha) = max(
 207                 RMS( F(X), F(X+Alpha*dX) - Alpha * F(dX) ) / || F(X) ||,
 208                 RMS( F(X), F(X-Alpha*dX) + Alpha * F(dX) ) / || F(X) ||,
 209               )
 210
 211             S'il reste constamment égal à 0 à moins de 1 ou 2 pourcents prés, c'est
 212             que l'hypothèse de linéarité de F est vérifiée.
 213
 214             S'il est égal à 0 sur une partie seulement du domaine de variation de
 215             l'incrément Alpha, c'est sur cette partie que l'hypothèse de linéarité de F
 216             est vérifiée.
 217
 218             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
 219             """
 220         #
 221         if len(self._parameters["ResultTitle"]) > 0:
 222             msgs  = "\n"
 223             msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
 224             msgs += __marge + "    " + self._parameters["ResultTitle"] + "\n"
 225             msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
 226         else:
 227             msgs  = ""
 228         msgs += __msgdoc
 229         #
 230         __nbtirets = len(__entete)
 231         msgs += "\n" + __marge + "-"*__nbtirets
 232         msgs += "\n" + __marge + __entete
 233         msgs += "\n" + __marge + "-"*__nbtirets
 234         #
 235         # Boucle sur les perturbations
 236         # ----------------------------
 237         for i,amplitude in enumerate(Perturbations):
 238             dX      = amplitude * dX0
 239             #
 240             if self._parameters["ResiduFormula"] == "CenteredDL":
 241                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 242                 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
 243                 #
 244                 Residu = numpy.linalg.norm( FX_plus_dX + FX_moins_dX - 2 * FX ) / NormeFX
 245                 #
 246                 self.StoredVariables["CostFunctionJ"].store( Residu )
 247                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %9.3e   %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
 248                 msgs += "\n" + __marge + msg
 249             #
 250             if self._parameters["ResiduFormula"] == "Taylor":
 251                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 252                 #
 253                 Residu = numpy.linalg.norm( FX_plus_dX - FX - amplitude * GradFxdX ) / NormeFX
 254                 #
 255                 self.StoredVariables["CostFunctionJ"].store( Residu )
 256                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %9.3e   %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
 257                 msgs += "\n" + __marge + msg
 258             #
 259             if self._parameters["ResiduFormula"] == "NominalTaylor":
 260                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 261                 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
 262                 FdX         = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
 263                 #
 264                 Residu = max(
 265                     numpy.linalg.norm( FX_plus_dX  - amplitude * FdX ) / NormeFX,
 266                     numpy.linalg.norm( FX_moins_dX + amplitude * FdX ) / NormeFX,
 267                     )
 268                 #
 269                 self.StoredVariables["CostFunctionJ"].store( Residu )
 270                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %9.3e   %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*abs(Residu-1.),"%")
 271                 msgs += "\n" + __marge + msg
 272             #
 273             if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
 274                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 275                 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
 276                 FdX         = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
 277                 #
 278                 Residu = max(
 279                     RMS( FX, FX_plus_dX   - amplitude * FdX ) / NormeFX,
 280                     RMS( FX, FX_moins_dX  + amplitude * FdX ) / NormeFX,
 281                     )
 282                 #
 283                 self.StoredVariables["CostFunctionJ"].store( Residu )
 284                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %9.3e   %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*Residu,"%")
 285                 msgs += "\n" + __marge + msg
 286         #
 287         msgs += "\n" + __marge + "-"*__nbtirets
 288         msgs += "\n"
 289         #
 290         # Sorties eventuelles
 291         # -------------------
 292         print
 293         print "Results of linearity check by \"%s\" formula:"%self._parameters["ResiduFormula"]
 294         print msgs
 295         #
 296         self._post_run(HO)
 297         return 0
 298
 299 # ==============================================================================
 300 if __name__ == "__main__":
 301     print '\n AUTODIAGNOSTIC \n'