Salome HOME
Python 3 compatibility improvement (UTF-8) and data interface changes
[modules/adao.git] / src / daComposant / daAlgorithms / AdjointTest.py
index 2eeceab90ed6ca289c653c3184e6f39126743eb4..d49c5c3632ebf2f24aaa921c47b6aa6078f3e625 100644 (file)
@@ -1,29 +1,31 @@
-#-*-coding:iso-8859-1-*-
+# -*- coding: utf-8 -*-
 #
-#  Copyright (C) 2008-2012 EDF R&D
+# Copyright (C) 2008-2017 EDF R&D
 #
-#  This library is free software; you can redistribute it and/or
-#  modify it under the terms of the GNU Lesser General Public
-#  License as published by the Free Software Foundation; either
-#  version 2.1 of the License.
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License.
 #
-#  This library is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#  Lesser General Public License for more details.
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
 #
-#  You should have received a copy of the GNU Lesser General Public
-#  License along with this library; if not, write to the Free Software
-#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 #
-#  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 #
+# Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
 
-import logging
+import sys, logging
 from daCore import BasicObjects, PlatformInfo
-m = PlatformInfo.SystemUsage()
-
 import numpy
+mpr = PlatformInfo.PlatformInfo().MachinePrecision()
+if sys.version_info.major > 2:
+    unicode = str
 
 # ==============================================================================
 class ElementaryAlgorithm(BasicObjects.Algorithm):
@@ -33,14 +35,14 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             name     = "ResiduFormula",
             default  = "ScalarProduct",
             typecast = str,
-            message  = "Formule de résidu utilisée",
+            message  = "Formule de résidu utilisée",
             listval  = ["ScalarProduct"],
             )
         self.defineRequiredParameter(
             name     = "EpsilonMinimumExponent",
             default  = -8,
             typecast = int,
-            message  = "Exposant minimal en puissance de 10 pour le multiplicateur d'incrément",
+            message  = "Exposant minimal en puissance de 10 pour le multiplicateur d'incrément",
             minval   = -20,
             maxval   = 0,
             )
@@ -48,18 +50,18 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             name     = "InitialDirection",
             default  = [],
             typecast = list,
-            message  = "Direction initiale de la dérivée directionnelle autour du point nominal",
+            message  = "Direction initiale de la dérivée directionnelle autour du point nominal",
             )
         self.defineRequiredParameter(
             name     = "AmplitudeOfInitialDirection",
             default  = 1.,
             typecast = float,
-            message  = "Amplitude de la direction initiale de la dérivée directionnelle autour du point nominal",
+            message  = "Amplitude de la direction initiale de la dérivée directionnelle autour du point nominal",
             )
         self.defineRequiredParameter(
             name     = "SetSeed",
             typecast = numpy.random.seed,
-            message  = "Graine fixée pour le générateur aléatoire",
+            message  = "Graine fixée pour le générateur aléatoire",
             )
         self.defineRequiredParameter(
             name     = "ResultTitle",
@@ -67,37 +69,36 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             typecast = str,
             message  = "Titre du tableau et de la figure",
             )
+        self.defineRequiredParameter(
+            name     = "StoreSupplementaryCalculations",
+            default  = [],
+            typecast = tuple,
+            message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
+            listval  = ["CurrentState", "Residu", "SimulatedObservationAtCurrentState"]
+            )
 
-    def run(self, Xb=None, Y=None, H=None, M=None, R=None, B=None, Q=None, Parameters=None):
-        logging.debug("%s Lancement"%self._name)
-        logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("Mo")))
+    def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
+        self._pre_run(Parameters)
         #
-        # Paramètres de pilotage
-        # ----------------------
-        self.setParameters(Parameters)
+        Hm = HO["Direct"].appliedTo
+        Ht = HO["Tangent"].appliedInXTo
+        Ha = HO["Adjoint"].appliedInXTo
         #
-        # Opérateur d'observation
-        # -----------------------
-        Hm = H["Direct"].appliedTo
-        Ht = H["Tangent"].appliedInXTo
-        Ha = H["Adjoint"].appliedInXTo
-        #
-        # Construction des perturbations
-        # ------------------------------
-        Perturbations = [ 10**i for i in xrange(self._parameters["EpsilonMinimumExponent"],1) ]
+        # ----------
+        Perturbations = [ 10**i for i in range(self._parameters["EpsilonMinimumExponent"],1) ]
         Perturbations.reverse()
         #
-        # Calcul du point courant
-        # -----------------------
-        X       = numpy.asmatrix(Xb).flatten().T
+        X       = numpy.asmatrix(numpy.ravel( Xb )).T
         NormeX  = numpy.linalg.norm( X )
         if Y is None:
-            Y = numpy.asmatrix( Hm( X ) ).flatten().T
-        Y = numpy.asmatrix(Y).flatten().T
+            Y = numpy.asmatrix(numpy.ravel( Hm( X ) )).T
+        Y = numpy.asmatrix(numpy.ravel( Y )).T
         NormeY = numpy.linalg.norm( Y )
