src/daComposant/daNumerics/ApproximatedDerivatives.py

   1 #-*-coding:iso-8859-1-*-
   2 #
   3 #  Copyright (C) 2008-2014 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 __doc__ = """
  24     Définit les versions approximées des opérateurs tangents et adjoints.
  25 """
  26 __author__ = "Jean-Philippe ARGAUD"
  27
  28 import os, numpy, time, copy, types, sys
  29 import logging
  30 from daCore.BasicObjects import Operator
  31 # logging.getLogger().setLevel(logging.DEBUG)
  32
  33 # ==============================================================================
  34 class FDApproximation:
  35     """
  36     Cette classe sert d'interface pour définir les opérateurs approximés. A la
  37     création d'un objet, en fournissant une fonction "Function", on obtient un
  38     objet qui dispose de 3 méthodes "DirectOperator", "TangentOperator" et
  39     "AdjointOperator". On contrôle l'approximation DF avec l'incrément
  40     multiplicatif "increment" valant par défaut 1%, ou avec l'incrément fixe
  41     "dX" qui sera multiplié par "increment" (donc en %), et on effectue de DF
  42     centrées si le booléen "centeredDF" est vrai.
  43     """
  44     def __init__(self,
  45             Function              = None,
  46             centeredDF            = False,
  47             increment             = 0.01,
  48             dX                    = None,
  49             avoidingRedundancy    = True,
  50             toleranceInRedundancy = 1.e-18,
  51             lenghtOfRedundancy    = -1,
  52             mpEnabled             = False,
  53             mpWorkers             = None,
  54             ):
  55         self.__userOperator = Operator( fromMethod = Function )
  56         self.__userFunction = self.__userOperator.appliedTo
  57         self.__centeredDF = bool(centeredDF)
  58         if avoidingRedundancy:
  59             self.__avoidRC = True
  60             self.__tolerBP = float(toleranceInRedundancy)
  61             self.__lenghtRJ = int(lenghtOfRedundancy)
  62             self.__listJPCP = [] # Jacobian Previous Calculated Points
  63             self.__listJPCI = [] # Jacobian Previous Calculated Increment
  64             self.__listJPCR = [] # Jacobian Previous Calculated Results
  65             self.__listJPPN = [] # Jacobian Previous Calculated Point Norms
  66             self.__listJPIN = [] # Jacobian Previous Calculated Increment Norms
  67         else:
  68             self.__avoidRC = False
  69         if float(increment) <> 0.:
  70             self.__increment  = float(increment)
  71         else:
  72             self.__increment  = 0.01
  73         if dX is None:
  74             self.__dX     = None
  75         else:
  76             self.__dX     = numpy.asmatrix(numpy.ravel( dX )).T
  77         logging.debug("FDA Reduction des doublons de calcul : %s"%self.__avoidRC)
  78         if self.__avoidRC:
  79             logging.debug("FDA Tolerance de determination des doublons : %.2e"%self.__tolerBP)
  80
  81     # ---------------------------------------------------------
  82     def __doublon__(self, e, l, n, v=None):
  83         __ac, __iac = False, -1
  84         for i in xrange(len(l)-1,-1,-1):
  85             if numpy.linalg.norm(e - l[i]) < self.__tolerBP * n[i]:
  86                 __ac, __iac = True, i
  87                 if v is not None: logging.debug("FDA Cas%s déja calculé, récupération du doublon %i"%(v,__iac))
  88                 break
  89         return __ac, __iac
  90
  91     # ---------------------------------------------------------
  92     def DirectOperator(self, X ):
  93         """
  94         Calcul du direct à l'aide de la fonction fournie.
  95         """
  96         logging.debug("FDA Calcul DirectOperator (explicite)")
  97         _X = numpy.asmatrix(numpy.ravel( X )).T
  98         _HX = numpy.ravel(self.__userFunction( _X ))
  99         #
 100         return _HX
 101
 102     # ---------------------------------------------------------
 103     def TangentMatrix(self, X ):
 104         """
 105         Calcul de l'opérateur tangent comme la Jacobienne par différences finies,
 106         c'est-à-dire le gradient de H en X. On utilise des différences finies
 107         directionnelles autour du point X. X est un numpy.matrix.
 108
 109         Différences finies centrées (approximation d'ordre 2):
 110         1/ Pour chaque composante i de X, on ajoute et on enlève la perturbation
 111            dX[i] à la  composante X[i], pour composer X_plus_dXi et X_moins_dXi, et
 112            on calcule les réponses HX_plus_dXi = H( X_plus_dXi ) et HX_moins_dXi =
 113            H( X_moins_dXi )
 114         2/ On effectue les différences (HX_plus_dXi-HX_moins_dXi) et on divise par
 115            le pas 2*dXi
 116         3/ Chaque résultat, par composante, devient une colonne de la Jacobienne
 117
 118         Différences finies non centrées (approximation d'ordre 1):
 119         1/ Pour chaque composante i de X, on ajoute la perturbation dX[i] à la
 120            composante X[i] pour composer X_plus_dXi, et on calcule la réponse
 121            HX_plus_dXi = H( X_plus_dXi )
 122         2/ On calcule la valeur centrale HX = H(X)
 123         3/ On effectue les différences (HX_plus_dXi-HX) et on divise par
 124            le pas dXi
 125         4/ Chaque résultat, par composante, devient une colonne de la Jacobienne
 126
 127         """
 128         logging.debug("FDA Calcul de la Jacobienne")
 129         logging.debug("FDA   Incrément de............: %s*X"%float(self.__increment))
 130         logging.debug("FDA   Approximation centrée...: %s"%(self.__centeredDF))
 131         #
 132         if X is None or len(X)==0:
 133             raise ValueError("Nominal point X for approximate derivatives can not be None or void.")
 134         #
 135         _X = numpy.asmatrix(numpy.ravel( X )).T
 136         #
 137         if self.__dX is None:
 138             _dX  = self.__increment * _X
 139         else:
 140             _dX = numpy.asmatrix(numpy.ravel( self.__dX )).T
 141         #
 142         if (_dX == 0.).any():
 143             moyenne = _dX.mean()
 144             if moyenne == 0.:
 145                 _dX = numpy.where( _dX == 0., float(self.__increment), _dX )
 146             else:
 147                 _dX = numpy.where( _dX == 0., moyenne, _dX )
 148         #
 149         __alreadyCalculated  = False
 150         if self.__avoidRC:
 151             __bidon, __alreadyCalculatedP = self.__doublon__(_X,  self.__listJPCP, self.__listJPPN, None)
 152             __bidon, __alreadyCalculatedI = self.__doublon__(_dX, self.__listJPCI, self.__listJPIN, None)
 153             if __alreadyCalculatedP == __alreadyCalculatedI > -1:
 154                 __alreadyCalculated, __i = True, __alreadyCalculatedP
 155                 logging.debug("FDA Cas J déja calculé, récupération du doublon %i"%__i)
 156         #
 157         if __alreadyCalculated:
 158             logging.debug("FDA   Calcul Jacobienne (par récupération du doublon %i)"%__i)
 159             _Jacobienne = self.__listJPCR[__i]
 160         else:
 161             logging.debug("FDA   Calcul Jacobienne (explicite)")
 162             if self.__centeredDF:
 163                 #
 164                 _Jacobienne  = []
 165                 for i in range( _dX.size ):
 166                     _dXi            = _dX[i]
 167                     _X_plus_dXi     = numpy.array( _X.A1, dtype=float )
 168                     _X_plus_dXi[i]  = _X[i] + _dXi
 169                     _X_moins_dXi    = numpy.array( _X.A1, dtype=float )
 170                     _X_moins_dXi[i] = _X[i] - _dXi
 171                     #
 172                     _HX_plus_dXi    = self.DirectOperator( _X_plus_dXi )
 173                     _HX_moins_dXi   = self.DirectOperator( _X_moins_dXi )
 174                     #
 175                     _Jacobienne.append( numpy.ravel( _HX_plus_dXi - _HX_moins_dXi ) / (2.*_dXi) )
 176                 #
 177             else:
 178                 #
 179                 _Jacobienne  = []
 180                 _HX = self.DirectOperator( _X )
 181                 for i in range( _dX.size ):
 182                     _dXi            = _dX[i]
 183                     _X_plus_dXi     = numpy.array( _X.A1, dtype=float )
 184                     _X_plus_dXi[i]  = _X[i] + _dXi
 185                     #
 186                     _HX_plus_dXi = self.DirectOperator( _X_plus_dXi )
 187                     #
 188                     _Jacobienne.append( numpy.ravel(( _HX_plus_dXi - _HX ) / _dXi) )
 189                 #
 190             #
 191             _Jacobienne = numpy.matrix( numpy.vstack( _Jacobienne ) ).T
 192             if self.__avoidRC:
 193                 if self.__lenghtRJ < 0: self.__lenghtRJ = 2 * _X.size
 194                 while len(self.__listJPCP) > self.__lenghtRJ:
 195                     self.__listJPCP.pop(0)
 196                     self.__listJPCI.pop(0)
 197                     self.__listJPCR.pop(0)
 198                     self.__listJPPN.pop(0)
 199                     self.__listJPIN.pop(0)
 200                 self.__listJPCP.append( copy.copy(_X) )
 201                 self.__listJPCI.append( copy.copy(_dX) )
 202                 self.__listJPCR.append( copy.copy(_Jacobienne) )
 203                 self.__listJPPN.append( numpy.linalg.norm(_X) )
 204                 self.__listJPIN.append( numpy.linalg.norm(_Jacobienne) )
 205         #
 206         logging.debug("FDA Fin du calcul de la Jacobienne")
 207         #
 208         return _Jacobienne
 209
 210     # ---------------------------------------------------------
 211     def TangentOperator(self, (X, dX) ):
 212         """
 213         Calcul du tangent à l'aide de la Jacobienne.
 214         """
 215         _Jacobienne = self.TangentMatrix( X )
 216         if dX is None or len(dX) == 0:
 217             #
 218             # Calcul de la forme matricielle si le second argument est None
 219             # -------------------------------------------------------------
 220             return _Jacobienne
 221         else:
 222             #
 223             # Calcul de la valeur linéarisée de H en X appliqué à dX
 224             # ------------------------------------------------------
 225             _dX = numpy.asmatrix(numpy.ravel( dX )).T
 226             _HtX = numpy.dot(_Jacobienne, _dX)
 227             return _HtX.A1
 228
 229     # ---------------------------------------------------------
 230     def AdjointOperator(self, (X, Y) ):
 231         """
 232         Calcul de l'adjoint à l'aide de la Jacobienne.
 233         """
 234         _JacobienneT = self.TangentMatrix( X ).T
 235         if Y is None or len(Y) == 0:
 236             #
 237             # Calcul de la forme matricielle si le second argument est None
 238             # -------------------------------------------------------------
 239             return _JacobienneT
 240         else:
 241             #
 242             # Calcul de la valeur de l'adjoint en X appliqué à Y
 243             # --------------------------------------------------
 244             _Y = numpy.asmatrix(numpy.ravel( Y )).T
 245             _HaY = numpy.dot(_JacobienneT, _Y)
 246             return _HaY.A1
 247
 248 # ==============================================================================
 249 if __name__ == "__main__":
 250     print '\n AUTODIAGNOSTIC \n'