1 # -*- coding: utf-8 -*-
3 # Copyright (C) 2008-2021 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",
88 "SimulatedObservationAtCurrentState",
91 self.requireInputArguments(
92 mandatory= ("Xb", "HO"),
94 self.setAttributes(tags=(
98 def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
99 self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q)
103 return math.sqrt( ((numpy.ravel(V2) - numpy.ravel(V1))**2).sum() / float(numpy.ravel(V1).size) )
107 Hm = HO["Direct"].appliedTo
108 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
109 Ht = HO["Tangent"].appliedInXTo
111 # Construction des perturbations
112 # ------------------------------
113 Perturbations = [ 10**i for i in range(self._parameters["EpsilonMinimumExponent"],1) ]
114 Perturbations.reverse()
116 # Calcul du point courant
117 # -----------------------
118 Xn = numpy.asmatrix(numpy.ravel( Xb )).T
119 FX = numpy.asmatrix(numpy.ravel( Hm( Xn ) )).T
120 NormeX = numpy.linalg.norm( Xn )
121 NormeFX = numpy.linalg.norm( FX )
122 if self._toStore("CurrentState"):
123 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn) )
124 if self._toStore("SimulatedObservationAtCurrentState"):
125 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX) )
127 # Fabrication de la direction de l'increment dX
128 # ---------------------------------------------
129 if len(self._parameters["InitialDirection"]) == 0:
133 dX0.append( numpy.random.normal(0.,abs(v)) )
135 dX0.append( numpy.random.normal(0.,Xn.mean()) )
137 dX0 = numpy.ravel( self._parameters["InitialDirection"] )
139 dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
141 # Calcul du gradient au point courant X pour l'increment dX
142 # ---------------------------------------------------------
143 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
144 dX1 = float(self._parameters["AmplitudeOfTangentPerturbation"]) * dX0
145 GradFxdX = Ht( (Xn, dX1) )
146 GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
147 GradFxdX = float(1./self._parameters["AmplitudeOfTangentPerturbation"]) * GradFxdX
149 # Entete des resultats
150 # --------------------
153 Remarque : les nombres inferieurs a %.0e (environ) representent un zero
154 a la precision machine.\n"""%mpr
155 if self._parameters["ResiduFormula"] == "CenteredDL":
156 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R )"
158 On observe le residu provenant de la difference centree des valeurs de F
159 au point nominal et aux points perturbes, normalisee par la valeur au
162 || F(X+Alpha*dX) + F(X-Alpha*dX) - 2*F(X) ||
163 R(Alpha) = --------------------------------------------
166 S'il reste constamment tres faible par rapport a 1, l'hypothese de linearite
169 Si le residu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
170 faible qu'a partir d'un certain ordre d'increment, l'hypothese de linearite
171 de F n'est pas verifiee.
173 Si le residu decroit et que la decroissance se fait en Alpha**2 selon Alpha,
174 cela signifie que le gradient est calculable jusqu'a la precision d'arret
175 de la decroissance quadratique.
177 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
178 if self._parameters["ResiduFormula"] == "Taylor":
179 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R )"
181 On observe le residu issu du developpement de Taylor de la fonction F,
182 normalisee par la valeur au point nominal :
184 || F(X+Alpha*dX) - F(X) - Alpha * GradientF_X(dX) ||
185 R(Alpha) = ----------------------------------------------------
188 S'il reste constamment tres faible par rapport a 1, l'hypothese de linearite
191 Si le residu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
192 faible qu'a partir d'un certain ordre d'increment, l'hypothese de linearite
193 de F n'est pas verifiee.
195 Si le residu decroit et que la decroissance se fait en Alpha**2 selon Alpha,
196 cela signifie que le gradient est bien calcule jusqu'a la precision d'arret
197 de la decroissance quadratique.
199 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
200 if self._parameters["ResiduFormula"] == "NominalTaylor":
201 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) |R-1| en %"
203 On observe le residu obtenu a partir de deux approximations d'ordre 1 de F(X),
204 normalisees par la valeur au point nominal :
207 || F(X+Alpha*dX) - Alpha * F(dX) || / || F(X) ||,
208 || F(X-Alpha*dX) + Alpha * F(dX) || / || F(X) ||,
211 S'il reste constamment egal a 1 a moins de 2 ou 3 pourcents pres (c'est-a-dire
212 que |R-1| reste egal a 2 ou 3 pourcents), c'est que l'hypothese de linearite
215 S'il est egal a 1 sur une partie seulement du domaine de variation de
216 l'increment Alpha, c'est sur cette partie que l'hypothese de linearite de F
219 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
220 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
221 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) |R| en %"
223 On observe le residu obtenu a partir de deux approximations d'ordre 1 de F(X),
224 normalisees par la valeur au point nominal :
227 RMS( F(X), F(X+Alpha*dX) - Alpha * F(dX) ) / || F(X) ||,
228 RMS( F(X), F(X-Alpha*dX) + Alpha * F(dX) ) / || F(X) ||,
231 S'il reste constamment egal a 0 a moins de 1 ou 2 pourcents pres, c'est
232 que l'hypothese de linearite de F est verifiee.
234 S'il est egal a 0 sur une partie seulement du domaine de variation de
235 l'increment Alpha, c'est sur cette partie que l'hypothese de linearite de F
238 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
240 if len(self._parameters["ResultTitle"]) > 0:
241 __rt = unicode(self._parameters["ResultTitle"])
243 msgs += __marge + "====" + "="*len(__rt) + "====\n"
244 msgs += __marge + " " + __rt + "\n"
245 msgs += __marge + "====" + "="*len(__rt) + "====\n"
250 __nbtirets = len(__entete) + 2
251 msgs += "\n" + __marge + "-"*__nbtirets
252 msgs += "\n" + __marge + __entete
253 msgs += "\n" + __marge + "-"*__nbtirets
255 # Boucle sur les perturbations
256 # ----------------------------
257 for i,amplitude in enumerate(Perturbations):
260 if self._parameters["ResiduFormula"] == "CenteredDL":
261 if self._toStore("CurrentState"):
262 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
263 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
265 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
266 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
268 if self._toStore("SimulatedObservationAtCurrentState"):
269 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
270 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
272 Residu = numpy.linalg.norm( FX_plus_dX + FX_moins_dX - 2 * FX ) / NormeFX
274 self.StoredVariables["Residu"].store( Residu )
275 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
276 msgs += "\n" + __marge + msg
278 if self._parameters["ResiduFormula"] == "Taylor":
279 if self._toStore("CurrentState"):
280 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
282 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
284 if self._toStore("SimulatedObservationAtCurrentState"):
285 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
287 Residu = numpy.linalg.norm( FX_plus_dX - FX - amplitude * GradFxdX ) / NormeFX
289 self.StoredVariables["Residu"].store( Residu )
290 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
291 msgs += "\n" + __marge + msg
293 if self._parameters["ResiduFormula"] == "NominalTaylor":
294 if self._toStore("CurrentState"):
295 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
296 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
297 self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
299 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
300 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
301 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
303 if self._toStore("SimulatedObservationAtCurrentState"):
304 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
305 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
306 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
309 numpy.linalg.norm( FX_plus_dX - amplitude * FdX ) / NormeFX,
310 numpy.linalg.norm( FX_moins_dX + amplitude * FdX ) / NormeFX,
313 self.StoredVariables["Residu"].store( Residu )
314 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*abs(Residu-1.),"%")
315 msgs += "\n" + __marge + msg
317 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
318 if self._toStore("CurrentState"):
319 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
320 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
321 self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
323 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
324 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
325 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
327 if self._toStore("SimulatedObservationAtCurrentState"):
328 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
329 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
330 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
333 RMS( FX, FX_plus_dX - amplitude * FdX ) / NormeFX,
334 RMS( FX, FX_moins_dX + amplitude * FdX ) / NormeFX,
337 self.StoredVariables["Residu"].store( Residu )
338 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*Residu,"%")
339 msgs += "\n" + __marge + msg
341 msgs += "\n" + __marge + "-"*__nbtirets
344 # Sorties eventuelles
345 # -------------------
346 print("\nResults of linearity check by \"%s\" formula:"%self._parameters["ResiduFormula"])
352 # ==============================================================================
353 if __name__ == "__main__":
354 print('\n AUTODIAGNOSTIC\n')