]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation and code review corrections (31)
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sat, 1 Oct 2022 14:28:02 +0000 (16:28 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sat, 1 Oct 2022 14:28:02 +0000 (16:28 +0200)
doc/en/advanced.rst
doc/en/bibliography.rst
doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst
doc/en/snippets/EnsembleOfSnapshots.rst
doc/fr/advanced.rst
doc/fr/bibliography.rst
doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst
doc/fr/snippets/EnsembleOfSnapshots.rst

index b96cb8d0abc7e216ce4b1535476ad17213914d26..993cfc455921527778ad5c05371764d210136c53 100644 (file)
@@ -330,6 +330,7 @@ Change the default execution mode of nodes in YACS
 --------------------------------------------------
 
 .. index:: single: YACS
+.. index:: single: ExecuteInContainer
 
 Various reasons may lead to want to change the default mode of node execution
 in YACS (see [#]_ for the correct use of these possibilities). This may be for
@@ -363,6 +364,11 @@ are adapted to the intended use. The procedure is therefore as follows:
 This can be repeated for each node that requires it, by reusing the same new
 container for all nodes, or by creating a new container for each node.
 
+A more generic way to impose a global execution in a separate container is to
+use a variable named "*ExecuteInContainer*". This variable is available for
+ADAO cases through graphical user interface (GUI) or the textual one (it is for
+example available by default in the :ref:`section_ref_assimilation_keywords`).
+
 .. warning::
 
   This change in execution mode is extremely powerful and flexible. It is
index 62c23f247f15f779f8aa46d9f4f2f40339ea4b54..5fa1ec85c77eddeb053934559084b66f866f2188 100644 (file)
 Bibliography
 ================================================================================
 
+The present bibliography is made of an explicit choice of didactic references,
+often introductory but not only, and as far as possible publicly accessible.
+These references accompany the learning process as well as the advanced use of
+the methods available in the module, without the intention of constituting an
+exhaustive bibliography.
+
 .. [Argaud09] Argaud J.-P., Bouriquet B., Hunt J., *Data Assimilation from Operational and Industrial Applications to Complex Systems*, Mathematics Today, pp.150-152, October 2009
 
 .. [Asch16] Asch M., Bocquet M., Nodet M., *Data Assimilation - Methods, Algorithms and Applications*, SIAM, 2016
index 15503905ce2e3510c483b87944779431adbf99d6..29db43ebfb8aa08e8df175a17ba1e05c0a42be30 100644 (file)
@@ -40,11 +40,13 @@ Task algorithm "*MeasurementsOptimalPositioningTask*"
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo01.rst
 
-This algorithm provides optimal measurement points by an EIM (Empirical
-Interpolation Method) analysis, from a set of state vectors (usually called
-"snapshots" in reduced basis methodology). Each of these state vectors is
-usually (but not necessarily) the result :math:`\mathbf{y}` of a simulation
-:math:`H` for a given set of parameters :math:`\mathbf{x}=\mu`.
+This algorithm provides optimal positioning of measurement points by an EIM
+(Empirical Interpolation Method) analysis, from a set of state vectors (usually
+called "snapshots" in reduced basis methodology).
+
+Each of these state vectors is usually (but not necessarily) the result
+:math:`\mathbf{y}` of a simulation :math:`H` for a given set of parameters
+:math:`\mathbf{x}=\mu`.
 
 In its simplest use, if the set of state vectors is pre-existing, it is only
 necessary to provide it through the algorithm options.
index ce3d82ed17b7520632e2e818b8d2cb4602a2d987..8ec3555601f96a39ea3b7ef5ce57d5536035c329 100644 (file)
@@ -2,11 +2,12 @@
 
 EnsembleOfSnapshots
   *List of vectors or matrix*. This key contains a set of physical state
-  vectors :math:`\mathbf{y}` (called "*snapshots*" in "Reduced Bases"
-  terminology), with 1 state per column if it is a matrix or 1 state per
-  element of the list. Important: the numbering of the points, to which a state
-  value is given, in each vector is implicitly that of the natural order of
-  numbering of the state vector, from 0 to the "size minus 1" of this vector.
+  vectors :math:`\mathbf{y}` (called "*snapshots*" in reduced basis
+  terminology), with 1 state per column if it is a matrix, or 1 state per
+  element if it is a list. Caution: the numbering of the points, to which a
+  state value is given in each vector, is implicitly that of the natural order
+  of numbering of the state vector, from 0 to the "size minus 1" of this
+  vector.
 
   Example :
   ``{"EnsembleOfSnapshots":[y1, y2, y3...]}``
index 4ccea053949df06760965318f48017fbdb814810..767dfab70fbde231d84690c0859ef01de64d25ec 100644 (file)
@@ -355,6 +355,7 @@ Changer le mode par défaut d'exécution de noeuds dans YACS
 ----------------------------------------------------------
 
 .. index:: single: YACS
+.. index:: single: ExecuteInContainer
 
 Diverses raisons peuvent conduire à vouloir modifier le mode par défaut
 d'exécution de noeuds dans YACS (voir [#]_ pour le bon usage de ces
@@ -392,6 +393,12 @@ On peut répéter cette démarche pour chaque noeud qui le nécessite, en
 réutilisant le même nouveau conteneur pour tous les noeuds, ou en créant un
 nouveau conteneur pour chaque noeud.
 
+Une manière plus générale pour imposer une exécution globale dans un conteneur
+séparé est d'utiliser une variable nommée "*ExecuteInContainer*". Cette
+variable est disponible pour les cas ADAO via l'interface graphique (GUI) ou
+l'interface scriptée (elle est par exemple présente par défaut dans la
+:ref:`section_ref_assimilation_keywords`).
+
 .. warning::
 
   Ce changement de mode d'exécution est extrêmement puissant et souple. Il est
index 96f4cceba041d8099223fca8834cfc9c70e5085d..c5506d9d59449845ca67d5da40598e280676c3e8 100644 (file)
 Bibliographie
 ================================================================================
 
+La présente bibliographie est constituée d'un choix explicite de références à
+visée didactique, souvent introductives mais pas uniquement, et dans la mesure
+du possible publiquement accessibles. Ces références accompagnent la prise en
+main comme l'usage avancé des méthodes disponibles dans le module, sans
+néanmoins d'intention de constituer une bibliographie exhaustive.
+
 .. [Argaud09] Argaud J.-P., Bouriquet B., Hunt J., *Data Assimilation from Operational and Industrial Applications to Complex Systems*, Mathematics Today, pp.150-152, October 2009
 
 .. [Asch16] Asch M., Bocquet M., Nodet M., *Data Assimilation - Methods, Algorithms and Applications*, SIAM, 2016
index d014321c690a3c874052a5fa48eb46a674b6b000..9886fe046e0ae3929f4934047d72e54bd1458771 100644 (file)
@@ -41,10 +41,12 @@ Algorithme de tâche "*MeasurementsOptimalPositioningTask*"
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo01.rst
 
-Cet algorithme permet d'établir des points de mesures optimaux par une analyse
-EIM (Empirical Interpolation Method), à partir d'un ensemble de vecteurs d'état
-(usuellement appelés "*snapshots*" en méthodologie de bases réduites). Chacun
-de ces vecteurs d'état est habituellement (mais pas obligatoirement) le
+Cet algorithme permet d'établir la position de points de mesures optimaux par
+une analyse EIM (Empirical Interpolation Method), à partir d'un ensemble de
+vecteurs d'état (usuellement appelés "*snapshots*" en méthodologie de bases
+réduites).
+
+Chacun de ces vecteurs d'état est habituellement (mais pas obligatoirement) le
 résultat :math:`\mathbf{y}` d'une simulation :math:`H` pour un jeu de
 paramètres donné :math:`\mathbf{x}=\mu`.
 
index de66dc4e479ad80519433c22519690e489aa85c6..94bec102b7069d99abc74bb3fe8833cc33d2adee 100644 (file)
@@ -3,11 +3,11 @@
 EnsembleOfSnapshots
   *Liste de vecteurs ou matrice*. Cette clé contient un ensemble de vecteurs
   d'état physique :math:`\mathbf{y}` (nommés "*snapshots*" en terminologie de
-  "Bases Réduites"), avec 1 état par colonne si c'est une matrice ou 1 état par
-  élément de la liste. Important : la numérotation des points, auxquels sont
-  fournis une valeur d'état, dans chaque vecteur est implicitement celle de
-  l'ordre naturel de numérotation du vecteur d'état, de 0 à la "taille moins 1"
-  de ce vecteur.
+  bases réduites), avec 1 état par colonne si c'est une matrice, ou 1 état par
+  élément si c'est une liste. Important : la numérotation des points, auxquels
+  sont fournis une valeur d'état dans chaque vecteur, est implicitement celle
+  de l'ordre naturel de numérotation du vecteur d'état, de 0 à la "taille moins
+  1" de ce vecteur.
 
   Exemple :
   ``{"EnsembleOfSnapshots":[y1, y2, y3...]}``