src/daComposant/daAlgorithms/GradientTest.py

   1 #-*-coding:iso-8859-1-*-
   2 #
   3 #  Copyright (C) 2008-2013 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, PlatformInfo
  25 m = PlatformInfo.SystemUsage()
  26
  27 import numpy
  28
  29 # ==============================================================================
  30 class ElementaryAlgorithm(BasicObjects.Algorithm):
  31     def __init__(self):
  32         BasicObjects.Algorithm.__init__(self, "GRADIENTTEST")
  33         self.defineRequiredParameter(
  34             name     = "ResiduFormula",
  35             default  = "Taylor",
  36             typecast = str,
  37             message  = "Formule de résidu utilisée",
  38             listval  = ["Norm", "Taylor"],
  39             )
  40         self.defineRequiredParameter(
  41             name     = "EpsilonMinimumExponent",
  42             default  = -8,
  43             typecast = int,
  44             message  = "Exposant minimal en puissance de 10 pour le multiplicateur d'incrément",
  45             minval   = -20,
  46             maxval   = 0,
  47             )
  48         self.defineRequiredParameter(
  49             name     = "InitialDirection",
  50             default  = [],
  51             typecast = list,
  52             message  = "Direction initiale de la dérivée directionnelle autour du point nominal",
  53             )
  54         self.defineRequiredParameter(
  55             name     = "AmplitudeOfInitialDirection",
  56             default  = 1.,
  57             typecast = float,
  58             message  = "Amplitude de la direction initiale de la dérivée directionnelle autour du point nominal",
  59             )
  60         self.defineRequiredParameter(
  61             name     = "SetSeed",
  62             typecast = numpy.random.seed,
  63             message  = "Graine fixée pour le générateur aléatoire",
  64             )
  65         self.defineRequiredParameter(
  66             name     = "PlotAndSave",
  67             default  = False,
  68             typecast = bool,
  69             message  = "Trace et sauve les résultats",
  70             )
  71         self.defineRequiredParameter(
  72             name     = "ResultFile",
  73             default  = self._name+"_result_file",
  74             typecast = str,
  75             message  = "Nom de base (hors extension) des fichiers de sauvegarde des résultats",
  76             )
  77         self.defineRequiredParameter(
  78             name     = "ResultTitle",
  79             default  = "",
  80             typecast = str,
  81             message  = "Titre du tableau et de la figure",
  82             )
  83         self.defineRequiredParameter(
  84             name     = "ResultLabel",
  85             default  = "",
  86             typecast = str,
  87             message  = "Label de la courbe tracée dans la figure",
  88             )
  89
  90     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
  91         logging.debug("%s Lancement"%self._name)
  92         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("M")))
  93         #
  94         # Paramètres de pilotage
  95         # ----------------------
  96         self.setParameters(Parameters)
  97         #
  98         # Opérateur d'observation
  99         # -----------------------
 100         Hm = HO["Direct"].appliedTo
 101         if self._parameters["ResiduFormula"] is "Taylor":
 102             Ht = HO["Tangent"].appliedInXTo
 103         #
 104         # Construction des perturbations
 105         # ------------------------------
 106         Perturbations = [ 10**i for i in xrange(self._parameters["EpsilonMinimumExponent"],1) ]
 107         Perturbations.reverse()
 108         #
 109         # Calcul du point courant
 110         # -----------------------
 111         X       = numpy.asmatrix(numpy.ravel(    Xb   )).T
 112         FX      = numpy.asmatrix(numpy.ravel( Hm( X ) )).T
 113         FX      = numpy.asmatrix(numpy.ravel(    FX   )).T
 114         NormeX  = numpy.linalg.norm( X )
 115         NormeFX = numpy.linalg.norm( FX )
 116         #
 117         # Fabrication de la direction de  l'incrément dX
 118         # ----------------------------------------------
 119         if len(self._parameters["InitialDirection"]) == 0:
 120             dX0 = []
 121             for v in X.A1:
 122                 if abs(v) > 1.e-8:
 123                     dX0.append( numpy.random.normal(0.,abs(v)) )
 124                 else:
 125                     dX0.append( numpy.random.normal(0.,X.mean()) )
 126         else:
 127             dX0 = numpy.ravel( self._parameters["InitialDirection"] )
 128         #
 129         dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
 130         #
 131         # Calcul du gradient au point courant X pour l'incrément dX
 132         # ---------------------------------------------------------
 133         if self._parameters["ResiduFormula"] is "Taylor":
 134             GradFxdX = Ht( (X, dX0) )
 135             GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
 136         #
 137         # Entete des resultats
 138         # --------------------
 139         if self._parameters["ResiduFormula"] is "Taylor":
 140             __doc__ = """
 141             On observe le residu issu du développement de Taylor de la fonction F :
 142
 143               R(Alpha) = || F(X+Alpha*dX) - F(X) - Alpha * TangentF_X(dX) ||
 144
 145             Ce résidu doit décroître en Alpha**2 selon Alpha.
 146             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
 147             """
 148         elif self._parameters["ResiduFormula"] is "Norm":
 149             __doc__ = """
 150             On observe le residu, qui est une approximation du gradient :
 151
 152                           || F(X+Alpha*dX) - F(X) ||
 153               R(Alpha) =  ---------------------------
 154                                     Alpha
 155
 156             qui doit rester constant jusqu'à ce qu'on atteigne la précision du calcul.
 157             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
 158             """
 159         else:
 160             __doc__ = ""
 161         #
 162         msgs  = "         ====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
 163         msgs += "             " + self._parameters["ResultTitle"] + "\n"
 164         msgs += "         ====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
 165         msgs += __doc__
 166         #
 167         msg = "  i   Alpha       ||X||    ||F(X)||  ||F(X+dX)||    ||dX||  ||F(X+dX)-F(X)||   ||F(X+dX)-F(X)||/||dX||      R(Alpha)  "
 168         nbtirets = len(msg)
 169         msgs += "\n" + "-"*nbtirets
 170         msgs += "\n" + msg
 171         msgs += "\n" + "-"*nbtirets
 172         #
 173         Normalisation= -1
 174         NormesdX     = []
 175         NormesFXdX   = []
 176         NormesdFX    = []
 177         NormesdFXsdX = []
 178         NormesdFXsAm = []
 179         NormesdFXGdX = []
 180         #
 181         # Boucle sur les perturbations
 182         # ----------------------------
 183         for i,amplitude in enumerate(Perturbations):
 184             dX      = amplitude * dX0
 185             #
 186             FX_plus_dX = Hm( X + dX )
 187             FX_plus_dX = numpy.asmatrix(numpy.ravel( FX_plus_dX )).T
 188             #
 189             NormedX     = numpy.linalg.norm( dX )
 190             NormeFXdX   = numpy.linalg.norm( FX_plus_dX )
 191             NormedFX    = numpy.linalg.norm( FX_plus_dX - FX )
 192             NormedFXsdX = NormedFX/NormedX
 193             # Residu Taylor
 194             if self._parameters["ResiduFormula"] is "Taylor":
 195                 NormedFXGdX = numpy.linalg.norm( FX_plus_dX - FX - amplitude * GradFxdX )
 196             # Residu Norm
 197             NormedFXsAm = NormedFX/amplitude
 198             #
 199             # if numpy.abs(NormedFX) < 1.e-20:
 200             #     break
 201             #
 202             NormesdX.append(     NormedX     )
 203             NormesFXdX.append(   NormeFXdX   )
 204             NormesdFX.append(    NormedFX    )
 205             if self._parameters["ResiduFormula"] is "Taylor":
 206                 NormesdFXGdX.append( NormedFXGdX )
 207             NormesdFXsdX.append( NormedFXsdX )
 208             NormesdFXsAm.append( NormedFXsAm )
 209             #
 210             if self._parameters["ResiduFormula"] is "Taylor":
 211                 Residu = NormedFXGdX
 212             elif self._parameters["ResiduFormula"] is "Norm":
 213                 Residu = NormedFXsAm
 214             if Normalisation < 0 : Normalisation = Residu
 215             #
 216             msg = "  %2i  %5.0e   %9.3e   %9.3e   %9.3e   %9.3e   %9.3e      |      %9.3e          |   %9.3e"%(i,amplitude,NormeX,NormeFX,NormeFXdX,NormedX,NormedFX,NormedFXsdX,Residu)
 217             msgs += "\n" + msg
 218             #
 219             self.StoredVariables["CostFunctionJ"].store( Residu )
 220         msgs += "\n" + "-"*nbtirets
 221         msgs += "\n"
 222         #
 223         # Sorties eventuelles
 224         # -------------------
 225         print
 226         print "Results of gradient stability check:"
 227         print msgs
 228         #
 229         if self._parameters["PlotAndSave"]:
 230             f = open(str(self._parameters["ResultFile"])+".txt",'a')
 231             f.write(msgs)
 232             f.close()
 233             #
 234             Residus = self.StoredVariables["CostFunctionJ"][-len(Perturbations):]
 235             if self._parameters["ResiduFormula"] is "Taylor":
 236                 PerturbationsCarre = [ 10**(2*i) for i in xrange(-len(NormesdFXGdX)+1,1) ]
 237                 PerturbationsCarre.reverse()
 238                 dessiner(
 239                     Perturbations,
 240                     Residus,
 241                     titre    = self._parameters["ResultTitle"],
 242                     label    = self._parameters["ResultLabel"],
 243                     logX     = True,
 244                     logY     = True,
 245                     filename = str(self._parameters["ResultFile"])+".ps",
 246                     YRef     = PerturbationsCarre,
 247                     normdY0  = numpy.log10( NormesdFX[0] ),
 248                     )
 249             elif self._parameters["ResiduFormula"] is "Norm":
 250                 dessiner(
 251                     Perturbations,
 252                     Residus,
 253                     titre    = self._parameters["ResultTitle"],
 254                     label    = self._parameters["ResultLabel"],
 255                     logX     = True,
 256                     logY     = True,
 257                     filename = str(self._parameters["ResultFile"])+".ps",
 258                     )
 259         #
 260         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("M")))
 261         logging.debug("%s Terminé"%self._name)
 262         #
 263         return 0
 264
 265 # ==============================================================================
 266
 267 def dessiner(
 268         X,
 269         Y,
 270         titre     = "",
 271         label     = "",
 272         logX      = False,
 273         logY      = False,
 274         filename  = "",
 275         pause     = False,
 276         YRef      = None, # Vecteur de reference a comparer a Y
 277         recalYRef = True, # Decalage du point 0 de YRef à Y[0]
 278         normdY0   = 0.,   # Norme de DeltaY[0]
 279         ):
 280     import Gnuplot
 281     __gnuplot = Gnuplot
 282     __g = __gnuplot.Gnuplot(persist=1) # persist=1
 283     # __g('set terminal '+__gnuplot.GnuplotOpts.default_term)
 284     __g('set style data lines')
 285     __g('set grid')
 286     __g('set autoscale')
 287     __g('set title  "'+titre+'"')
 288     # __g('set xrange [] reverse')
 289     # __g('set yrange [0:2]')
 290     #
 291     if logX:
 292         steps = numpy.log10( X )
 293         __g('set xlabel "Facteur multiplicatif de dX, en echelle log10"')
 294     else:
 295         steps = X
 296         __g('set xlabel "Facteur multiplicatif de dX"')
 297     #
 298     if logY:
 299         values = numpy.log10( Y )
 300         __g('set ylabel "Amplitude du residu, en echelle log10"')
 301     else:
 302         values = Y
 303         __g('set ylabel "Amplitude du residu"')
 304     #
 305     __g.plot( __gnuplot.Data( steps, values, title=label, with_='lines lw 3' ) )
 306     if YRef is not None:
 307         if logY:
 308             valuesRef = numpy.log10( YRef )
 309         else:
 310             valuesRef = YRef
 311         if recalYRef and not numpy.all(values < -8):
 312             valuesRef = valuesRef + values[0]
 313         elif recalYRef and numpy.all(values < -8):
 314             valuesRef = valuesRef + normdY0
 315         else:
 316             pass
 317         __g.replot( __gnuplot.Data( steps, valuesRef, title="Reference", with_='lines lw 1' ) )
 318     #
 319     if filename is not "":
 320         __g.hardcopy( filename, color=1)
 321     if pause:
 322         raw_input('Please press return to continue...\n')
 323
 324 # ==============================================================================
 325 if __name__ == "__main__":
 326     print '\n AUTODIAGNOSTIC \n'