src/daComposant/daAlgorithms/TangentTest.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2022 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 numpy
  24 from daCore import BasicObjects, NumericObjects, PlatformInfo
  25 mpr = PlatformInfo.PlatformInfo().MachinePrecision()
  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  = [
  83                 "CurrentState",
  84                 "Residu",
  85                 "SimulatedObservationAtCurrentState",
  86                 ]
  87             )
  88         self.requireInputArguments(
  89             mandatory= ("Xb", "HO"),
  90             )
  91         self.setAttributes(tags=(
  92             "Checking",
  93             ))
  94
  95     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
  96         self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q)
  97         #
  98         Hm = HO["Direct"].appliedTo
  99         Ht = HO["Tangent"].appliedInXTo
 100         #
 101         # Construction des perturbations
 102         # ------------------------------
 103         Perturbations = [ 10**i for i in range(self._parameters["EpsilonMinimumExponent"],1) ]
 104         Perturbations.reverse()
 105         #
 106         # Calcul du point courant
 107         # -----------------------
 108         Xn      = numpy.ravel( Xb ).reshape((-1,1))
 109         FX      = numpy.ravel( Hm( Xn ) ).reshape((-1,1))
 110         NormeX  = numpy.linalg.norm( Xn )
 111         NormeFX = numpy.linalg.norm( FX )
 112         if self._toStore("CurrentState"):
 113             self.StoredVariables["CurrentState"].store( Xn )
 114         if self._toStore("SimulatedObservationAtCurrentState"):
 115             self.StoredVariables["SimulatedObservationAtCurrentState"].store( FX )
 116         #
 117         dX0 = NumericObjects.SetInitialDirection(
 118             self._parameters["InitialDirection"],
 119             self._parameters["AmplitudeOfInitialDirection"],
 120             Xn,
 121             )
 122         #
 123         # Calcul du gradient au point courant X pour l'increment dX
 124         # qui est le tangent en X multiplie par dX
 125         # ---------------------------------------------------------
 126         dX1      = float(self._parameters["AmplitudeOfTangentPerturbation"]) * dX0
 127         GradFxdX = Ht( (Xn, dX1) )
 128         GradFxdX = numpy.ravel( GradFxdX ).reshape((-1,1))
 129         GradFxdX = float(1./self._parameters["AmplitudeOfTangentPerturbation"]) * GradFxdX
 130         NormeGX  = numpy.linalg.norm( GradFxdX )
 131         if NormeGX < mpr: NormeGX = mpr
 132         #
 133         # Entete des resultats
 134         # --------------------
 135         __marge =  12*u" "
 136         __precision = u"""
 137             Remarque : les nombres inferieurs a %.0e (environ) representent un zero
 138                        a la precision machine.\n"""%mpr
 139         if self._parameters["ResiduFormula"] == "Taylor":
 140             __entete = u"  i   Alpha     ||X||      ||F(X)||   |     R(Alpha)    |R-1|/Alpha"
 141             __msgdoc = u"""
 142             On observe le residu provenant du rapport d'increments utilisant le
 143             lineaire 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'a ce que l'on atteigne la
 150             precision du calcul.
 151
 152             Lorsque |R-1|/Alpha est inferieur ou egal a une valeur stable
 153             lorsque Alpha varie, le tangent est valide, jusqu'a ce que l'on
 154             atteigne la precision du calcul.
 155
 156             Si |R-1|/Alpha est tres faible, le code F est vraisemblablement
 157             lineaire ou quasi-lineaire, et le tangent est valide jusqu'a ce que
 158             l'on atteigne la precision du calcul.
 159
 160             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
 161         #
 162         if len(self._parameters["ResultTitle"]) > 0:
 163             __rt = str(self._parameters["ResultTitle"])
 164             msgs  = u"\n"
 165             msgs += __marge + "====" + "="*len(__rt) + "====\n"
 166             msgs += __marge + "    " + __rt + "\n"
 167             msgs += __marge + "====" + "="*len(__rt) + "====\n"
 168         else:
 169             msgs  = u""
 170         msgs += __msgdoc
 171         #
 172         __nbtirets = len(__entete) + 2
 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.reshape((-1,1))
 181             #
 182             if self._parameters["ResiduFormula"] == "Taylor":
 183                 FX_plus_dX  = numpy.ravel( Hm( Xn + dX ) ).reshape((-1,1))
 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("\nResults of tangent check by \"%s\" formula:"%self._parameters["ResiduFormula"])
 197         print(msgs)
 198         #
 199         self._post_run(HO)
 200         return 0
 201
 202 # ==============================================================================
 203 if __name__ == "__main__":
 204     print('\n AUTODIAGNOSTIC\n')