+        if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+            self.StoredVariables["CurrentState"].store( numpy.ravel(X) )
+        if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+            self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(Y) )
         #
-        # Fabrication de la direction de  l'incrément dX
-        # ----------------------------------------------
         if len(self._parameters["InitialDirection"]) == 0:
             dX0 = []
             for v in X.A1:
@@ -106,46 +107,47 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
                 else:
                     dX0.append( numpy.random.normal(0.,X.mean()) )
         else:
-            dX0 = numpy.asmatrix(self._parameters["InitialDirection"]).flatten()
+            dX0 = numpy.asmatrix(numpy.ravel( self._parameters["InitialDirection"] ))
         #
         dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
         #
-        # Utilisation de F(X) si aucune observation n'est donnee
-        # ------------------------------------------------------
-        #
         # Entete des resultats
         # --------------------
-        if self._parameters["ResiduFormula"] is "ScalarProduct":
-            __doc__ = """
+        __marge =  12*u" "
+        __precision = u"""
+            Remarque : les nombres inferieurs a %.0e (environ) representent un zero
+                       a la precision machine.\n"""%mpr
+        if self._parameters["ResiduFormula"] == "ScalarProduct":
+            __entete = u"  i   Alpha     ||X||       ||Y||       ||dX||        R(Alpha)  "
+            __msgdoc = u"""
             On observe le residu qui est la difference de deux produits scalaires :
-            
+
               R(Alpha) = | < TangentF_X(dX) , Y > - < dX , AdjointF_X(Y) > |
-            
-            qui doit rester constamment egal zero a la precision du calcul.
+
+            qui doit rester constamment egal zero a la precision du calcul.
             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
             Y doit etre dans l'image de F. S'il n'est pas donne, on prend Y = F(X).
-            """
-        else:
-            __doc__ = ""
+            """ + __precision
         #
-        msgs  = "         ====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
-        msgs += "             " + self._parameters["ResultTitle"] + "\n"
-        msgs += "         ====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
-        msgs += __doc__
+        if len(self._parameters["ResultTitle"]) > 0:
+            __rt = unicode(self._parameters["ResultTitle"])
+            msgs  = u"\n"
+            msgs += __marge + "====" + "="*len(__rt) + "====\n"
+            msgs += __marge + "    " + __rt + "\n"
+            msgs += __marge + "====" + "="*len(__rt) + "====\n"
+        else:
+            msgs  = u""
+        msgs += __msgdoc
         #
-        msg = "  i   Alpha     ||X||       ||Y||       ||dX||        R(Alpha)  "
-        nbtirets = len(msg)
-        msgs += "\n" + "-"*nbtirets
-        msgs += "\n" + msg
-        msgs += "\n" + "-"*nbtirets
+        __nbtirets = len(__entete)
+        msgs += "\n" + __marge + "-"*__nbtirets
+        msgs += "\n" + __marge + __entete
+        msgs += "\n" + __marge + "-"*__nbtirets
         #
         Normalisation= -1
         #
-        # Boucle sur les perturbations
-        # ----------------------------
+        # ----------
         for i,amplitude in enumerate(Perturbations):
-            logging.debug("%s Etape de calcul numéro %i, avec la perturbation %8.3e"%(self._name, i, amplitude))
-            #
             dX          = amplitude * dX0
             NormedX     = numpy.linalg.norm( dX )
             #
@@ -155,24 +157,21 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             Residu = abs(float(numpy.dot( TangentFXdX.A1 , Y.A1 ) - numpy.dot( dX.A1 , AdjointFXY.A1 )))
             #
             msg = "  %2i  %5.0e   %9.3e   %9.3e   %9.3e   |  %9.3e"%(i,amplitude,NormeX,NormeY,NormedX,Residu)
-            msgs += "\n" + msg
+            msgs += "\n" + __marge + msg
             #
-            self.StoredVariables["CostFunctionJ"].store( Residu )
-        msgs += "\n" + "-"*nbtirets
+            self.StoredVariables["Residu"].store( Residu )
+        #
+        msgs += "\n" + __marge + "-"*__nbtirets
         msgs += "\n"
         #
         # Sorties eventuelles
         # -------------------
-        logging.debug("%s Résultats :\n%s"%(self._name, msgs))
-        print
-        print "Results of adjoint stability check:"
-        print msgs
-        #
-        logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("Mo")))
-        logging.debug("%s Terminé"%self._name)
+        print("\nResults of adjoint check by \"%s\" formula:"%self._parameters["ResiduFormula"])
+        print(msgs)
         #
+        self._post_run(HO)
         return 0
 
 # ==============================================================================
 if __name__ == "__main__":
-    print '\n AUTODIAGNOSTIC \n'
+    print('\n AUTODIAGNOSTIC \n')