]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Updating and correcting documentation
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sun, 16 Jun 2019 10:02:39 +0000 (12:02 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sun, 16 Jun 2019 10:02:39 +0000 (12:02 +0200)
doc/en/advanced.rst
doc/en/glossary.rst
doc/en/ref_algorithm_FunctionTest.rst
doc/en/ref_algorithm_ParallelFunctionTest.rst [new file with mode: 0644]
doc/en/reference.rst
doc/fr/glossary.rst
doc/fr/ref_algorithm_FunctionTest.rst
doc/fr/ref_algorithm_ParallelFunctionTest.rst [new file with mode: 0644]
doc/fr/reference.rst

index cbc9cd34501351df1b9987fac1dacab8d7b38c8e..5dc694d0e6ab7b3b664f7144b5fb9f315b1a1d88 100644 (file)
@@ -501,7 +501,7 @@ with a new name.
 To make future developments easier, it is strongly recommended to ensure that
 your user scripts files use a Python 2 and a Python 3 compatible syntax. In
 particular, it is recommended to use the functional syntax for "*print*" and not
-the "*command*" syntax, for example:
+the "*command*" syntax, for example::
 
     # Python 2 & 3
     x, unit = 1., "cm"
index 61ee03aee55ee0e31d16132cab526332f83e75cc..a3a33b26d45ed47943fd5106b45d104d9bd3ddb6 100644 (file)
@@ -94,20 +94,25 @@ Glossary
       Keyword to indicate the standard errors diagonal matrix of *a posteriori*
       analysis errors.
 
-   BMA (Background minus Analysis)
-      Difference between the background state and the optimal state estimation,
-      noted as :math:`\mathbf{x}^b - \mathbf{x}^a`.
-
-   OMA (Observation minus Analysis)
-      Difference between the observations and the result of the simulation based
-      on the optimal state estimation, the analysis, filtered to be compatible
-      with the observation, noted as :math:`\mathbf{y}^o -
-      \mathbf{H}\mathbf{x}^a`.
-
-   OMB (Observation minus Background)
-      Difference between the observations and the result of the simulation based
-      on the background state, filtered to be compatible with the observation,
-      noted as :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^b`.
+   BMA
+      The acronym means *Background minus Analysis*. It is the difference
+      between the background state and the optimal state estimation,
+      corresponding to the mathematical expression :math:`\mathbf{x}^b -
+      \mathbf{x}^a`.
+
+   OMA
+      The acronym means *Observation minus Analysis*. It is the difference
+      between the observations and the result of the simulation based on the
+      optimal state estimation, the analysis, filtered to be compatible with
+      the observation, corresponding to the mathematical expression
+      :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^a`.
+
+   OMB
+      The acronym means *Observation minus Background*. It is the difference
+      between the observations and the result of the simulation based on the
+      background state, filtered to be compatible with the observation,
+      corresponding to the mathematical expression :math:`\mathbf{y}^o -
+      \mathbf{H}\mathbf{x}^b`.
 
    SigmaBck2
       Keyword to indicate the Desroziers-Ivanov parameter measuring the
index 2542a085e741e9cef2befcbcdac6c8a622ba4e3a..9f38afcd45ad3d143ed7b6aeea324afb931144db 100644 (file)
@@ -88,3 +88,4 @@ StoreSupplementaryCalculations
 .. include:: snippets/Header2Algo06.rst
 
 - :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_ParallelFunctionTest`
diff --git a/doc/en/ref_algorithm_ParallelFunctionTest.rst b/doc/en/ref_algorithm_ParallelFunctionTest.rst
new file mode 100644 (file)
index 0000000..58d6ba4
--- /dev/null
@@ -0,0 +1,91 @@
+..
+   Copyright (C) 2008-2019 EDF R&D
+
+   This file is part of SALOME ADAO module.
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, write to the Free Software
+   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+   See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+
+   Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
+
+.. index:: single: ParallelFunctionTest
+.. _section_ref_algorithm_ParallelFunctionTest:
+
+Checking algorithm "*ParallelFunctionTest*"
+-------------------------------------------
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
+
+This algorithm allows to verify that the observation operator is working
+correctly in parallel and that its call is compatible with its usage in ADAO
+algorithms. In practice, it allows to call one or several times the operator in
+parallel, activating or not the "debug" mode during execution.
+
+Statistics on input and output vectors for each execution of operator are given,
+and an another global statistic is given at the end of the checking algorithm.
+The precision of printed outputs can be controlled to facilitate automatic tests
+of operator.
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
+
+.. include:: snippets/CheckingPoint.rst
+
+.. include:: snippets/ObservationOperator.rst
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03Chck.rst
+
+.. include:: snippets/NumberOfPrintedDigits.rst
+
+.. include:: snippets/NumberOfRepetition.rst
+
+.. include:: snippets/SetDebug.rst
+
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
+
+  This list indicates the names of the supplementary variables that can be
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "CurrentState",
+  "SimulatedObservationAtCurrentState",
+  ].
+
+  Example :
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
+
+*None*
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
+
+.. include:: snippets/CurrentState.rst
+
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
+
+- :ref:`section_ref_algorithm_FunctionTest`
+- :ref:`section_ref_algorithm_LinearityTest`
index 5f2664ace8df6894e672187c45801abb6a3ccfac..624bc1a16512d001b480daa41bcd35e628453d8b 100644 (file)
@@ -137,6 +137,7 @@ The mathematical notations used afterward are explained in the section
    ref_algorithm_LinearityTest
    ref_algorithm_LocalSensitivityTest
    ref_algorithm_ObserverTest
+   ref_algorithm_ParallelFunctionTest
    ref_algorithm_SamplingTest
    ref_algorithm_TangentTest
    ref_checking_keywords
index fcecff879a5b82cb66ced32f7eb857f2c8286dca..1ab15d2ca3b81af700a5489f1184e498f6496770 100644 (file)
@@ -98,19 +98,24 @@ Glossaire
       Mot-clé indiquant la matrice diagonale des écarts-types des erreurs *a
       posteriori* d'analyse.
 
-   BMA (Background minus Analysis)
-      Différence entre l'état d'ébauche et l'état optimal estimé, notée
-      :math:`\mathbf{x}^b - \mathbf{x}^a`.
-
-   OMA (Observation minus Analysis)
-      Différence entre les observations et le résultat de la simulation basée
-      sur l'état optimal estimé, l'analyse, filtré pour être compatible avec les
-      observations, notée :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^a`.
-
-   OMB (Observation minus Background)
-      Différence entre les observations et le résultat de la simulation basée
-      sur l'état d'ébauche,  filtré pour être compatible avec les observations,
-      notée :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^b`.
+   BMA
+      L'acronyme signifie *Background moins Analysis*. C'est la différence
+      entre l'état d'ébauche et l'état optimal estimé, correspondant à
+      l'expression mathématique :math:`\mathbf{x}^b - \mathbf{x}^a`.
+
+   OMA
+      L'acronyme signifie *Observation moins Analysis*. C'est la différence
+      entre les observations et le résultat de la simulation basée sur l'état
+      optimal estimé, l'analyse, filtré pour être compatible avec les
+      observations, correspondant à l'expression mathématique
+      :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^a`.
+
+   OMB
+      L'acronyme signifie *Observation moins Background*. C'est la différence
+      entre les observations et le résultat de la simulation basée sur l'état
+      d'ébauche,  filtré pour être compatible avec les observations,
+      correspondant à l'expression mathématique :math:`\mathbf{y}^o -
+      \mathbf{H}\mathbf{x}^b`.
 
    SigmaBck2
       Mot-clé indiquant le paramètre de Desroziers-Ivanov mesurant la
index f122a5ad5ff82e6d1d0ccd9894feb64cd0cd53c6..da54fed4b2735e4bd09dfe86ea29421316603c5f 100644 (file)
@@ -90,3 +90,4 @@ StoreSupplementaryCalculations
 .. include:: snippets/Header2Algo06.rst
 
 - :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_ParallelFunctionTest`
diff --git a/doc/fr/ref_algorithm_ParallelFunctionTest.rst b/doc/fr/ref_algorithm_ParallelFunctionTest.rst
new file mode 100644 (file)
index 0000000..7e9b1d5
--- /dev/null
@@ -0,0 +1,93 @@
+..
+   Copyright (C) 2008-2019 EDF R&D
+
+   This file is part of SALOME ADAO module.
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, write to the Free Software
+   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+   See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+
+   Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
+
+.. index:: single: ParallelFunctionTest
+.. _section_ref_algorithm_ParallelFunctionTest:
+
+Algorithme de vérification "*ParallelFunctionTest*"
+---------------------------------------------------
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
+
+Cet algorithme permet de vérifier que l'opérateur d'observation fonctionne
+correctement en parallèle et que son appel se déroule de manière compatible
+avec son usage dans les algorithmes d'ADAO. De manière pratique, il permet
+d'appeler une ou plusieurs fois l'opérateur en parallèle, en activant ou non le
+mode "debug" lors de l'exécution.
+
+Une statistique sur les vecteurs en entrée et en sortie de chaque exécution de
+l'opérateur est indiquée, et une autre globale est fournie de manière
+récapitulative à la fin de l'algorithme de vérification. La précision
+d'affichage est contrôlable pour permettre l'automatisation des tests
+d'opérateur.
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
+
+.. include:: snippets/CheckingPoint.rst
+
+.. include:: snippets/ObservationOperator.rst
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03Chck.rst
+
+.. include:: snippets/NumberOfPrintedDigits.rst
+
+.. include:: snippets/NumberOfRepetition.rst
+
+.. include:: snippets/SetDebug.rst
+
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
+
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme, si elles sont initialement demandées par
+  l'utilisateur. Cela implique potentiellement des calculs ou du stockage
+  coûteux. La valeur par défaut est une liste vide, aucune de ces variables
+  n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
+  Les noms possibles sont dans la liste suivante : [
+  "CurrentState",
+  "SimulatedObservationAtCurrentState",
+  ].
+
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
+
+*Aucune*
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
+
+.. include:: snippets/CurrentState.rst
+
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
+
+- :ref:`section_ref_algorithm_FunctionTest`
+- :ref:`section_ref_algorithm_LinearityTest`
index 9e1373ce735904352874b7e55fc43ee6ba8dbd92..0bc508e9cc12113ff1b9e0a4403039b1d2f14c15 100644 (file)
@@ -138,6 +138,7 @@ section :ref:`section_theory`.
    ref_algorithm_LinearityTest
    ref_algorithm_LocalSensitivityTest
    ref_algorithm_ObserverTest
+   ref_algorithm_ParallelFunctionTest
    ref_algorithm_SamplingTest
    ref_algorithm_TangentTest
    ref_checking_keywords