src/daComposant/daAlgorithms/4DVAR.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2019 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, scipy.optimize
  26
  27 # ==============================================================================
  28 class ElementaryAlgorithm(BasicObjects.Algorithm):
  29     def __init__(self):
  30         BasicObjects.Algorithm.__init__(self, "4DVAR")
  31         self.defineRequiredParameter(
  32             name     = "ConstrainedBy",
  33             default  = "EstimateProjection",
  34             typecast = str,
  35             message  = "Prise en compte des contraintes",
  36             listval  = ["EstimateProjection"],
  37             )
  38         self.defineRequiredParameter(
  39             name     = "EstimationOf",
  40             default  = "State",
  41             typecast = str,
  42             message  = "Estimation d'etat ou de parametres",
  43             listval  = ["State", "Parameters"],
  44             )
  45         self.defineRequiredParameter(
  46             name     = "Minimizer",
  47             default  = "LBFGSB",
  48             typecast = str,
  49             message  = "Minimiseur utilisé",
  50             listval  = ["LBFGSB","TNC", "CG", "NCG", "BFGS"],
  51             )
  52         self.defineRequiredParameter(
  53             name     = "MaximumNumberOfSteps",
  54             default  = 15000,
  55             typecast = int,
  56             message  = "Nombre maximal de pas d'optimisation",
  57             minval   = -1,
  58             )
  59         self.defineRequiredParameter(
  60             name     = "CostDecrementTolerance",
  61             default  = 1.e-7,
  62             typecast = float,
  63             message  = "Diminution relative minimale du coût lors de l'arrêt",
  64             minval   = 0.,
  65             )
  66         self.defineRequiredParameter(
  67             name     = "ProjectedGradientTolerance",
  68             default  = -1,
  69             typecast = float,
  70             message  = "Maximum des composantes du gradient projeté lors de l'arrêt",
  71             minval   = -1,
  72             )
  73         self.defineRequiredParameter(
  74             name     = "GradientNormTolerance",
  75             default  = 1.e-05,
  76             typecast = float,
  77             message  = "Maximum des composantes du gradient lors de l'arrêt",
  78             minval   = 0.,
  79             )
  80         self.defineRequiredParameter(
  81             name     = "StoreInternalVariables",
  82             default  = False,
  83             typecast = bool,
  84             message  = "Stockage des variables internes ou intermédiaires du calcul",
  85             )
  86         self.defineRequiredParameter(
  87             name     = "StoreSupplementaryCalculations",
  88             default  = [],
  89             typecast = tuple,
  90             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
  91             listval  = [
  92                 "Analysis",
  93                 "BMA",
  94                 "CostFunctionJ",
  95                 "CostFunctionJAtCurrentOptimum",
  96                 "CostFunctionJb",
  97                 "CostFunctionJbAtCurrentOptimum",
  98                 "CostFunctionJo",
  99                 "CostFunctionJoAtCurrentOptimum",
 100                 "CurrentOptimum",
 101                 "CurrentState",
 102                 "IndexOfOptimum",
 103                 ]
 104             )
 105         self.defineRequiredParameter( # Pas de type
 106             name     = "Bounds",
 107             message  = "Liste des valeurs de bornes",
 108             )
 109         self.requireInputArguments(
 110             mandatory= ("Xb", "Y", "HO", "EM", "R", "B" ),
 111             optional = ("U", "CM"),
 112             )
 113
 114     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
 115         self._pre_run(Parameters, Xb, Y, R, B, Q)
 116         #
 117         # Correction pour pallier a un bug de TNC sur le retour du Minimum
 118         if "Minimizer" in self._parameters and self._parameters["Minimizer"] == "TNC":
 119             self.setParameterValue("StoreInternalVariables",True)
 120         #
 121         # Opérateurs
 122         # ----------
 123         Hm = HO["Direct"].appliedControledFormTo
 124         #
 125         Mm = EM["Direct"].appliedControledFormTo
 126         #
 127         if CM is not None and "Tangent" in CM and U is not None:
 128             Cm = CM["Tangent"].asMatrix(Xb)
 129         else:
 130             Cm = None
 131         #
 132         def Un(_step):
 133             if U is not None:
 134                 if hasattr(U,"store") and 1<=_step<len(U) :
 135                     _Un = numpy.asmatrix(numpy.ravel( U[_step] )).T
 136                 elif hasattr(U,"store") and len(U)==1:
 137                     _Un = numpy.asmatrix(numpy.ravel( U[0] )).T
 138                 else:
 139                     _Un = numpy.asmatrix(numpy.ravel( U )).T
 140             else:
 141                 _Un = None
 142             return _Un
 143         def CmUn(_xn,_un):
 144             if Cm is not None and _un is not None: # Attention : si Cm est aussi dans M, doublon !
 145                 _Cm   = Cm.reshape(_xn.size,_un.size) # ADAO & check shape
 146                 _CmUn = _Cm * _un
 147             else:
 148                 _CmUn = 0.
 149             return _CmUn
 150         #
 151         # Remarque : les observations sont exploitées à partir du pas de temps
 152         # numéro 1, et sont utilisées dans Yo comme rangées selon ces indices.
 153         # Donc le pas 0 n'est pas utilisé puisque la première étape commence
 154         # avec l'observation du pas 1.
 155         #
 156         # Nombre de pas identique au nombre de pas d'observations
 157         # -------------------------------------------------------
 158         if hasattr(Y,"stepnumber"):
 159             duration = Y.stepnumber()
 160         else:
 161             duration = 2
 162         #
 163         # Précalcul des inversions de B et R
 164         # ----------------------------------
 165         BI = B.getI()
 166         RI = R.getI()
 167         #
 168         # Définition de la fonction-coût
 169         # ------------------------------
 170         self.DirectCalculation = [None,] # Le pas 0 n'est pas observé
 171         self.DirectInnovation  = [None,] # Le pas 0 n'est pas observé
 172         def CostFunction(x):
 173             _X  = numpy.asmatrix(numpy.ravel( x )).T
 174             if self._parameters["StoreInternalVariables"] or \
 175                 self._toStore("CurrentState") or \
 176                 self._toStore("CurrentOptimum"):
 177                 self.StoredVariables["CurrentState"].store( _X )
 178             Jb  = 0.5 * (_X - Xb).T * BI * (_X - Xb)
 179             self.DirectCalculation = [None,]
 180             self.DirectInnovation  = [None,]
 181             Jo  = 0.
 182             _Xn = _X
 183             for step in range(0,duration-1):
 184                 self.DirectCalculation.append( _Xn )
 185                 if hasattr(Y,"store"):
 186                     _Ynpu = numpy.asmatrix(numpy.ravel( Y[step+1] )).T
 187                 else:
 188                     _Ynpu = numpy.asmatrix(numpy.ravel( Y )).T
 189                 _Un = Un(step)
 190                 #
 191                 # Etape d'évolution
 192                 if self._parameters["EstimationOf"] == "State":
 193                     _Xn = Mm( (_Xn, _Un) ) + CmUn(_Xn, _Un)
 194                 elif self._parameters["EstimationOf"] == "Parameters":
 195                     pass
 196                 #
 197                 if self._parameters["Bounds"] is not None and self._parameters["ConstrainedBy"] == "EstimateProjection":
 198                     _Xn = numpy.max(numpy.hstack((_Xn,numpy.asmatrix(self._parameters["Bounds"])[:,0])),axis=1)
 199                     _Xn = numpy.min(numpy.hstack((_Xn,numpy.asmatrix(self._parameters["Bounds"])[:,1])),axis=1)
 200                 #
 201                 # Etape de différence aux observations
 202                 if self._parameters["EstimationOf"] == "State":
 203                     _YmHMX = _Ynpu - numpy.asmatrix(numpy.ravel( Hm( (_Xn, None) ) )).T
 204                 elif self._parameters["EstimationOf"] == "Parameters":
 205                     _YmHMX = _Ynpu - numpy.asmatrix(numpy.ravel( Hm( (_Xn, _Un) ) )).T - CmUn(_Xn, _Un)
 206                 self.DirectInnovation.append( _YmHMX )
 207                 # Ajout dans la fonctionnelle d'observation
 208                 Jo = Jo + _YmHMX.T * RI * _YmHMX
 209             Jo  = 0.5 * Jo
 210             J   = float( Jb ) + float( Jo )
 211             self.StoredVariables["CostFunctionJb"].store( Jb )
 212             self.StoredVariables["CostFunctionJo"].store( Jo )
 213             self.StoredVariables["CostFunctionJ" ].store( J )
 214             if self._toStore("IndexOfOptimum") or \
 215                 self._toStore("CurrentOptimum") or \
 216                 self._toStore("CostFunctionJAtCurrentOptimum") or \
 217                 self._toStore("CostFunctionJbAtCurrentOptimum") or \
 218                 self._toStore("CostFunctionJoAtCurrentOptimum"):
 219                 IndexMin = numpy.argmin( self.StoredVariables["CostFunctionJ"][nbPreviousSteps:] ) + nbPreviousSteps
 220             if self._toStore("IndexOfOptimum"):
 221                 self.StoredVariables["IndexOfOptimum"].store( IndexMin )
 222             if self._toStore("CurrentOptimum"):
 223                 self.StoredVariables["CurrentOptimum"].store( self.StoredVariables["CurrentState"][IndexMin] )
 224             if self._toStore("CostFunctionJAtCurrentOptimum"):
 225                 self.StoredVariables["CostFunctionJAtCurrentOptimum" ].store( self.StoredVariables["CostFunctionJ" ][IndexMin] )
 226             if self._toStore("CostFunctionJbAtCurrentOptimum"):
 227                 self.StoredVariables["CostFunctionJbAtCurrentOptimum"].store( self.StoredVariables["CostFunctionJb"][IndexMin] )
 228             if self._toStore("CostFunctionJoAtCurrentOptimum"):
 229                 self.StoredVariables["CostFunctionJoAtCurrentOptimum"].store( self.StoredVariables["CostFunctionJo"][IndexMin] )
 230             return J
 231         #
 232         def GradientOfCostFunction(x):
 233             _X      = numpy.asmatrix(numpy.ravel( x )).T
 234             GradJb  = BI * (_X - Xb)
 235             GradJo  = 0.
 236             for step in range(duration-1,0,-1):
 237                 # Etape de récupération du dernier stockage de l'évolution
 238                 _Xn = self.DirectCalculation.pop()
 239                 # Etape de récupération du dernier stockage de l'innovation
 240                 _YmHMX = self.DirectInnovation.pop()
 241                 # Calcul des adjoints
 242                 Ha = HO["Adjoint"].asMatrix(ValueForMethodForm = _Xn)
 243                 Ha = Ha.reshape(_Xn.size,_YmHMX.size) # ADAO & check shape
 244                 Ma = EM["Adjoint"].asMatrix(ValueForMethodForm = _Xn)
 245                 Ma = Ma.reshape(_Xn.size,_Xn.size) # ADAO & check shape
 246                 # Calcul du gradient par etat adjoint
 247                 GradJo = GradJo + Ha * RI * _YmHMX # Equivaut pour Ha lineaire à : Ha( (_Xn, RI * _YmHMX) )
 248                 GradJo = Ma * GradJo               # Equivaut pour Ma lineaire à : Ma( (_Xn, GradJo) )
 249             GradJ   = numpy.asmatrix( numpy.ravel( GradJb ) - numpy.ravel( GradJo ) ).T
 250             return GradJ.A1
 251         #
 252         # Point de démarrage de l'optimisation : Xini = Xb
 253         # ------------------------------------
 254         if isinstance(Xb, type(numpy.matrix([]))):
 255             Xini = Xb.A1.tolist()
 256         else:
 257             Xini = list(Xb)
 258         #
 259         # Minimisation de la fonctionnelle
 260         # --------------------------------
 261         nbPreviousSteps = self.StoredVariables["CostFunctionJ"].stepnumber()
 262         #
 263         if self._parameters["Minimizer"] == "LBFGSB":
 264             # Minimum, J_optimal, Informations = scipy.optimize.fmin_l_bfgs_b(
 265             import lbfgsbhlt
 266             Minimum, J_optimal, Informations = lbfgsbhlt.fmin_l_bfgs_b(
 267                 func        = CostFunction,
 268                 x0          = Xini,
 269                 fprime      = GradientOfCostFunction,
 270                 args        = (),
 271                 bounds      = self._parameters["Bounds"],
 272                 maxfun      = self._parameters["MaximumNumberOfSteps"]-1,
 273                 factr       = self._parameters["CostDecrementTolerance"]*1.e14,
 274                 pgtol       = self._parameters["ProjectedGradientTolerance"],
 275                 iprint      = self._parameters["optiprint"],
 276                 )
 277             nfeval = Informations['funcalls']
 278             rc     = Informations['warnflag']
 279         elif self._parameters["Minimizer"] == "TNC":
 280             Minimum, nfeval, rc = scipy.optimize.fmin_tnc(
 281                 func        = CostFunction,
 282                 x0          = Xini,
 283                 fprime      = GradientOfCostFunction,
 284                 args        = (),
 285                 bounds      = self._parameters["Bounds"],
 286                 maxfun      = self._parameters["MaximumNumberOfSteps"],
 287                 pgtol       = self._parameters["ProjectedGradientTolerance"],
 288                 ftol        = self._parameters["CostDecrementTolerance"],
 289                 messages    = self._parameters["optmessages"],
 290                 )
 291         elif self._parameters["Minimizer"] == "CG":
 292             Minimum, fopt, nfeval, grad_calls, rc = scipy.optimize.fmin_cg(
 293                 f           = CostFunction,
 294                 x0          = Xini,
 295                 fprime      = GradientOfCostFunction,
 296                 args        = (),
 297                 maxiter     = self._parameters["MaximumNumberOfSteps"],
 298                 gtol        = self._parameters["GradientNormTolerance"],
 299                 disp        = self._parameters["optdisp"],
 300                 full_output = True,
 301                 )
 302         elif self._parameters["Minimizer"] == "NCG":
 303             Minimum, fopt, nfeval, grad_calls, hcalls, rc = scipy.optimize.fmin_ncg(
 304                 f           = CostFunction,
 305                 x0          = Xini,
 306                 fprime      = GradientOfCostFunction,
 307                 args        = (),
 308                 maxiter     = self._parameters["MaximumNumberOfSteps"],
 309                 avextol     = self._parameters["CostDecrementTolerance"],
 310                 disp        = self._parameters["optdisp"],
 311                 full_output = True,
 312                 )
 313         elif self._parameters["Minimizer"] == "BFGS":
 314             Minimum, fopt, gopt, Hopt, nfeval, grad_calls, rc = scipy.optimize.fmin_bfgs(
 315                 f           = CostFunction,
 316                 x0          = Xini,
 317                 fprime      = GradientOfCostFunction,
 318                 args        = (),
 319                 maxiter     = self._parameters["MaximumNumberOfSteps"],
 320                 gtol        = self._parameters["GradientNormTolerance"],
 321                 disp        = self._parameters["optdisp"],
 322                 full_output = True,
 323                 )
 324         else:
 325             raise ValueError("Error in Minimizer name: %s"%self._parameters["Minimizer"])
 326         #
 327         IndexMin = numpy.argmin( self.StoredVariables["CostFunctionJ"][nbPreviousSteps:] ) + nbPreviousSteps
 328         MinJ     = self.StoredVariables["CostFunctionJ"][IndexMin]
 329         #
 330         # Correction pour pallier a un bug de TNC sur le retour du Minimum
 331         # ----------------------------------------------------------------
 332         if self._parameters["StoreInternalVariables"] or self._toStore("CurrentState"):
 333             Minimum = self.StoredVariables["CurrentState"][IndexMin]
 334         #
 335         # Obtention de l'analyse
 336         # ----------------------
 337         Xa = numpy.asmatrix(numpy.ravel( Minimum )).T
 338         #
 339         self.StoredVariables["Analysis"].store( Xa.A1 )
 340         #
 341         # Calculs et/ou stockages supplémentaires
 342         # ---------------------------------------
 343         if self._toStore("BMA"):
 344             self.StoredVariables["BMA"].store( numpy.ravel(Xb) - numpy.ravel(Xa) )
 345         #
 346         self._post_run(HO)
 347         return 0
 348
 349 # ==============================================================================
 350 if __name__ == "__main__":
 351     print('\n AUTODIAGNOSTIC \n')