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