1 #-*-coding:iso-8859-1-*-
3 # Copyright (C) 2008-2014 EDF R&D
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.
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.
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
19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
24 from daCore import BasicObjects, PlatformInfo
25 m = PlatformInfo.SystemUsage()
28 # ==============================================================================
29 class ElementaryAlgorithm(BasicObjects.Algorithm):
31 BasicObjects.Algorithm.__init__(self, "FUNCTIONTEST")
32 self.defineRequiredParameter(
33 name = "ResiduFormula",
34 default = "CenteredDL",
36 message = "Formule de résidu utilisée",
37 listval = ["CenteredDL", "Taylor", "NominalTaylor", "NominalTaylorRMS"],
39 self.defineRequiredParameter(
40 name = "EpsilonMinimumExponent",
43 message = "Exposant minimal en puissance de 10 pour le multiplicateur d'incrément",
47 self.defineRequiredParameter(
48 name = "InitialDirection",
51 message = "Direction initiale de la dérivée directionnelle autour du point nominal",
53 self.defineRequiredParameter(
54 name = "AmplitudeOfInitialDirection",
57 message = "Amplitude de la direction initiale de la dérivée directionnelle autour du point nominal",
59 self.defineRequiredParameter(
61 typecast = numpy.random.seed,
62 message = "Graine fixée pour le générateur aléatoire",
64 self.defineRequiredParameter(
68 message = "Titre du tableau et de la figure",
71 def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
72 logging.debug("%s Lancement"%self._name)
73 logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("M")))
75 # Paramètres de pilotage
76 # ----------------------
77 self.setParameters(Parameters)
81 return math.sqrt( ((numpy.ravel(V2) - numpy.ravel(V1))**2).sum() / float(numpy.ravel(V1).size) )
85 Hm = HO["Direct"].appliedTo
86 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
87 Ht = HO["Tangent"].appliedInXTo
89 # Construction des perturbations
90 # ------------------------------
91 Perturbations = [ 10**i for i in xrange(self._parameters["EpsilonMinimumExponent"],1) ]
92 Perturbations.reverse()
94 # Calcul du point courant
95 # -----------------------
96 Xn = numpy.asmatrix(numpy.ravel( Xb )).T
97 FX = numpy.asmatrix(numpy.ravel( Hm( Xn ) )).T
98 NormeX = numpy.linalg.norm( Xn )
99 NormeFX = numpy.linalg.norm( FX )
101 # Fabrication de la direction de l'incrément dX
102 # ----------------------------------------------
103 if len(self._parameters["InitialDirection"]) == 0:
107 dX0.append( numpy.random.normal(0.,abs(v)) )
109 dX0.append( numpy.random.normal(0.,Xn.mean()) )
111 dX0 = numpy.ravel( self._parameters["InitialDirection"] )
113 dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
115 # Calcul du gradient au point courant X pour l'incrément dX
116 # ---------------------------------------------------------
117 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
118 GradFxdX = Ht( (Xn, dX0) )
119 GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
121 # Entete des resultats
122 # --------------------
124 if self._parameters["ResiduFormula"] == "CenteredDL":
125 __entete = " i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R ) "
127 On observe le résidu provenant de la différence centrée des valeurs de F
128 au point nominal et aux points perturbés, normalisée par la valeur au
131 || F(X+Alpha*dX) + F(X-Alpha*dX) - 2*F(X) ||
132 R(Alpha) = --------------------------------------------
135 S'il reste constamment trés faible par rapport à 1, l'hypothèse de linéarité
138 Si le résidu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
139 faible qu'à partir d'un certain ordre d'incrément, l'hypothèse de linéarité
140 de F n'est pas vérifiée.
142 Si le résidu décroit et que la décroissance se fait en Alpha**2 selon Alpha,
143 cela signifie que le gradient est calculable jusqu'à la précision d'arrêt
144 de la décroissance quadratique.
146 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
148 if self._parameters["ResiduFormula"] == "Taylor":
149 __entete = " i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R ) "
151 On observe le résidu issu du développement de Taylor de la fonction F,
152 normalisée par la valeur au point nominal :
154 || F(X+Alpha*dX) - F(X) - Alpha * GradientF_X(dX) ||
155 R(Alpha) = ----------------------------------------------------
158 S'il reste constamment trés faible par rapport à 1, l'hypothèse de linéarité
161 Si le résidu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
162 faible qu'à partir d'un certain ordre d'incrément, l'hypothèse de linéarité
163 de F n'est pas vérifiée.
165 Si le résidu décroit et que la décroissance se fait en Alpha**2 selon Alpha,
166 cela signifie que le gradient est bien calculé jusqu'à la précision d'arrêt
167 de la décroissance quadratique.
169 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
171 if self._parameters["ResiduFormula"] == "NominalTaylor":
172 __entete = " i Alpha ||X|| ||F(X)|| | R(Alpha) |R-1| en % "
174 On observe le résidu obtenu à partir de deux approximations d'ordre 1 de F(X),
175 normalisées par la valeur au point nominal :
178 || F(X+Alpha*dX) - Alpha * F(dX) || / || F(X) ||,
179 || F(X-Alpha*dX) + Alpha * F(dX) || / || F(X) ||,
182 S'il reste constamment égal à 1 à moins de 2 ou 3 pourcents prés (c'est-à-dire
183 que |R-1| reste égal à 2 ou 3 pourcents), c'est que l'hypothèse de linéarité
186 S'il est égal à 1 sur une partie seulement du domaine de variation de
187 l'incrément Alpha, c'est sur cette partie que l'hypothèse de linéarité de F
190 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
192 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
193 __entete = " i Alpha ||X|| ||F(X)|| | R(Alpha) |R| en % "
195 On observe le résidu obtenu à partir de deux approximations d'ordre 1 de F(X),
196 normalisées par la valeur au point nominal :
199 RMS( F(X), F(X+Alpha*dX) - Alpha * F(dX) ) / || F(X) ||,
200 RMS( F(X), F(X-Alpha*dX) + Alpha * F(dX) ) / || F(X) ||,
203 S'il reste constamment égal à 0 à moins de 1 ou 2 pourcents prés, c'est
204 que l'hypothèse de linéarité de F est vérifiée.
206 S'il est égal à 0 sur une partie seulement du domaine de variation de
207 l'incrément Alpha, c'est sur cette partie que l'hypothèse de linéarité de F
210 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
213 if len(self._parameters["ResultTitle"]) > 0:
215 msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
216 msgs += __marge + " " + self._parameters["ResultTitle"] + "\n"
217 msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
222 __nbtirets = len(__entete)
223 msgs += "\n" + __marge + "-"*__nbtirets
224 msgs += "\n" + __marge + __entete
225 msgs += "\n" + __marge + "-"*__nbtirets
227 # Boucle sur les perturbations
228 # ----------------------------
229 for i,amplitude in enumerate(Perturbations):
232 if self._parameters["ResiduFormula"] == "CenteredDL":
233 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
234 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
236 Residu = numpy.linalg.norm( FX_plus_dX + FX_moins_dX - 2 * FX ) / NormeFX
238 self.StoredVariables["CostFunctionJ"].store( Residu )
239 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
240 msgs += "\n" + __marge + msg
242 if self._parameters["ResiduFormula"] == "Taylor":
243 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
245 Residu = numpy.linalg.norm( FX_plus_dX - FX - amplitude * GradFxdX ) / NormeFX
247 self.StoredVariables["CostFunctionJ"].store( Residu )
248 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
249 msgs += "\n" + __marge + msg
251 if self._parameters["ResiduFormula"] == "NominalTaylor":
252 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
253 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
254 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
257 numpy.linalg.norm( FX_plus_dX - amplitude * FdX ) / NormeFX,
258 numpy.linalg.norm( FX_moins_dX + amplitude * FdX ) / NormeFX,
261 self.StoredVariables["CostFunctionJ"].store( Residu )
262 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*abs(Residu-1.),"%")
263 msgs += "\n" + __marge + msg
265 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
266 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
267 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
268 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
271 RMS( FX, FX_plus_dX - amplitude * FdX ) / NormeFX,
272 RMS( FX, FX_moins_dX + amplitude * FdX ) / NormeFX,
275 self.StoredVariables["CostFunctionJ"].store( Residu )
276 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*Residu,"%")
277 msgs += "\n" + __marge + msg
279 msgs += "\n" + __marge + "-"*__nbtirets
282 # Sorties eventuelles
283 # -------------------
285 print "Results of linearity check by \"%s\" formula:"%self._parameters["ResiduFormula"]
288 logging.debug("%s Nombre d'évaluation(s) de l'opérateur d'observation direct/tangent/adjoint.: %i/%i/%i"%(self._name, HO["Direct"].nbcalls(0),HO["Tangent"].nbcalls(0),HO["Adjoint"].nbcalls(0)))
289 logging.debug("%s Nombre d'appels au cache d'opérateur d'observation direct/tangent/adjoint..: %i/%i/%i"%(self._name, HO["Direct"].nbcalls(3),HO["Tangent"].nbcalls(3),HO["Adjoint"].nbcalls(3)))
290 logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("M")))
291 logging.debug("%s Terminé"%self._name)
295 # ==============================================================================
296 if __name__ == "__main__":
297 print '\n AUTODIAGNOSTIC \n'