src/daComposant/daAlgorithms/AdjointTest.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, PlatformInfo
  25 mpr = PlatformInfo.PlatformInfo().MachinePrecision()
  26
  27 # ==============================================================================
  28 class ElementaryAlgorithm(BasicObjects.Algorithm):
  29     def __init__(self):
  30         BasicObjects.Algorithm.__init__(self, "ADJOINTTEST")
  31         self.defineRequiredParameter(
  32             name     = "ResiduFormula",
  33             default  = "ScalarProduct",
  34             typecast = str,
  35             message  = "Formule de résidu utilisée",
  36             listval  = ["ScalarProduct"],
  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         self.defineRequiredParameter(
  70             name     = "StoreSupplementaryCalculations",
  71             default  = [],
  72             typecast = tuple,
  73             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
  74             listval  = [
  75                 "CurrentState",
  76                 "Residu",
  77                 "SimulatedObservationAtCurrentState",
  78                 ]
  79             )
  80         self.requireInputArguments(
  81             mandatory= ("Xb", "HO" ),
  82             optional = ("Y", ),
  83             )
  84         self.setAttributes(tags=(
  85             "Checking",
  86             ))
  87
  88     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
  89         self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q)
  90         #
  91         Hm = HO["Direct"].appliedTo
  92         Ht = HO["Tangent"].appliedInXTo
  93         Ha = HO["Adjoint"].appliedInXTo
  94         #
  95         # ----------
  96         Perturbations = [ 10**i for i in range(self._parameters["EpsilonMinimumExponent"],1) ]
  97         Perturbations.reverse()
  98         #
  99         X       = numpy.ravel( Xb ).reshape((-1,1))
 100         NormeX  = numpy.linalg.norm( X )
 101         if Y is None:
 102             Y = numpy.ravel( Hm( X ) ).reshape((-1,1))
 103         Y = numpy.ravel( Y ).reshape((-1,1))
 104         NormeY = numpy.linalg.norm( Y )
 105         if self._toStore("CurrentState"):
 106             self.StoredVariables["CurrentState"].store( X )
 107         if self._toStore("SimulatedObservationAtCurrentState"):
 108             self.StoredVariables["SimulatedObservationAtCurrentState"].store( Y )
 109         #
 110         if len(self._parameters["InitialDirection"]) == 0:
 111             dX0 = []
 112             for v in X:
 113                 if abs(v) > 1.e-8:
 114                     dX0.append( numpy.random.normal(0.,abs(v)) )
 115                 else:
 116                     dX0.append( numpy.random.normal(0.,X.mean()) )
 117         else:
 118             dX0 = self._parameters["InitialDirection"]
 119         #
 120         dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.ravel( dX0 )
 121         #
 122         # Entete des resultats
 123         # --------------------
 124         __marge =  12*u" "
 125         __precision = u"""
 126             Remarque : les nombres inferieurs a %.0e (environ) representent un zero
 127                        a la precision machine.\n"""%mpr
 128         if self._parameters["ResiduFormula"] == "ScalarProduct":
 129             __entete = u"  i   Alpha     ||X||       ||Y||       ||dX||        R(Alpha)"
 130             __msgdoc = u"""
 131             On observe le residu qui est la difference de deux produits scalaires :
 132
 133               R(Alpha) = | < TangentF_X(dX) , Y > - < dX , AdjointF_X(Y) > |
 134
 135             qui doit rester constamment egal a zero a la precision du calcul.
 136             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
 137             Y doit etre dans l'image de F. S'il n'est pas donne, on prend Y = F(X).\n""" + __precision
 138         #
 139         if len(self._parameters["ResultTitle"]) > 0:
 140             __rt = str(self._parameters["ResultTitle"])
 141             msgs  = u"\n"
 142             msgs += __marge + "====" + "="*len(__rt) + "====\n"
 143             msgs += __marge + "    " + __rt + "\n"
 144             msgs += __marge + "====" + "="*len(__rt) + "====\n"
 145         else:
 146             msgs  = u""
 147         msgs += __msgdoc
 148         #
 149         __nbtirets = len(__entete) + 2
 150         msgs += "\n" + __marge + "-"*__nbtirets
 151         msgs += "\n" + __marge + __entete
 152         msgs += "\n" + __marge + "-"*__nbtirets
 153         #
 154         # ----------
 155         for i,amplitude in enumerate(Perturbations):
 156             dX          = amplitude * dX0
 157             NormedX     = numpy.linalg.norm( dX )
 158             #
 159             TangentFXdX = numpy.ravel( Ht( (X,dX) ) )
 160             AdjointFXY  = numpy.ravel( Ha( (X,Y)  ) )
 161             #
 162             Residu = abs(float(numpy.dot( TangentFXdX, Y ) - numpy.dot( dX, AdjointFXY )))
 163             #
 164             msg = "  %2i  %5.0e   %9.3e   %9.3e   %9.3e   |  %9.3e"%(i,amplitude,NormeX,NormeY,NormedX,Residu)
 165             msgs += "\n" + __marge + msg
 166             #
 167             self.StoredVariables["Residu"].store( Residu )
 168         #
 169         msgs += "\n" + __marge + "-"*__nbtirets
 170         msgs += "\n"
 171         #
 172         # Sorties eventuelles
 173         # -------------------
 174         print("\nResults of adjoint check by \"%s\" formula:"%self._parameters["ResiduFormula"])
 175         print(msgs)
 176         #
 177         self._post_run(HO)
 178         return 0
 179
 180 # ==============================================================================
 181 if __name__ == "__main__":
 182     print('\n AUTODIAGNOSTIC\n')