]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Improving warnings in documentation
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Fri, 19 Apr 2013 13:34:53 +0000 (15:34 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Fri, 19 Apr 2013 13:34:53 +0000 (15:34 +0200)
doc/advanced.rst
doc/reference.rst

index 924b3e8223821ed15dfa89e4a4961b1447bff5fd..1f1c23ece2cc23ef0319bc33273c72a45ce41d02 100644 (file)
@@ -194,9 +194,14 @@ The post-processing scripts has to be modified.
 Switching from 6.5 to 6.6
 +++++++++++++++++++++++++
 
-There is no known incompatibility for the ADAO case file or the accompanying
-scripts. The upgrade procedure is to read the old ADAO case file with the new
-SALOME/ADAO module, and save it with a new name.
+There is no known incompatibility for the ADAO case file. The upgrade procedure
+is to read the old ADAO case file with the new SALOME/ADAO module, and save it
+with a new name.
+
+There is one incompatibility introduced for the designation of operators used to
+for the observation operator. The new mandatory names are "*DirectOperator*",
+"*TangentOperator*" and "*AdjointOperator*", as described in the last subsection
+of the chapter :ref:`section_reference`.
 
 Switching from 6.4 to 6.5
 +++++++++++++++++++++++++
index 36fac71c26be484926ba862b1132eba3aad97af8..ed57a45f3187634b5b8c75fd84ee54b375fa26f1 100644 (file)
@@ -797,7 +797,11 @@ value of 1%. This coefficient will be used in the finite difference
 approximation to build the tangent and adjoint operators.
 
 This first operator definition allow easily to test the functional form before
-its use in an ADAO case, reducing the complexity of implementation.
+its use in an ADAO case, greatly reducing the complexity of implementation.
+
+**Important warning:** the name "*DirectOperator*" is mandatory, and the type of
+the X argument can be either a python list, a numpy array or a numpy 1D-matrix.
+The user has to treat these cases in his script.
 
 Second functional form: using "*ScriptWithFunctions*"
 +++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -830,10 +834,15 @@ three mandatory names "*DirectOperator*", "*TangentOperator*" and
         ...
         return something like X
 
-Another time, this second perator definition allow easily to test the functional
-forms before their use in an ADAO case, greatly reducing the complexity of
+Another time, this second operator definition allow easily to test the
+functional forms before their use in an ADAO case, reducing the complexity of
 implementation.
 
+**Important warning:** the names "*DirectOperator*", "*TangentOperator*" and
+"*AdjointOperator*" are mandatory, and the type of the X, Y, dX arguments can be
+either a python list, a numpy array or a numpy 1D-matrix. The user has to treat
+these cases in his script.
+
 Third functional form: using "*ScriptWithSwitch*"
 +++++++++++++++++++++++++++++++++++++++++++++++++