src/daComposant/daAlgorithms/3DVAR.py

   1 #-*-coding:iso-8859-1-*-
   2 #
   3 #  Copyright (C) 2008-2011  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
  22 import logging
  23 from daCore import BasicObjects, PlatformInfo
  24 m = PlatformInfo.SystemUsage()
  25
  26 import numpy
  27 import scipy.optimize
  28
  29 if logging.getLogger().level < 30:
  30     iprint  = 1
  31     message = scipy.optimize.tnc.MSG_ALL
  32     disp    = 1
  33 else:
  34     iprint  = -1
  35     message = scipy.optimize.tnc.MSG_NONE
  36     disp    = 0
  37
  38 # ==============================================================================
  39 class ElementaryAlgorithm(BasicObjects.Algorithm):
  40     def __init__(self):
  41         BasicObjects.Algorithm.__init__(self)
  42         self._name = "3DVAR"
  43         logging.debug("%s Initialisation"%self._name)
  44
  45     def run(self, Xb=None, Y=None, H=None, M=None, R=None, B=None, Q=None, Parameters=None):
  46         """
  47         Calcul de l'estimateur 3D-VAR
  48         """
  49         logging.debug("%s Lancement"%self._name)
  50         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("Mo")))
  51         #
  52         # Opérateur d'observation
  53         # -----------------------
  54         Hm = H["Direct"].appliedTo
  55         Ht = H["Adjoint"].appliedInXTo
  56         #
  57         # Utilisation éventuelle d'un vecteur H(Xb) précalculé
  58         # ----------------------------------------------------
  59         if H["AppliedToX"] is not None and H["AppliedToX"].has_key("HXb"):
  60             logging.debug("%s Utilisation de HXb"%self._name)
  61             HXb = H["AppliedToX"]["HXb"]
  62         else:
  63             logging.debug("%s Calcul de Hm(Xb)"%self._name)
  64             HXb = Hm( Xb )
  65         HXb = numpy.asmatrix(HXb).flatten().T
  66         #
  67         # Calcul du préconditionnement
  68         # ----------------------------
  69         # Bdemi = numpy.linalg.cholesky(B)
  70         #
  71         # Calcul de l'innovation
  72         # ----------------------
  73         d  = Y - HXb
  74         logging.debug("%s Innovation d = %s"%(self._name, d))
  75         #
  76         # Précalcul des inversion appellée dans les fonction-coût et gradient
  77         # -------------------------------------------------------------------
  78         BI = B.I
  79         RI = R.I
  80         #
  81         # Définition de la fonction-coût
  82         # ------------------------------
  83         def CostFunction(x):
  84             _X  = numpy.asmatrix(x).flatten().T
  85             logging.info("%s CostFunction X  = %s"%(self._name, numpy.asmatrix( _X ).flatten()))
  86             _HX = Hm( _X )
  87             _HX = numpy.asmatrix(_HX).flatten().T
  88             Jb  = 0.5 * (_X - Xb).T * BI * (_X - Xb)
  89             Jo  = 0.5 * (Y - _HX).T * RI * (Y - _HX)
  90             J   = float( Jb ) + float( Jo )
  91             logging.info("%s CostFunction Jb = %s"%(self._name, Jb))
  92             logging.info("%s CostFunction Jo = %s"%(self._name, Jo))
  93             logging.info("%s CostFunction J  = %s"%(self._name, J))
  94             self.StoredVariables["CurrentState"].store( _X.A1 )
  95             self.StoredVariables["CostFunctionJb"].store( Jb )
  96             self.StoredVariables["CostFunctionJo"].store( Jo )
  97             self.StoredVariables["CostFunctionJ" ].store( J )
  98             return float( J )
  99         #
 100         def GradientOfCostFunction(x):
 101             _X      = numpy.asmatrix(x).flatten().T
 102             logging.info("%s GradientOfCostFunction X      = %s"%(self._name, numpy.asmatrix( _X ).flatten()))
 103             _HX     = Hm( _X )
 104             _HX     = numpy.asmatrix(_HX).flatten().T
 105             GradJb  = BI * (_X - Xb)
 106             GradJo  = - Ht( (_X, RI * (Y - _HX)) )
 107             GradJ   = numpy.asmatrix( GradJb ).flatten().T + numpy.asmatrix( GradJo ).flatten().T
 108             logging.debug("%s GradientOfCostFunction GradJb = %s"%(self._name, numpy.asmatrix( GradJb ).flatten()))
 109             logging.debug("%s GradientOfCostFunction GradJo = %s"%(self._name, numpy.asmatrix( GradJo ).flatten()))
 110             logging.debug("%s GradientOfCostFunction GradJ  = %s"%(self._name, numpy.asmatrix( GradJ  ).flatten()))
 111             return GradJ.A1
 112         #
 113         # Point de démarrage de l'optimisation : Xini = Xb
 114         # ------------------------------------
 115         if type(Xb) is type(numpy.matrix([])):
 116             Xini = Xb.A1.tolist()
 117         else:
 118             Xini = list(Xb)
 119         logging.debug("%s Point de démarrage Xini = %s"%(self._name, Xini))
 120         #
 121         # Paramètres de pilotage
 122         # ----------------------
 123         # Potentiels : "Bounds", "Minimizer", "MaximumNumberOfSteps", "ProjectedGradientTolerance", "GradientNormTolerance", "InnerMinimizer"
 124         if Parameters.has_key("Bounds") and (type(Parameters["Bounds"]) is type([]) or type(Parameters["Bounds"]) is type(())) and (len(Parameters["Bounds"]) > 0):
 125             Bounds = Parameters["Bounds"]
 126         else:
 127             Bounds = None
 128         MinimizerList = ["LBFGSB","TNC", "CG", "NCG", "BFGS"]
 129         if Parameters.has_key("Minimizer") and (Parameters["Minimizer"] in MinimizerList):
 130             Minimizer = str( Parameters["Minimizer"] )
 131         else:
 132             logging.warning("%s Minimiseur inconnu ou non fourni, remplacé par la valeur par défaut"%self._name)
 133             Minimizer = "LBFGSB"
 134         logging.debug("%s Minimiseur utilisé = %s"%(self._name, Minimizer))
 135         if Parameters.has_key("MaximumNumberOfSteps") and (Parameters["MaximumNumberOfSteps"] > -1):
 136             maxiter = int( Parameters["MaximumNumberOfSteps"] )
 137         else:
 138             maxiter = 15000
 139         logging.debug("%s Nombre maximal de pas d'optimisation = %s"%(self._name, str(maxiter)))
 140         if Parameters.has_key("CostDecrementTolerance") and (Parameters["CostDecrementTolerance"] > 0):
 141             ftol  = float(Parameters["CostDecrementTolerance"])
 142             factr = 1./ftol
 143         else:
 144             ftol  = 1.e-7
 145             factr = 1./ftol
 146         logging.debug("%s Diminution relative minimale du cout lors de l'arret = %s"%(self._name, str(1./factr)))
 147         if Parameters.has_key("ProjectedGradientTolerance") and (Parameters["ProjectedGradientTolerance"] > -1):
 148             pgtol = float(Parameters["ProjectedGradientTolerance"])
 149         else:
 150             pgtol = -1
 151         logging.debug("%s Maximum des composantes du gradient projete lors de l'arret = %s"%(self._name, str(pgtol)))
 152         if Parameters.has_key("GradientNormTolerance") and (Parameters["GradientNormTolerance"] > -1):
 153             gtol = float(Parameters["GradientNormTolerance"])
 154         else:
 155             gtol = 1.e-05
 156         logging.debug("%s Maximum des composantes du gradient lors de l'arret = %s"%(self._name, str(gtol)))
 157         InnerMinimizerList = ["CG", "NCG", "BFGS"]
 158         if Parameters.has_key("InnerMinimizer") and (Parameters["InnerMinimizer"] in InnerMinimizerList):
 159             InnerMinimizer = str( Parameters["Minimizer"] )
 160         else:
 161             InnerMinimizer = "BFGS"
 162         logging.debug("%s Minimiseur interne utilisé = %s"%(self._name, InnerMinimizer))
 163         logging.debug("%s Norme du gradient lors de l'arret = %s"%(self._name, str(gtol)))
 164         #
 165         # Minimisation de la fonctionnelle
 166         # --------------------------------
 167         if Minimizer == "LBFGSB":
 168             Minimum, J_optimal, Informations = scipy.optimize.fmin_l_bfgs_b(
 169                 func        = CostFunction,
 170                 x0          = Xini,
 171                 fprime      = GradientOfCostFunction,
 172                 args        = (),
 173                 bounds      = Bounds,
 174                 maxfun      = maxiter,
 175                 factr       = factr,
 176                 pgtol       = pgtol,
 177                 iprint      = iprint,
 178                 )
 179             nfeval = Informations['funcalls']
 180             rc     = Informations['warnflag']
 181         elif Minimizer == "TNC":
 182             Minimum, nfeval, rc = scipy.optimize.fmin_tnc(
 183                 func        = CostFunction,
 184                 x0          = Xini,
 185                 fprime      = GradientOfCostFunction,
 186                 args        = (),
 187                 bounds      = Bounds,
 188                 maxfun      = maxiter,
 189                 pgtol       = pgtol,
 190                 ftol        = ftol,
 191                 messages    = message,
 192                 )
 193         elif Minimizer == "CG":
 194             Minimum, fopt, nfeval, grad_calls, rc = scipy.optimize.fmin_cg(
 195                 f           = CostFunction,
 196                 x0          = Xini,
 197                 fprime      = GradientOfCostFunction,
 198                 args        = (),
 199                 maxiter     = maxiter,
 200                 gtol        = gtol,
 201                 disp        = disp,
 202                 full_output = True,
 203                 )
 204         elif Minimizer == "NCG":
 205             Minimum, fopt, nfeval, grad_calls, hcalls, rc = scipy.optimize.fmin_ncg(
 206                 f           = CostFunction,
 207                 x0          = Xini,
 208                 fprime      = GradientOfCostFunction,
 209                 args        = (),
 210                 maxiter     = maxiter,
 211                 avextol     = ftol,
 212                 disp        = disp,
 213                 full_output = True,
 214                 )
 215         elif Minimizer == "BFGS":
 216             Minimum, fopt, gopt, Hopt, nfeval, grad_calls, rc = scipy.optimize.fmin_bfgs(
 217                 f           = CostFunction,
 218                 x0          = Xini,
 219                 fprime      = GradientOfCostFunction,
 220                 args        = (),
 221                 maxiter     = maxiter,
 222                 gtol        = gtol,
 223                 disp        = disp,
 224                 full_output = True,
 225                 )
 226         else:
 227             raise ValueError("Error in Minimizer name: %s"%Minimizer)
 228         #
 229         # Correction pour pallier a un bug de TNC sur le retour du Minimum
 230         # ----------------------------------------------------------------
 231         StepMin = numpy.argmin( self.StoredVariables["CostFunctionJ"].valueserie() )
 232         MinJ    = self.StoredVariables["CostFunctionJ"].valueserie(step = StepMin)
 233         Minimum = self.StoredVariables["CurrentState"].valueserie(step = StepMin)
 234         #
 235         logging.debug("%s %s Step of min cost  = %s"%(self._name, Minimizer, StepMin))
 236         logging.debug("%s %s Minimum cost      = %s"%(self._name, Minimizer, MinJ))
 237         logging.debug("%s %s Minimum state     = %s"%(self._name, Minimizer, Minimum))
 238         logging.debug("%s %s Nb of F           = %s"%(self._name, Minimizer, nfeval))
 239         logging.debug("%s %s RetCode           = %s"%(self._name, Minimizer, rc))
 240         #
 241         # Calcul  de l'analyse
 242         # --------------------
 243         Xa = numpy.asmatrix(Minimum).T
 244         logging.debug("%s Analyse Xa = %s"%(self._name, Xa))
 245         #
 246         self.StoredVariables["Analysis"].store( Xa.A1 )
 247         self.StoredVariables["Innovation"].store( d.A1 )
 248         #
 249         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("MB")))
 250         logging.debug("%s Terminé"%self._name)
 251         #
 252         return 0
 253
 254 # ==============================================================================
 255 if __name__ == "__main__":
 256     print '\n AUTODIAGNOSTIC \n'