src/daComposant/daAlgorithms/TangentTest.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, "TANGENTTEST")
  31         self.defineRequiredParameter(
  32             name     = "ResiduFormula",
  33             default  = "Taylor",
  34             typecast = str,
  35             message  = "Formule de résidu utilisée",
  36             listval  = ["Taylor"],
  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  = ["CurrentState", "Residu", "SimulatedObservationAtCurrentState"]
  83             )
  84
  85     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
  86         self._pre_run()
  87         #
  88         # Paramètres de pilotage
  89         # ----------------------
  90         self.setParameters(Parameters)
  91         #
  92         # Opérateurs
  93         # ----------
  94         Hm = HO["Direct"].appliedTo
  95         Ht = HO["Tangent"].appliedInXTo
  96         #
  97         # Construction des perturbations
  98         # ------------------------------
  99         Perturbations = [ 10**i for i in xrange(self._parameters["EpsilonMinimumExponent"],1) ]
 100         Perturbations.reverse()
 101         #
 102         # Calcul du point courant
 103         # -----------------------
 104         Xn      = numpy.asmatrix(numpy.ravel( Xb )).T
 105         FX      = numpy.asmatrix(numpy.ravel( Hm( Xn ) )).T
 106         NormeX  = numpy.linalg.norm( Xn )
 107         NormeFX = numpy.linalg.norm( FX )
 108         if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 109             self.StoredVariables["CurrentState"].store( numpy.ravel(Xn) )
 110         if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 111             self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX) )
 112         #
 113         # Fabrication de la direction de  l'incrément dX
 114         # ----------------------------------------------
 115         if len(self._parameters["InitialDirection"]) == 0:
 116             dX0 = []
 117             for v in Xn.A1:
 118                 if abs(v) > 1.e-8:
 119                     dX0.append( numpy.random.normal(0.,abs(v)) )
 120                 else:
 121                     dX0.append( numpy.random.normal(0.,Xn.mean()) )
 122         else:
 123             dX0 = numpy.ravel( self._parameters["InitialDirection"] )
 124         #
 125         dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
 126         #
 127         # Calcul du gradient au point courant X pour l'incrément dX
 128         # qui est le tangent en X multiplié par dX
 129         # ---------------------------------------------------------
 130         dX1      = float(self._parameters["AmplitudeOfTangentPerturbation"]) * dX0
 131         GradFxdX = Ht( (Xn, dX1) )
 132         GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
 133         GradFxdX = float(1./self._parameters["AmplitudeOfTangentPerturbation"]) * GradFxdX
 134         NormeGX  = numpy.linalg.norm( GradFxdX )
 135         #
 136         # Entete des resultats
 137         # --------------------
 138         __marge =  12*" "
 139         if self._parameters["ResiduFormula"] == "Taylor":
 140             __entete = "  i   Alpha     ||X||      ||F(X)||   |     R(Alpha)    |R-1|/Alpha  "
 141             __msgdoc = """
 142             On observe le résidu provenant du rapport d'incréments utilisant le
 143             linéaire tangent :
 144
 145                           || F(X+Alpha*dX) - F(X) ||
 146               R(Alpha) = -----------------------------
 147                          || Alpha * TangentF_X * dX ||
 148
 149             qui doit rester stable en 1+O(Alpha) jusqu'à ce que l'on atteigne la
 150             précision du calcul.
 151
 152             Lorsque |R-1|/Alpha est inférieur ou égal à une valeur stable
 153             lorsque Alpha varie, le tangent est valide, jusqu'à ce que l'on
 154             atteigne la précision du calcul.
 155
 156             Si |R-1|/Alpha est très faible, le code F est vraisemblablement
 157             linéaire ou quasi-linéaire, et le tangent est valide jusqu'à ce que
 158             l'on atteigne la précision du calcul.
 159
 160             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
 161             """
 162         #
 163         if len(self._parameters["ResultTitle"]) > 0:
 164             msgs  = "\n"
 165             msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
 166             msgs += __marge + "    " + self._parameters["ResultTitle"] + "\n"
 167             msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
 168         else:
 169             msgs  = ""
 170         msgs += __msgdoc
 171         #
 172         __nbtirets = len(__entete)
 173         msgs += "\n" + __marge + "-"*__nbtirets
 174         msgs += "\n" + __marge + __entete
 175         msgs += "\n" + __marge + "-"*__nbtirets
 176         #
 177         # Boucle sur les perturbations
 178         # ----------------------------
 179         for i,amplitude in enumerate(Perturbations):
 180             dX      = amplitude * dX0
 181             #
 182             if self._parameters["ResiduFormula"] == "Taylor":
 183                 FX_plus_dX  = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
 184                 #
 185                 Residu = numpy.linalg.norm( FX_plus_dX - FX ) / (amplitude * NormeGX)
 186                 #
 187                 self.StoredVariables["Residu"].store( Residu )
 188                 msg = "  %2i  %5.0e   %9.3e   %9.3e   |   %11.5e    %5.1e"%(i,amplitude,NormeX,NormeFX,Residu,abs(Residu-1.)/amplitude)
 189                 msgs += "\n" + __marge + msg
 190         #
 191         msgs += "\n" + __marge + "-"*__nbtirets
 192         msgs += "\n"
 193         #
 194         # Sorties eventuelles
 195         # -------------------
 196         print
 197         print "Results of tangent check by \"%s\" formula:"%self._parameters["ResiduFormula"]
 198         print msgs
 199         #
 200         self._post_run(HO)
 201         return 0
 202
 203 # ==============================================================================
 204 if __name__ == "__main__":
 205     print '\n AUTODIAGNOSTIC \n'