1 # -*- coding: utf-8 -*-
3 # Copyright (C) 2008-2019 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"),
95 def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
96 self._pre_run(Parameters, Xb, Y, R, B, Q)
100 return math.sqrt( ((numpy.ravel(V2) - numpy.ravel(V1))**2).sum() / float(numpy.ravel(V1).size) )
104 Hm = HO["Direct"].appliedTo
105 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
106 Ht = HO["Tangent"].appliedInXTo
108 # Construction des perturbations
109 # ------------------------------
110 Perturbations = [ 10**i for i in range(self._parameters["EpsilonMinimumExponent"],1) ]
111 Perturbations.reverse()
113 # Calcul du point courant
114 # -----------------------
115 Xn = numpy.asmatrix(numpy.ravel( Xb )).T
116 FX = numpy.asmatrix(numpy.ravel( Hm( Xn ) )).T
117 NormeX = numpy.linalg.norm( Xn )
118 NormeFX = numpy.linalg.norm( FX )
119 if self._toStore("CurrentState"):
120 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn) )
121 if self._toStore("SimulatedObservationAtCurrentState"):
122 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX) )
124 # Fabrication de la direction de l'increment dX
125 # ---------------------------------------------
126 if len(self._parameters["InitialDirection"]) == 0:
130 dX0.append( numpy.random.normal(0.,abs(v)) )
132 dX0.append( numpy.random.normal(0.,Xn.mean()) )
134 dX0 = numpy.ravel( self._parameters["InitialDirection"] )
136 dX0 = float(self._parameters["AmplitudeOfInitialDirection"]) * numpy.matrix( dX0 ).T
138 # Calcul du gradient au point courant X pour l'increment dX
139 # ---------------------------------------------------------
140 if self._parameters["ResiduFormula"] in ["Taylor", "NominalTaylor", "NominalTaylorRMS"]:
141 dX1 = float(self._parameters["AmplitudeOfTangentPerturbation"]) * dX0
142 GradFxdX = Ht( (Xn, dX1) )
143 GradFxdX = numpy.asmatrix(numpy.ravel( GradFxdX )).T
144 GradFxdX = float(1./self._parameters["AmplitudeOfTangentPerturbation"]) * GradFxdX
146 # Entete des resultats
147 # --------------------
150 Remarque : les nombres inferieurs a %.0e (environ) representent un zero
151 a la precision machine.\n"""%mpr
152 if self._parameters["ResiduFormula"] == "CenteredDL":
153 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R )"
155 On observe le residu provenant de la difference centree des valeurs de F
156 au point nominal et aux points perturbes, normalisee par la valeur au
159 || F(X+Alpha*dX) + F(X-Alpha*dX) - 2*F(X) ||
160 R(Alpha) = --------------------------------------------
163 S'il reste constamment tres faible par rapport a 1, l'hypothese de linearite
166 Si le residu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
167 faible qu'a partir d'un certain ordre d'increment, l'hypothese de linearite
168 de F n'est pas verifiee.
170 Si le residu decroit et que la decroissance se fait en Alpha**2 selon Alpha,
171 cela signifie que le gradient est calculable jusqu'a la precision d'arret
172 de la decroissance quadratique.
174 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
175 if self._parameters["ResiduFormula"] == "Taylor":
176 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) log10( R )"
178 On observe le residu issu du developpement de Taylor de la fonction F,
179 normalisee par la valeur au point nominal :
181 || F(X+Alpha*dX) - F(X) - Alpha * GradientF_X(dX) ||
182 R(Alpha) = ----------------------------------------------------
185 S'il reste constamment tres faible par rapport a 1, l'hypothese de linearite
188 Si le residu varie, ou qu'il est de l'ordre de 1 ou plus, et qu'il n'est
189 faible qu'a partir d'un certain ordre d'increment, l'hypothese de linearite
190 de F n'est pas verifiee.
192 Si le residu decroit et que la decroissance se fait en Alpha**2 selon Alpha,
193 cela signifie que le gradient est bien calcule jusqu'a la precision d'arret
194 de la decroissance quadratique.
196 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
197 if self._parameters["ResiduFormula"] == "NominalTaylor":
198 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) |R-1| en %"
200 On observe le residu obtenu a partir de deux approximations d'ordre 1 de F(X),
201 normalisees par la valeur au point nominal :
204 || F(X+Alpha*dX) - Alpha * F(dX) || / || F(X) ||,
205 || F(X-Alpha*dX) + Alpha * F(dX) || / || F(X) ||,
208 S'il reste constamment egal a 1 a moins de 2 ou 3 pourcents pres (c'est-a-dire
209 que |R-1| reste egal a 2 ou 3 pourcents), c'est que l'hypothese de linearite
212 S'il est egal a 1 sur une partie seulement du domaine de variation de
213 l'increment Alpha, c'est sur cette partie que l'hypothese de linearite de F
216 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
217 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
218 __entete = u" i Alpha ||X|| ||F(X)|| | R(Alpha) |R| en %"
220 On observe le residu obtenu a partir de deux approximations d'ordre 1 de F(X),
221 normalisees par la valeur au point nominal :
224 RMS( F(X), F(X+Alpha*dX) - Alpha * F(dX) ) / || F(X) ||,
225 RMS( F(X), F(X-Alpha*dX) + Alpha * F(dX) ) / || F(X) ||,
228 S'il reste constamment egal a 0 a moins de 1 ou 2 pourcents pres, c'est
229 que l'hypothese de linearite de F est verifiee.
231 S'il est egal a 0 sur une partie seulement du domaine de variation de
232 l'increment Alpha, c'est sur cette partie que l'hypothese de linearite de F
235 On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.\n""" + __precision
237 if len(self._parameters["ResultTitle"]) > 0:
238 __rt = unicode(self._parameters["ResultTitle"])
240 msgs += __marge + "====" + "="*len(__rt) + "====\n"
241 msgs += __marge + " " + __rt + "\n"
242 msgs += __marge + "====" + "="*len(__rt) + "====\n"
247 __nbtirets = len(__entete) + 2
248 msgs += "\n" + __marge + "-"*__nbtirets
249 msgs += "\n" + __marge + __entete
250 msgs += "\n" + __marge + "-"*__nbtirets
252 # Boucle sur les perturbations
253 # ----------------------------
254 for i,amplitude in enumerate(Perturbations):
257 if self._parameters["ResiduFormula"] == "CenteredDL":
258 if self._toStore("CurrentState"):
259 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
260 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
262 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
263 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
265 if self._toStore("SimulatedObservationAtCurrentState"):
266 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
267 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
269 Residu = numpy.linalg.norm( FX_plus_dX + FX_moins_dX - 2 * FX ) / NormeFX
271 self.StoredVariables["Residu"].store( Residu )
272 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
273 msgs += "\n" + __marge + msg
275 if self._parameters["ResiduFormula"] == "Taylor":
276 if self._toStore("CurrentState"):
277 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
279 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
281 if self._toStore("SimulatedObservationAtCurrentState"):
282 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
284 Residu = numpy.linalg.norm( FX_plus_dX - FX - amplitude * GradFxdX ) / NormeFX
286 self.StoredVariables["Residu"].store( Residu )
287 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %4.0f"%(i,amplitude,NormeX,NormeFX,Residu,math.log10(max(1.e-99,Residu)))
288 msgs += "\n" + __marge + msg
290 if self._parameters["ResiduFormula"] == "NominalTaylor":
291 if self._toStore("CurrentState"):
292 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
293 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
294 self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
296 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
297 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
298 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
300 if self._toStore("SimulatedObservationAtCurrentState"):
301 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
302 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
303 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
306 numpy.linalg.norm( FX_plus_dX - amplitude * FdX ) / NormeFX,
307 numpy.linalg.norm( FX_moins_dX + amplitude * FdX ) / NormeFX,
310 self.StoredVariables["Residu"].store( Residu )
311 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*abs(Residu-1.),"%")
312 msgs += "\n" + __marge + msg
314 if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
315 if self._toStore("CurrentState"):
316 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn + dX) )
317 self.StoredVariables["CurrentState"].store( numpy.ravel(Xn - dX) )
318 self.StoredVariables["CurrentState"].store( numpy.ravel(dX) )
320 FX_plus_dX = numpy.asmatrix(numpy.ravel( Hm( Xn + dX ) )).T
321 FX_moins_dX = numpy.asmatrix(numpy.ravel( Hm( Xn - dX ) )).T
322 FdX = numpy.asmatrix(numpy.ravel( Hm( dX ) )).T
324 if self._toStore("SimulatedObservationAtCurrentState"):
325 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_plus_dX) )
326 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FX_moins_dX) )
327 self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(FdX) )
330 RMS( FX, FX_plus_dX - amplitude * FdX ) / NormeFX,
331 RMS( FX, FX_moins_dX + amplitude * FdX ) / NormeFX,
334 self.StoredVariables["Residu"].store( Residu )
335 msg = " %2i %5.0e %9.3e %9.3e | %9.3e %5i %s"%(i,amplitude,NormeX,NormeFX,Residu,100.*Residu,"%")
336 msgs += "\n" + __marge + msg
338 msgs += "\n" + __marge + "-"*__nbtirets
341 # Sorties eventuelles
342 # -------------------
343 print("\nResults of linearity check by \"%s\" formula:"%self._parameters["ResiduFormula"])
349 # ==============================================================================
350 if __name__ == "__main__":
351 print('\n AUTODIAGNOSTIC \n')