From 5df6d68e0974a195b1ab1c2882129a3cbe1d21aa Mon Sep 17 00:00:00 2001
From: Jean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Date: Thu, 23 May 2013 14:31:44 +0200
Subject: [PATCH] Correcting documentation and comments

---
 doc/advanced.rst                             | 2 +-
 src/daComposant/daAlgorithms/AdjointTest.py  | 4 ++--
 src/daComposant/daAlgorithms/FunctionTest.py | 4 ++--
 src/daComposant/daAlgorithms/GradientTest.py | 9 +++++----
 4 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/doc/advanced.rst b/doc/advanced.rst
index 1f1c23e..b462aea 100644
--- a/doc/advanced.rst
+++ b/doc/advanced.rst
@@ -44,7 +44,7 @@ The template of the shell script is the following::
         $USERDIR/<ADAO Python file> $USERDIR/<ADAO YACS xml scheme>
     $SALOMEDIR/runSession driver $USERDIR/<ADAO YACS xml scheme>
     $SALOMEDIR/runSession killSalome.py
-    rm -f $USERDIR/ADAO_Case.xml
+    rm -f $USERDIR/<ADAO YACS xml scheme>
 
 Standard output and errors come on console.
 
diff --git a/src/daComposant/daAlgorithms/AdjointTest.py b/src/daComposant/daAlgorithms/AdjointTest.py
index a7e8033..9734bb9 100644
--- a/src/daComposant/daAlgorithms/AdjointTest.py
+++ b/src/daComposant/daAlgorithms/AdjointTest.py
@@ -77,8 +77,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         # ----------------------
         self.setParameters(Parameters)
         #
-        # Opérateur d'observation
-        # -----------------------
+        # Opérateurs
+        # ----------
         Hm = HO["Direct"].appliedTo
         Ht = HO["Tangent"].appliedInXTo
         Ha = HO["Adjoint"].appliedInXTo
diff --git a/src/daComposant/daAlgorithms/FunctionTest.py b/src/daComposant/daAlgorithms/FunctionTest.py
index d99cead..04bdda2 100644
--- a/src/daComposant/daAlgorithms/FunctionTest.py
+++ b/src/daComposant/daAlgorithms/FunctionTest.py
@@ -45,8 +45,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         # ----------------------
         self.setParameters(Parameters)
         #
-        # Opérateur d'observation
-        # -----------------------
+        # Opérateur
+        # ---------
         Hm = HO["Direct"].appliedTo
         #
         # Calcul du point nominal
diff --git a/src/daComposant/daAlgorithms/GradientTest.py b/src/daComposant/daAlgorithms/GradientTest.py
index 36bce3f..009ec22 100644
--- a/src/daComposant/daAlgorithms/GradientTest.py
+++ b/src/daComposant/daAlgorithms/GradientTest.py
@@ -95,8 +95,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         # ----------------------
         self.setParameters(Parameters)
         #
-        # Opérateur d'observation
-        # -----------------------
+        # Opérateurs
+        # ----------
         Hm = HO["Direct"].appliedTo
         if self._parameters["ResiduFormula"] is "Taylor":
             Ht = HO["Tangent"].appliedInXTo
@@ -110,7 +110,6 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         # -----------------------
         X       = numpy.asmatrix(numpy.ravel(    Xb   )).T
         FX      = numpy.asmatrix(numpy.ravel( Hm( X ) )).T
-        FX      = numpy.asmatrix(numpy.ravel(    FX   )).T
         NormeX  = numpy.linalg.norm( X )
         NormeFX = numpy.linalg.norm( FX )
         #
@@ -142,7 +141,9 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
 
               R(Alpha) = || F(X+Alpha*dX) - F(X) - Alpha * TangentF_X(dX) ||
 
-            Ce résidu doit décroître en Alpha**2 selon Alpha.
+            Si F n'est pas linéaire, ce résidu doit décroître en Alpha**2 selon Alpha.
+            Si F est linéaire, le résidu décroit en Alpha à partir de l'erreur faite
+            sur le terme TangentF_X.
             On prend dX0 = Normal(0,X) et dX = Alpha*dX0. F est le code de calcul.
             """
         elif self._parameters["ResiduFormula"] is "Norm":
-- 
2.39.2