1 #-*-coding:iso-8859-1-*-
3 # Copyright (C) 2008-2017 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
26 mpr = PlatformInfo.PlatformInfo().MachinePrecision()
28 # ==============================================================================
29 class ElementaryAlgorithm(BasicObjects.Algorithm):
31 BasicObjects.Algorithm.__init__(self, "LINEARITYTEST")
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(
60 name = "AmplitudeOfTangentPerturbation",
63 message = "Amplitude de la perturbation pour le calcul de la forme tangente",
67 self.defineRequiredParameter(
69 typecast = numpy.random.seed,
70 message = "Graine fixée pour le générateur aléatoire",
72 self.defineRequiredParameter(
76 message = "Titre du tableau et de la figure",
78 self.defineRequiredParameter(
79 name = "StoreSupplementaryCalculations",
82 message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
83 listval = ["CurrentState", "Residu", "SimulatedObservationAtCurrentState"]
86 def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
89 # Paramètres de pilotage
90 # ----------------------
91 self.setParameters(Parameters)
95 return math.sqrt( ((numpy.ravel(V2) - numpy.ravel(V1))**2).sum() / float(numpy.ravel(V1).size) )
99 Hm = HO["Direct"].appliedTo
100 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
101 Ht = HO["Tangent"].appliedInXTo
103 # Construction des perturbations
104 # ------------------------------
105 Perturbations = [ 10**i for i in xrange(self._parameters["EpsilonMinimumExponent"],1) ]
106 Perturbations.reverse()
108 # Calcul du point courant
109 # -----------------------
110 Xn = numpy.asmatrix(numpy.ravel( Xb )).T
111 FX = numpy.asmatrix(numpy.ravel( Hm( Xn ) )).T
112 NormeX = numpy.linalg.norm( Xn )
113 NormeFX = numpy.linalg.norm( FX )
114 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
115 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn) )
116 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
117 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX) )
119 # Fabrication de la direction de l'incrément dX
120 # ----------------------------------------------
121 if len(self._parameters["InitialDirection"]) == 0:
125 dX0.append( numpy.random.normal(0.,abs(v)) )
127 dX0.append( numpy.random.normal(0.,Xn.mean()) )
129 dX0 = numpy.ravel( self._parameters["InitialDirection"] )
131 dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
133 # Calcul du gradient au point courant X pour l'incrément dX
134 # ---------------------------------------------------------
135 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
136 dX1 = float(self._parameters["AmplitudeOfTangentPerturbation"]) * dX0
137 GradFxdX = Ht( (Xn, dX1) )
138 GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
139 GradFxdX = float(1./self._parameters["AmplitudeOfTangentPerturbation"]) * GradFxdX
141 # Entete des resultats
142 # --------------------
145 Remarque : les nombres inferieurs a %.0e (environ) representent un zero
146 a la precision machine.\n"""%mpr
147 if self._parameters["ResiduFormula"] == "CenteredDL":
148 __entete = " i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R ) "
150 On observe le résidu provenant de la différence centrée des valeurs de F
151 au point nominal et aux points perturbés, normalisée par la valeur au
154 || F(X+Alpha*dX) + F(X-Alpha*dX) - 2*F(X) ||
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 calculable 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"] == "Taylor":
172 __entete = " i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R ) "
174 On observe le résidu issu du développement de Taylor de la fonction F,
175 normalisée par la valeur au point nominal :
177 || F(X+Alpha*dX) - F(X) - Alpha * GradientF_X(dX) ||
178 R(Alpha) = ----------------------------------------------------
181 S'il reste constamment trés faible par rapport à 1, l'hypothèse de linéarité
184 Si le résidu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
185 faible qu'à partir d'un certain ordre d'incrément, l'hypothèse de linéarité
186 de F n'est pas vérifiée.
188 Si le résidu décroit et que la décroissance se fait en Alpha**2 selon Alpha,
189 cela signifie que le gradient est bien calculé jusqu'à la précision d'arrêt
190 de la décroissance quadratique.
192 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
194 if self._parameters["ResiduFormula"] == "NominalTaylor":
195 __entete = " i Alpha ||X|| ||F(X)|| | R(Alpha) |R-1| en % "
197 On observe le résidu obtenu à partir de deux approximations d'ordre 1 de F(X),
198 normalisées par la valeur au point nominal :
201 || F(X+Alpha*dX) - Alpha * F(dX) || / || F(X) ||,
202 || F(X-Alpha*dX) + Alpha * F(dX) || / || F(X) ||,
205 S'il reste constamment égal à 1 à moins de 2 ou 3 pourcents prés (c'est-à-dire
206 que |R-1| reste égal à 2 ou 3 pourcents), c'est que l'hypothèse de linéarité
209 S'il est égal à 1 sur une partie seulement du domaine de variation de
210 l'incrément Alpha, c'est sur cette partie que l'hypothèse de linéarité de F
213 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
215 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
216 __entete = " i Alpha ||X|| ||F(X)|| | R(Alpha) |R| en % "
218 On observe le résidu obtenu à partir de deux approximations d'ordre 1 de F(X),
219 normalisées par la valeur au point nominal :
222 RMS( F(X), F(X+Alpha*dX) - Alpha * F(dX) ) / || F(X) ||,
223 RMS( F(X), F(X-Alpha*dX) + Alpha * F(dX) ) / || F(X) ||,
226 S'il reste constamment égal à 0 à moins de 1 ou 2 pourcents prés, c'est
227 que l'hypothèse de linéarité de F est vérifiée.
229 S'il est égal à 0 sur une partie seulement du domaine de variation de
230 l'incrément Alpha, c'est sur cette partie que l'hypothèse de linéarité de F
233 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
236 if len(self._parameters["ResultTitle"]) > 0:
238 msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
239 msgs += __marge + " " + self._parameters["ResultTitle"] + "\n"
240 msgs += __marge + "====" + "="*len(self._parameters["ResultTitle"]) + "====\n"
245 __nbtirets = len(__entete)
246 msgs += "\n" + __marge + "-"*__nbtirets
247 msgs += "\n" + __marge + __entete
248 msgs += "\n" + __marge + "-"*__nbtirets
250 # Boucle sur les perturbations
251 # ----------------------------
252 for i,amplitude in enumerate(Perturbations):
255 if self._parameters["ResiduFormula"] == "CenteredDL":
256 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
257 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
258 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
260 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
261 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
263 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
264 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
265 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
267 Residu = numpy.linalg.norm( FX_plus_dX + FX_moins_dX - 2 * FX ) / NormeFX
269 self.StoredVariables["Residu"].store( Residu )
270 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
271 msgs += "\n" + __marge + msg
273 if self._parameters["ResiduFormula"] == "Taylor":
274 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
275 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
277 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
279 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
280 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
282 Residu = numpy.linalg.norm( FX_plus_dX - FX - amplitude * GradFxdX ) / NormeFX
284 self.StoredVariables["Residu"].store( Residu )
285 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
286 msgs += "\n" + __marge + msg
288 if self._parameters["ResiduFormula"] == "NominalTaylor":
289 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
290 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
291 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
292 self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
294 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
295 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
296 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
298 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
299 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
300 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
301 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
304 numpy.linalg.norm( FX_plus_dX - amplitude * FdX ) / NormeFX,
305 numpy.linalg.norm( FX_moins_dX + amplitude * FdX ) / NormeFX,
308 self.StoredVariables["Residu"].store( Residu )
309 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*abs(Residu-1.),"%")
310 msgs += "\n" + __marge + msg
312 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
313 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
314 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
315 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
316 self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
318 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
319 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
320 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
322 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
323 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
324 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
325 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
328 RMS( FX, FX_plus_dX - amplitude * FdX ) / NormeFX,
329 RMS( FX, FX_moins_dX + amplitude * FdX ) / NormeFX,
332 self.StoredVariables["Residu"].store( Residu )
333 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*Residu,"%")
334 msgs += "\n" + __marge + msg
336 msgs += "\n" + __marge + "-"*__nbtirets
339 # Sorties eventuelles
340 # -------------------
342 print "Results of linearity check by \"%s\" formula:"%self._parameters["ResiduFormula"]
348 # ==============================================================================
349 if __name__ == "__main__":
350 print '\n AUTODIAGNOSTIC \n'