1 # -*- coding: utf-8 -*-
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()
27 if sys.version_info.major > 2:
30 # ==============================================================================
31 class ElementaryAlgorithm(BasicObjects.Algorithm):
33 BasicObjects.Algorithm.__init__(self, "LINEARITYTEST")
34 self.defineRequiredParameter(
35 name = "ResiduFormula",
36 default = "CenteredDL",
38 message = "Formule de résidu utilisée",
39 listval = ["CenteredDL", "Taylor", "NominalTaylor", "NominalTaylorRMS"],
41 self.defineRequiredParameter(
42 name = "EpsilonMinimumExponent",
45 message = "Exposant minimal en puissance de 10 pour le multiplicateur d'incrément",
49 self.defineRequiredParameter(
50 name = "InitialDirection",
53 message = "Direction initiale de la dérivée directionnelle autour du point nominal",
55 self.defineRequiredParameter(
56 name = "AmplitudeOfInitialDirection",
59 message = "Amplitude de la direction initiale de la dérivée directionnelle autour du point nominal",
61 self.defineRequiredParameter(
62 name = "AmplitudeOfTangentPerturbation",
65 message = "Amplitude de la perturbation pour le calcul de la forme tangente",
69 self.defineRequiredParameter(
71 typecast = numpy.random.seed,
72 message = "Graine fixée pour le générateur aléatoire",
74 self.defineRequiredParameter(
78 message = "Titre du tableau et de la figure",
80 self.defineRequiredParameter(
81 name = "StoreSupplementaryCalculations",
84 message = "Liste de calculs supplémentaires à stocker et/ou effectuer",
85 listval = ["CurrentState", "Residu", "SimulatedObservationAtCurrentState"]
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)
93 return math.sqrt( ((numpy.ravel(V2) - numpy.ravel(V1))**2).sum() / float(numpy.ravel(V1).size) )
97 Hm = HO["Direct"].appliedTo
98 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
99 Ht = HO["Tangent"].appliedInXTo
101 # Construction des perturbations
102 # ------------------------------
103 Perturbations = [ 10**i for i in range(self._parameters["EpsilonMinimumExponent"],1) ]
104 Perturbations.reverse()
106 # Calcul du point courant
107 # -----------------------
108 Xn = numpy.asmatrix(numpy.ravel( Xb )).T
109 FX = numpy.asmatrix(numpy.ravel( Hm( Xn ) )).T
110 NormeX = numpy.linalg.norm( Xn )
111 NormeFX = numpy.linalg.norm( FX )
112 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
113 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn) )
114 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
115 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX) )
117 # Fabrication de la direction de l'increment dX
118 # ---------------------------------------------
119 if len(self._parameters["InitialDirection"]) == 0:
123 dX0.append( numpy.random.normal(0.,abs(v)) )
125 dX0.append( numpy.random.normal(0.,Xn.mean()) )
127 dX0 = numpy.ravel( self._parameters["InitialDirection"] )
129 dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
131 # Calcul du gradient au point courant X pour l'increment dX
132 # ---------------------------------------------------------
133 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
134 dX1 = float(self._parameters["AmplitudeOfTangentPerturbation"]) * dX0
135 GradFxdX = Ht( (Xn, dX1) )
136 GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
137 GradFxdX = float(1./self._parameters["AmplitudeOfTangentPerturbation"]) * GradFxdX
139 # Entete des resultats
140 # --------------------
143 Remarque : les nombres inferieurs a %.0e (environ) representent un zero
144 a la precision machine.\n"""%mpr
145 if self._parameters["ResiduFormula"] == "CenteredDL":
146 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R ) "
148 On observe le residu provenant de la difference centree des valeurs de F
149 au point nominal et aux points perturbes, normalisee par la valeur au
152 || F(X+Alpha*dX) + F(X-Alpha*dX) - 2*F(X) ||
153 R(Alpha) = --------------------------------------------
156 S'il reste constamment tres faible par rapport a 1, l'hypothese de linearite
159 Si le residu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
160 faible qu'a partir d'un certain ordre d'increment, l'hypothese de linearite
161 de F n'est pas verifiee.
163 Si le residu decroit et que la decroissance se fait en Alpha**2 selon Alpha,
164 cela signifie que le gradient est calculable jusqu'a la precision d'arret
165 de la decroissance quadratique.
167 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
169 if self._parameters["ResiduFormula"] == "Taylor":
170 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R ) "
172 On observe le residu issu du developpement de Taylor de la fonction F,
173 normalisee par la valeur au point nominal :
175 || F(X+Alpha*dX) - F(X) - Alpha * GradientF_X(dX) ||
176 R(Alpha) = ----------------------------------------------------
179 S'il reste constamment tres faible par rapport a 1, l'hypothese de linearite
182 Si le residu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
183 faible qu'a partir d'un certain ordre d'increment, l'hypothese de linearite
184 de F n'est pas verifiee.
186 Si le residu decroit et que la decroissance se fait en Alpha**2 selon Alpha,
187 cela signifie que le gradient est bien calcule jusqu'a la precision d'arret
188 de la decroissance quadratique.
190 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
192 if self._parameters["ResiduFormula"] == "NominalTaylor":
193 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) |R-1| en % "
195 On observe le residu obtenu a partir de deux approximations d'ordre 1 de F(X),
196 normalisees par la valeur au point nominal :
199 || F(X+Alpha*dX) - Alpha * F(dX) || / || F(X) ||,
200 || F(X-Alpha*dX) + Alpha * F(dX) || / || F(X) ||,
203 S'il reste constamment egal a 1 a moins de 2 ou 3 pourcents pres (c'est-a-dire
204 que |R-1| reste egal a 2 ou 3 pourcents), c'est que l'hypothese de linearite
207 S'il est egal a 1 sur une partie seulement du domaine de variation de
208 l'increment Alpha, c'est sur cette partie que l'hypothese de linearite de F
211 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
213 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
214 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) |R| en % "
216 On observe le residu obtenu a partir de deux approximations d'ordre 1 de F(X),
217 normalisees par la valeur au point nominal :
220 RMS( F(X), F(X+Alpha*dX) - Alpha * F(dX) ) / || F(X) ||,
221 RMS( F(X), F(X-Alpha*dX) + Alpha * F(dX) ) / || F(X) ||,
224 S'il reste constamment egal a 0 a moins de 1 ou 2 pourcents pres, c'est
225 que l'hypothese de linearite de F est verifiee.
227 S'il est egal a 0 sur une partie seulement du domaine de variation de
228 l'increment Alpha, c'est sur cette partie que l'hypothese de linearite de F
231 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
234 if len(self._parameters["ResultTitle"]) > 0:
235 __rt = unicode(self._parameters["ResultTitle"])
237 msgs += __marge + "====" + "="*len(__rt) + "====\n"
238 msgs += __marge + " " + __rt + "\n"
239 msgs += __marge + "====" + "="*len(__rt) + "====\n"
244 __nbtirets = len(__entete)
245 msgs += "\n" + __marge + "-"*__nbtirets
246 msgs += "\n" + __marge + __entete
247 msgs += "\n" + __marge + "-"*__nbtirets
249 # Boucle sur les perturbations
250 # ----------------------------
251 for i,amplitude in enumerate(Perturbations):
254 if self._parameters["ResiduFormula"] == "CenteredDL":
255 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
256 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
257 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
259 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
260 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
262 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
263 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
264 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
266 Residu = numpy.linalg.norm( FX_plus_dX + FX_moins_dX - 2 * FX ) / NormeFX
268 self.StoredVariables["Residu"].store( Residu )
269 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
270 msgs += "\n" + __marge + msg
272 if self._parameters["ResiduFormula"] == "Taylor":
273 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
274 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
276 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
278 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
279 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
281 Residu = numpy.linalg.norm( FX_plus_dX - FX - amplitude * GradFxdX ) / NormeFX
283 self.StoredVariables["Residu"].store( Residu )
284 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
285 msgs += "\n" + __marge + msg
287 if self._parameters["ResiduFormula"] == "NominalTaylor":
288 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
289 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
290 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
291 self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
293 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
294 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
295 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
297 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
298 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
299 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
300 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
303 numpy.linalg.norm( FX_plus_dX - amplitude * FdX ) / NormeFX,
304 numpy.linalg.norm( FX_moins_dX + amplitude * FdX ) / NormeFX,
307 self.StoredVariables["Residu"].store( Residu )
308 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*abs(Residu-1.),"%")
309 msgs += "\n" + __marge + msg
311 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
312 if "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
313 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
314 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
315 self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
317 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
318 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
319 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
321 if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
322 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
323 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
324 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
327 RMS( FX, FX_plus_dX - amplitude * FdX ) / NormeFX,
328 RMS( FX, FX_moins_dX + amplitude * FdX ) / NormeFX,
331 self.StoredVariables["Residu"].store( Residu )
332 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*Residu,"%")
333 msgs += "\n" + __marge + msg
335 msgs += "\n" + __marge + "-"*__nbtirets
338 # Sorties eventuelles
339 # -------------------
340 print("\nResults of linearity check by \"%s\" formula:"%self._parameters["ResiduFormula"])
346 # ==============================================================================
347 if __name__ == "__main__":
348 print('\n AUTODIAGNOSTIC \n')