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