From: Jean-Philippe ARGAUD Date: Sat, 1 Oct 2022 14:28:02 +0000 (+0200) Subject: Minor documentation and code review corrections (31) X-Git-Tag: V9_10_0b~1 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=0d0de6af1272da861bec548a4664cf54ac016406;p=modules%2Fadao.git Minor documentation and code review corrections (31) --- diff --git a/doc/en/advanced.rst b/doc/en/advanced.rst index b96cb8d..993cfc4 100644 --- a/doc/en/advanced.rst +++ b/doc/en/advanced.rst @@ -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 diff --git a/doc/en/bibliography.rst b/doc/en/bibliography.rst index 62c23f2..5fa1ec8 100644 --- a/doc/en/bibliography.rst +++ b/doc/en/bibliography.rst @@ -27,6 +27,12 @@ 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 diff --git a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst index 1550390..29db43e 100644 --- a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -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. diff --git a/doc/en/snippets/EnsembleOfSnapshots.rst b/doc/en/snippets/EnsembleOfSnapshots.rst index ce3d82e..8ec3555 100644 --- a/doc/en/snippets/EnsembleOfSnapshots.rst +++ b/doc/en/snippets/EnsembleOfSnapshots.rst @@ -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...]}`` diff --git a/doc/fr/advanced.rst b/doc/fr/advanced.rst index 4ccea05..767dfab 100644 --- a/doc/fr/advanced.rst +++ b/doc/fr/advanced.rst @@ -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 diff --git a/doc/fr/bibliography.rst b/doc/fr/bibliography.rst index 96f4cce..c5506d9 100644 --- a/doc/fr/bibliography.rst +++ b/doc/fr/bibliography.rst @@ -27,6 +27,12 @@ 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 diff --git a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst index d014321..9886fe0 100644 --- a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -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`. diff --git a/doc/fr/snippets/EnsembleOfSnapshots.rst b/doc/fr/snippets/EnsembleOfSnapshots.rst index de66dc4..94bec10 100644 --- a/doc/fr/snippets/EnsembleOfSnapshots.rst +++ b/doc/fr/snippets/EnsembleOfSnapshots.rst @@ -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...]}``