]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation review corrections
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Wed, 22 Mar 2023 16:15:41 +0000 (17:15 +0100)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Wed, 22 Mar 2023 16:15:41 +0000 (17:15 +0100)
doc/en/ref_algorithm_SamplingTest.rst
doc/fr/ref_algorithm_SamplingTest.rst
src/daComposant/daAlgorithms/LinearityTest.py

index a978e7f11af6ef5412fd474bc2fdc5506385fe81..6da602af1cc7cc60ee0e61e61c89032ea79227f1 100644 (file)
@@ -30,29 +30,27 @@ Checking algorithm "*SamplingTest*"
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo01.rst
 
-This algorithm allows to calculate the values, linked to a :math:`\mathbf{x}`
-state, of a general error function :math:`J` of type :math:`L^1`, :math:`L^2`
-or :math:`L^{\infty}`, with or without weights, and of the observation
-operator, for an priori given :math:`\mathbf{x}` states sample. The default
-error function is the augmented weighted least squares function, classically
-used in data assimilation, using observation :math:`\mathbf{y}^o`.
-
-It is useful to test the sensitivity, of the error function :math:`J`, in
-particular, to the state :math:`\mathbf{x}` variations. When a state is not
-observable, a *"NaN"* value is returned.
+This test algorithm is used to establish the collection of values of an error
+functional :math:`J` of type :math:`L^1`, :math:`L^2` or :math:`L^{\infty}`,
+with or without weights, using the observation operator :math:`\mathcal{H}`,
+for an a priori given sample of states :math:`\mathbf{x}`. The default error
+functional is the augmented weighted least squares functional, classically used
+in data assimilation, using in addition to observations :math:`\mathbf{y}^o`.
+
+This test is useful for analyzing the sensitivity of the functional :math:`J`
+to variations in the state :math:`\mathbf{x}` in particular.
 
 The sampling of the states :math:`\mathbf{x}` can be given explicitly or under
 form of hyper-cubes, explicit or sampled according to classic distributions.
 Beware of the size of the hyper-cube (and then to the number of computations)
-that can be reached, it can grow quickly to be quite large.
-
-To be visible by the user while reducing the risk of storage difficulties, the
-results of sampling or simulations has to be **explicitly** asked for. One use
-for that, on the desired variable, the final saving through
-"*UserPostAnalysis*" or the treatment during the calculation by "*observer*".
+that can be reached, it can grow quickly to be quite large. When a state is not
+observable, a *"NaN"* value is returned.
 
-To perform distributed or more complex sampling, see OPENTURNS module available
-in SALOME.
+To access the calculated information, the results of the sampling or
+simulations must be requested **explicitly** to avoid storage difficulties (if
+no results are requested, nothing is available). One use for that, on the
+desired variable, the final saving through "*UserPostAnalysis*" or the
+treatment during the calculation by well suited "*observer*".
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo02.rst
index 7d7553f7f89e799584ecf838ec72177e68067f0e..4b3ec3f6eee7d9d7ad3d3a4aa0a7396b7a37a8ff 100644 (file)
@@ -30,32 +30,30 @@ Algorithme de vérification "*SamplingTest*"
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo01.rst
 
-Cet algorithme permet d'établir les valeurs, liées à un état
-:math:`\mathbf{x}`, d'une fonctionnelle d'erreur :math:`J` quelconque de type
-:math:`L^1`, :math:`L^2` ou :math:`L^{\infty}`, avec ou sans pondérations, et
-de l'opérateur d'observation, pour un échantillon d'états :math:`\mathbf{x}`
-donné a priori. La fonctionnelle d'erreur par défaut est celle de moindres
+Cet algorithme de test permet d'établir la collection des valeurs d'une
+fonctionnelle d'erreur :math:`J` de type :math:`L^1`, :math:`L^2` ou
+:math:`L^{\infty}`, avec ou sans pondérations, à l'aide de l'opérateur
+d'observation :math:`\mathcal{H}`, pour un échantillon donné a priori d'états
+:math:`\mathbf{x}`. La fonctionnelle d'erreur par défaut est celle de moindres
 carrés pondérés augmentés, classiquement utilisée en assimilation de données,
-utilisant des observations :math:`\mathbf{y}^o`.
+utilisant en plus des observations :math:`\mathbf{y}^o`.
 
-Il est utile pour tester la sensibilité, de la fonctionnelle :math:`J`, en
-particulier, aux variations de l'état :math:`\mathbf{x}`. Lorsque un état n'est
-pas observable, une valeur *"NaN"* est retournée.
+Ce test est utile pour analyser la sensibilité de la fonctionnelle :math:`J`
+aux variations de l'état :math:`\mathbf{x}` en particulier.
 
 L'échantillonnage des états :math:`\mathbf{x}` peut être fourni explicitement
 ou sous la forme d'hyper-cubes, explicites ou échantillonnés selon des
 distributions courantes. Attention à la taille de l'hyper-cube (et donc au
 nombre de calculs) qu'il est possible d'atteindre, elle peut rapidement devenir
-importante.
-
-Pour apparaître pour l'utilisateur tout en réduisant les difficultés de
-stockage, les résultats de l'échantillonnage ou des simulations doivent être
-demandés **explicitement**. On utilise pour cela, sur la variable désirée, la
-sauvegarde finale à l'aide du mot-clé "*UserPostAnalysis*" ou le traitement en
-cours de calcul à l'aide des "*observer*" adaptés.
-
-Pour effectuer un échantillonnage distribué ou plus complexe, voir le module
-OPENTURNS disponible dans SALOME.
+importante. Lorsque un état n'est pas observable, une valeur *"NaN"* est
+retournée.
+
+Pour accéder aux informations calculées, les résultats de l'échantillonnage ou
+des simulations doivent être demandés **explicitement** pour éviter les
+difficultés de stockage (en l'absence de résultats demandés, rien n'est
+disponible). On utilise pour cela, sur la variable désirée, la sauvegarde
+finale à l'aide du mot-clé "*UserPostAnalysis*" ou le traitement en cours de
+calcul à l'aide des "*observer*" adaptés.
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo02.rst
index 5027553616d5817722709d1cabeb9f39ee94debf..eae562faf6e696f07e326077c8e58cbffa9c66b4 100644 (file)
@@ -204,7 +204,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             msgs += (__marge + "of the Alpha increment, it is over this part that the linearity assumption\n")
             msgs += (__marge + "of F is verified.\n")
             #
-            __entete = u"  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)   |R-1| en %"
+            __entete = u"  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)   |R-1| in %"
             #
         if self._parameters["ResiduFormula"] == "NominalTaylorRMS":
             msgs += (__marge + "    R(Alpha) = max(\n")
@@ -219,7 +219,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             msgs += (__marge + "of the Alpha increment, it is over this part that the linearity assumption\n")
             msgs += (__marge + "of F is verified.\n")
             #
-            __entete = u"  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)    |R| en %"
+            __entete = u"  i   Alpha     ||X||      ||F(X)||   |   R(Alpha)    |R| in %"
             #
         msgs += ("\n")
         msgs += (__marge + "We take dX0 = Normal(0,X) and dX = Alpha*dX0. F is the calculation code.\n")