src/daComposant/daAlgorithms/TangentTest.py

   1 #-*-coding:iso-8859-1-*-
   2 #
   3 # Copyright (C) 2008-2017 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 import numpy, math
  26 mpr = PlatformInfo.PlatformInfo().MachinePrecision()
  27
  28 # ==============================================================================
  29 class ElementaryAlgorithm(BasicObjects.Algorithm):
  30     def __init__(self):
  31         BasicObjects.Algorithm.__init__(self, "TANGENTTEST")
  32         self.defineRequiredParameter(
  33             name     = "ResiduFormula",
  34             default  = "Taylor",
  35             typecast = str,
  36             message  = "Formule de résidu utilisée",
  37             listval  = ["Taylor"],
  38             )
  39         self.defineRequiredParameter(
  40             name     = "EpsilonMinimumExponent",
  41             default  = -8,
  42             typecast = int,
  43             message  = "Exposant minimal en puissance de 10 pour le multiplicateur d'incrément",
  44             minval   = -20,
  45             maxval   = 0,
  46             )
  47         self.defineRequiredParameter(
  48             name     = "InitialDirection",
  49             default  = [],
  50             typecast = list,
  51             message  = "Direction initiale de la dérivée directionnelle autour du point nominal",
  52             )
  53         self.defineRequiredParameter(
  54             name     = "AmplitudeOfInitialDirection",
  55             default  = 1.,
  56             typecast = float,
  57             message  = "Amplitude de la direction initiale de la dérivée directionnelle autour du point nominal",
  58             )
  59         self.defineRequiredParameter(
  60             name     = "AmplitudeOfTangentPerturbation",
  61             default  = 1.e-2,
  62             typecast = float,
  63             message  = "Amplitude de la perturbation pour le calcul de la forme tangente",
  64             minval   = 1.e-10,
  65             maxval   = 1.,
  66             )
  67         self.defineRequiredParameter(
  68             name     = "SetSeed",
  69             typecast = numpy.random.seed,
  70             message  = "Graine fixée pour le générateur aléatoire",
  71             )
  72         self.defineRequiredParameter(
  73             name     = "ResultTitle",
  74             default  = "",
  75             typecast = str,
  76             message  = "Titre du tableau et de la figure",
  77             )
  78         self.defineRequiredParameter(
  79             name     = "StoreSupplementaryCalculations",
  80             default  = [],
  81             typecast = tuple,
  82             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
  83             listval  = ["CurrentState", "Residu", "SimulatedObservationAtCurrentState"]
  84             )
  85
  86     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
  87         self._pre_run()
  88         #
  89         # Paramètres de pilotage
  90         # ----------------------
  91         self.setParameters(Parameters)
  92         #
  93         # Opérateurs
  94         # ----------
  95         Hm = HO["Direct"].appliedTo
  96         Ht = HO["Tangent"].appliedInXTo
  97         #
  98         # Construction des perturbations
  99         # ------------------------------
 100         Perturbations = [ 10**i for i in xrange(self._parameters["EpsilonMinimumExponent"],1) ]
 101         Perturbations.reverse()
 102         #
 103         # Calcul du point courant
 104         # -----------------------
 105         Xn      = numpy.asmatrix(numpy.ravel( Xb )).T
 106         FX      = numpy.asmatrix(numpy.ravel( Hm( Xn ) )).T
 107         NormeX  = numpy.linalg.norm( Xn )
 108         NormeFX = numpy.linalg.norm( FX )
 109         if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 110             self.StoredVariables["CurrentState"].store( numpy.ravel(Xn) )
 111         if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 112             self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX) )
 113         #
 114         # Fabrication de la direction de  l'incrément dX
 115         # ----------------------------------------------
 116         if len(self._parameters["InitialDirection"]) == 0:
 117             dX0 = []
 118             for v in Xn.A1:
 119                 if abs(v) > 1.e-8:
 120                     dX0.append( numpy.random.normal(0.,abs(v)) )
 121                 else:
 122                     dX0.append( numpy.random.normal(0.,Xn.mean()) )
 123         else:
 124             dX0 = numpy.ravel( self._parameters["InitialDirection"] )
 125         #
 126         dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
 127         #
 128         # Calcul du gradient au point courant X pour l'incrément dX
 129         # qui est le tangent en X multiplié par dX
 130         # ---------------------------------------------------------
 131         dX1      = float(self._parameters["AmplitudeOfTangentPerturbation"]) * dX0
 132         GradFxdX = Ht( (Xn, dX1) )
 133         GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
 134         GradFxdX = float(1./self._parameters["AmplitudeOfTangentPerturbation"]) * GradFxdX
 135         NormeGX  = numpy.linalg.norm( GradFxdX )
 136         #
 137         # Entete des resultats
 138         # --------------------
 139         __marge =  12*" "
 140         __precision = """
 141             Remarque : les nombres inferieurs a %.0e (environ) representent un zero
 142                        a la precision machine.\n"""%mpr
 143         if self._parameters["ResiduFormula"] == "Taylor":
 144             __entete = "  i   Alpha     ||X||      ||F(X)||   |     R(Alpha)    |R-1|/Alpha  "
 145             __msgdoc = """
 146             On observe le résidu provenant du rapport d'incréments utilisant le
 147             linéaire tangent :
 148
 149                           || F(X+Alpha*dX) - F(X) ||
 150               R(Alpha) = -----------------------------
 151                          || Alpha * TangentF_X * dX ||
 152
 153             qui doit rester stable en 1+O(Alpha) jusqu'à ce que l'on atteigne la
 154             précision du calcul.
 155
 156             Lorsque |R-1|/Alpha est inférieur ou égal à une valeur stable
 157             lorsque Alpha varie, le tangent est valide, jusqu'à ce que l'on
 158             atteigne la précision du calcul.
 159
 160             Si |R-1|/Alpha est très faible, le code F est vraisemblablement
 161             linéaire ou quasi-linéaire, et le tangent est valide jusqu'à ce que
 162             l'on atteigne la précision du calcul.
 163
 164             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
 165             """ + __precision
 166         #
 167         if len(self._parameters["ResultTitle"]) > 0:
 168             msgs  = "\n"
 169             msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
 170             msgs += __marge + "    " + self._parameters["ResultTitle"] + "\n"
 171             msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
 172         else:
 173             msgs  = ""
 174         msgs += __msgdoc
 175         #
 176         __nbtirets = len(__entete)
 177         msgs += "\n" + __marge + "-"*__nbtirets
 178         msgs += "\n" + __marge + __entete
 179         msgs += "\n" + __marge + "-"*__nbtirets
 180         #
 181         # Boucle sur les perturbations
 182         # ----------------------------
 183         for i,amplitude in enumerate(Perturbations):
 184             dX      = amplitude * dX0
 185             #
 186             if self._parameters["ResiduFormula"] == "Taylor":
 187                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 188                 #
 189                 Residu = numpy.linalg.norm( FX_plus_dX - FX ) / (amplitude * NormeGX)
 190                 #
 191                 self.StoredVariables["Residu"].store( Residu )
 192                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %11.5e    %5.1e"%(i,amplitude,NormeX,NormeFX,Residu,abs(Residu-1.)/amplitude)
 193                 msgs += "\n" + __marge + msg
 194         #
 195         msgs += "\n" + __marge + "-"*__nbtirets
 196         msgs += "\n"
 197         #
 198         # Sorties eventuelles
 199         # -------------------
 200         print
 201         print "Results of tangent check by \"%s\" formula:"%self._parameters["ResiduFormula"]
 202         print msgs
 203         #
 204         self._post_run(HO)
 205         return 0
 206
 207 # ==============================================================================
 208 if __name__ == "__main__":
 209     print '\n AUTODIAGNOSTIC \n'