Salome HOME
Code and documentation update for ControledFunctionTest
[modules/adao.git] / doc / fr / ref_operator_requirements.rst
index c1bcbdec197839377bedb1880cb59818e53648f2..cd93062cd332c863184767c5469bebf2a6bbf4ef 100644 (file)
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2020 EDF R&D
+   Copyright (C) 2008-2023 EDF R&D
 
    This file is part of SALOME ADAO module.
 
 
 .. _section_ref_operator_requirements:
 
-Exigences pour les fonctions décrivant un opérateur
----------------------------------------------------
+Conditions requises pour les fonctions décrivant un opérateur
+-------------------------------------------------------------
 
 .. index:: single: setObservationOperator
 .. index:: single: setEvolutionModel
 .. index:: single: setControlModel
 
-Les opérateurs d'observation et d'évolution sont nécessaires pour mettre en
-oeuvre les procédures d'assimilation de données ou d'optimisation. Ils
-comprennent la simulation physique par des calculs numériques, mais aussi le
-filtrage et de restriction pour comparer la simulation à l'observation.
-L'opérateur d'évolution est ici considéré dans sa forme incrémentale, qui
-représente la transition entre deux états successifs, et il est alors similaire
-à l'opérateur d'observation.
-
-Schématiquement, un opérateur :math:`O` a pour objet de restituer une solution
-pour des paramètres d'entrée spécifiés. Une partie des paramètres d'entrée peut
-être modifiée au cours de la procédure d'optimisation. Ainsi, la représentation
-mathématique d'un tel processus est une fonction. Il a été brièvement décrit
-dans la section :ref:`section_theory` et il est généralisé ici par la relation:
+La disponibilité des opérateurs d'observation et parfois d'évolution sont
+nécessaires pour mettre en oeuvre les procédures d'assimilation de données ou
+d'optimisation. Comme l'opérateur d'évolution est considéré dans sa forme
+incrémentale, qui représente la transition entre deux états successifs, il est
+alors formellement similaire à l'opérateur d'observation et la manière de les
+décrire est unique.
+
+Ces opérateurs comprennent la **simulation physique par des calculs
+numériques**. Mais ils comprennent aussi **le filtrage, la projection ou la
+restriction** des grandeurs simulées, qui sont nécessaires pour comparer la
+simulation à l'observation.
+
+Schématiquement, un opérateur :math:`O` a pour objet de restituer une
+simulation ou une solution pour des paramètres d'entrée spécifiés. Une partie
+des paramètres d'entrée peut être modifiée au cours de la procédure
+d'optimisation. Ainsi, la représentation mathématique d'un tel processus est
+une fonction. Il a été brièvement décrit dans la section :ref:`section_theory`.
+Il est généralisé ici par la relation:
 
 .. math:: \mathbf{y} = O( \mathbf{x} )
 
 entre les pseudo-observations en sortie :math:`\mathbf{y}` et les paramètres
-d'entrée :math:`\mathbf{x}` en utilisant l'opérateur d'observation ou
-d'évolution :math:`O`. La même représentation fonctionnelle peut être utilisée
+d'entrée :math:`\mathbf{x}` en utilisant l'opérateur :math:`O` d'observation ou
+d'évolution. La même représentation fonctionnelle peut être utilisée
 pour le modèle linéaire tangent :math:`\mathbf{O}` de :math:`O` et son adjoint
 :math:`\mathbf{O}^*` qui sont aussi requis par certains algorithmes
 d'assimilation de données ou d'optimisation.
@@ -62,13 +67,13 @@ Ainsi, **pour décrire de manière complète un opérateur, l'utilisateur n'a qu
 fournir une fonction qui réalise complètement et uniquement l'opération
 fonctionnelle**.
 
-Cette fonction est généralement donnée comme une fonction ou un script Python,
-qui peuvent en particulier être exécuté comme une fonction Python indépendante
-ou dans un noeud YACS. Cette fonction ou ce script peuvent, sans différences,
-lancer des codes externes ou utiliser des appels et des méthodes internes
-Python ou SALOME. Si l'algorithme nécessite les 3 aspects de l'opérateur (forme
-directe, forme tangente et forme adjointe), l'utilisateur doit donner les 3
-fonctions ou les approximer grâce à ADAO.
+Cette fonction est généralement donnée comme une **fonction ou un script
+Python**, qui peuvent en particulier être exécuté comme une fonction Python
+indépendante ou dans un noeud YACS. Cette fonction ou ce script peuvent, sans
+différences, lancer des codes externes ou utiliser des appels et des méthodes
+internes Python ou SALOME. Si l'algorithme nécessite les 3 aspects de
+l'opérateur (forme directe, forme tangente et forme adjointe), l'utilisateur
+doit donner les 3 fonctions ou les approximer grâce à ADAO.
 
 Il existe pour l'utilisateur 3 méthodes effectives de fournir une représentation
 fonctionnelle de l'opérateur, qui diffèrent selon le type d'argument choisi:
@@ -81,7 +86,7 @@ Dans le cas de l'interface textuelle d'ADAO (TUI), seules les deux premières
 sont nécessaires car la troisième est incluse dans la seconde. Dans le cas de
 l'interface graphique EFICAS d'ADAO, ces méthodes sont choisies dans le champ
 "*FROM*" de chaque opérateur ayant une valeur "*Function*" comme
-"*INPUT_TYPE*", comme le montre la figure suivante:
+"*INPUT_TYPE*", comme le montre la figure suivante :
 
   .. eficas_operator_function:
   .. image:: images/eficas_operator_function.png
@@ -90,6 +95,17 @@ l'interface graphique EFICAS d'ADAO, ces méthodes sont choisies dans le champ
   .. centered::
     **Choisir graphiquement une représentation fonctionnelle de l'opérateur**
 
+En interface textuelle d'ADAO (TUI), dans le cas précis illustré ci-dessus, on
+réalise la même démarche en écrivant :
+::
+
+    ...
+    case.set( 'ObservationOperator',
+        OneFunction = True,
+        Script = 'scripts_for_JDC.py'
+        )
+    ...
+
 .. _section_ref_operator_one:
 
 Première forme fonctionnelle : un seul opérateur direct
@@ -104,8 +120,8 @@ Première forme fonctionnelle : un seul opérateur direct
 La première consiste à ne fournir qu'une seule fonction, potentiellement non
 linéaire, et à approximer les opérateurs tangent et adjoint associés.
 
-Ceci est fait dans ADAO en utilisant dans l'interface graphique EFICAS le
-mot-clé "*ScriptWithOneFunction*" pour la description par un script. Dans
+Ceci est fait dans ADAO en utilisant, dans l'interface graphique EFICAS d'ADAO,
+le mot-clé "*ScriptWithOneFunction*" pour la description par un script. Dans
 l'interface textuelle, c'est le mot-clé "*OneFunction*", éventuellement combiné
 avec le mot-clé "*Script*" selon que c'est une fonction ou un script. Si c'est
 par script externe, l'utilisateur doit fournir un fichier contenant une
@@ -117,34 +133,43 @@ script externe peut suivre le modèle générique suivant::
         ...
         ...
         ...
-        return Y=O(X)
+        # Résultat : Y = O(X)
+        return "un vecteur similaire à Y"
 
 Dans ce cas, l'utilisateur doit aussi fournir une valeur pour l'incrément
-différentiel (ou conserver la valeur par défaut), en utilisant dans l'interface
-graphique (GUI) ou textuelle (TUI) le mot-clé "*DifferentialIncrement*" comme
-paramètre, qui a une valeur par défaut de 1%. Ce coefficient est utilisé dans
-l'approximation différences finies pour construire les opérateurs tangent et
-adjoint. L'ordre de l'approximation différences finies peut aussi être choisi à
-travers l'interface, en utilisant le mot-clé "*CenteredFiniteDifference*", avec
-0 pour un schéma non centré du premier ordre (qui est la valeur par défaut), et
-avec 1 pour un schéma centré du second ordre (et qui coûte numériquement deux
-fois plus cher que le premier ordre). Si nécessaire et si possible, on peut
+différentiel ou conserver la valeur par défaut. Cela se réalise en utilisant
+dans l'interface graphique (GUI) ou textuelle (TUI) le mot-clé
+"*DifferentialIncrement*" comme paramètre, qui a une valeur par défaut de 1%.
+Ce coefficient est utilisé dans l'approximation différences finies pour
+construire les opérateurs tangent et adjoint. L'ordre de l'approximation
+différences finies peut aussi être choisi à travers l'interface, en utilisant
+le mot-clé "*CenteredFiniteDifference*", avec ``False`` ou 0 pour un schéma non
+centré du premier ordre (qui est la valeur par défaut), et avec ``True`` ou 1
+pour un schéma centré du second ordre (et qui coûte numériquement deux fois
+plus cher que le premier ordre). Si nécessaire et si possible, on peut
 :ref:`subsection_ref_parallel_df`. Dans tous les cas, un mécanisme de cache
 interne permet de limiter le nombre d'évaluations de l'opérateur au minimum
 possible du point de vue de l'exécution séquentielle ou parallèle des
 approximations numériques des opérateurs tangent et adjoint, pour éviter des
-calculs redondants.
+calculs redondants. On se reportera à la partie permettant de
+:ref:`subsection_iterative_convergence_control` pour connaître l'interaction
+avec les paramètres relatifs à la convergence.
 
 Cette première forme de définition de l'opérateur permet aisément de tester la
 forme fonctionnelle avant son usage dans un cas ADAO, réduisant notablement la
 complexité de l'implémentation de l'opérateur. On peut ainsi utiliser
 l'algorithme ADAO de vérification "*FunctionTest*" (voir la section sur
-l':ref:`section_ref_algorithm_FunctionTest`) pour ce test.
+l':ref:`section_ref_algorithm_FunctionTest`) spécifiquement prévu pour ce test.
 
-**Avertissement important :** le nom "*DirectOperator*" est obligatoire, et le
-type de l'argument ``X`` peut être une liste de valeur réelles, un vecteur
-Numpy ou une matrice Numpy. La fonction utilisateur doit accepter et traiter
-tous ces cas.
+**Important :** le nom "*DirectOperator*" est obligatoire lorsque l'on utilise
+un script Python indépendant. Le type de l'argument ``X`` en entrée peut être
+une liste de valeurs réelles, un vecteur Numpy ou une matrice Numpy, et la
+fonction utilisateur doit accepter et traiter tous ces cas. Le type de
+l'argument ``Y`` en sortie doit aussi être équivalent à une liste de valeurs
+réelles.
+
+Des formes variées d'opérateurs sont disponibles dans les divers scripts inclus
+dans les :ref:`section_docu_examples`.
 
 .. _section_ref_operator_funcs:
 
@@ -159,7 +184,7 @@ Seconde forme fonctionnelle : trois opérateurs direct, tangent et adjoint
 
 .. warning::
 
-  en général, il est recommandé d'utiliser la première forme fonctionnelle
+  En général, il est recommandé d'utiliser la première forme fonctionnelle
   plutôt que la seconde. Un petit accroissement de performances n'est pas une
   bonne raison pour utiliser l'implémentation détaillée de cette seconde forme
   fonctionnelle.
@@ -179,7 +204,7 @@ suivre le squelette suivant::
         ...
         ...
         ...
-        return quelque chose comme Y
+        return "un vecteur similaire à Y"
 
     def TangentOperator( paire = (X, dX) ):
         """ Opérateur linéaire tangent, autour de X, appliqué à dX """
@@ -187,7 +212,7 @@ suivre le squelette suivant::
         ...
         ...
         ...
-        return quelque chose comme Y
+        return "un vecteur similaire à Y"
 
     def AdjointOperator( paire = (X, Y) ):
         """ Opérateur adjoint, autour de X, appliqué à Y """
@@ -195,21 +220,46 @@ suivre le squelette suivant::
         ...
         ...
         ...
-        return quelque chose comme X
+        return "un vecteur similaire à X"
 
 Un nouvelle fois, cette seconde définition d'opérateur permet aisément de tester
 les formes fonctionnelles avant de les utiliser dans le cas ADAO, réduisant la
 complexité de l'implémentation de l'opérateur.
 
-Pour certains algorithmes, il faut que les fonctions tangente et adjointe
-puisse renvoyer les matrices équivalentes à l'opérateur linéaire. Dans ce cas,
-lorsque, respectivement, les arguments ``dX`` ou ``Y`` valent ``None``, le
-script de l'utilisateur doit renvoyer la matrice associée.
+Pour certains algorithmes (en particulier les filtres non ensemblistes), il
+faut que les fonctions tangente et adjointe puisse renvoyer les matrices
+équivalentes à l'opérateur linéaire. Dans ce cas, lorsque, respectivement, les
+arguments ``dX`` ou ``Y`` valent ``None``, le script de l'utilisateur doit
+renvoyer la matrice associée. Les squelettes des fonctions "*TangentOperator*"
+et "*AdjointOperator*" deviennent alors les suivants::
+
+    def TangentOperator( paire = (X, dX) ):
+        """ Opérateur linéaire tangent, autour de X, appliqué à dX """
+        X, dX = paire
+        ...
+        ...
+        ...
+        if dX is None or len(dX) == 0:
+            return "la matrice de l'opérateur linéaire tangent"
+        else:
+            return "un vecteur similaire à Y"
+
+    def AdjointOperator( paire = (X, Y) ):
+        """ Opérateur adjoint, autour de X, appliqué à Y """
+        X, Y = paire
+        ...
+        ...
+        ...
+        if Y is None or len(Y) == 0:
+            return "la matrice de l'opérateur linéaire adjoint"
+        else:
+            return "un vecteur similaire à X"
 
-**Avertissement important :** les noms "*DirectOperator*", "*TangentOperator*"
-et "*AdjointOperator*" sont obligatoires, et le type des arguments ``X``,
-``Y``, ``dX`` peut être une liste de valeur réelles, un vecteur Numpy ou une
-matrice Numpy. La fonction utilisateur doit accepter et traiter tous ces cas.
+**Important :** les noms "*DirectOperator*", "*TangentOperator*" et
+"*AdjointOperator*" sont obligatoires lorsque l'on utilise un script Python
+indépendant. Le type des arguments en entrée ou en sortie ``X``, ``Y``, ``dX``
+peut être une liste de valeur réelles, un vecteur Numpy ou une matrice Numpy.
+La fonction utilisateur doit accepter et traiter tous ces cas.
 
 .. _section_ref_operator_switch:
 
@@ -223,7 +273,7 @@ Troisième forme fonctionnelle : trois opérateurs avec un branchement
 
 .. warning::
 
-  il est recommandé de ne pas utiliser cette troisième forme fonctionnelle sans
+  Il est recommandé de ne pas utiliser cette troisième forme fonctionnelle sans
   une solide raison numérique ou physique. Un accroissement de performances
   n'est pas une bonne raison pour utiliser la complexité de cette troisième
   forme fonctionnelle. Seule une impossibilité à utiliser les première ou
@@ -247,7 +297,8 @@ se baser sur le modèle suivant pour le script d'aiguillage. Il nécessite un
 fichier script ou un code externe nommé ici
 "*Physical_simulation_functions.py*", contenant trois fonctions nommées
 "*DirectOperator*", "*TangentOperator*" et "*AdjointOperator*" comme
-précédemment. Voici le squelette d'aiguillage::
+précédemment. Voici le squelette d'aiguillage:
+::
 
     import Physical_simulation_functions
     import numpy, logging, codecs, pickle
@@ -307,14 +358,15 @@ Cas spécial d'un opérateur d'évolution avec contrôle
 Dans certains cas, l'opérateur d'évolution ou d'observation doit être contrôlé
 par un contrôle d'entrée externe, qui est donné *a priori*. Dans ce cas, la
 forme générique du modèle incrémental :math:`O` est légèrement modifiée comme
-suit:
+suit :
 
 .. math:: \mathbf{y} = O( \mathbf{x}, \mathbf{u})
 
 où :math:`\mathbf{u}` est le contrôle sur l'incrément d'état. En effet,
 l'opérateur direct doit être appliqué à une paire de variables :math:`(X,U)`.
 Schématiquement, l'opérateur :math:`O` doit être construit comme une fonction
-applicable sur une paire:math:`\mathbf{(X, U)}` suit::
+applicable sur une paire :math:`\mathbf{(X, U)}` comme suit :
+::
 
     def DirectOperator( paire = (X, U) ):
         """ Opérateur direct de simulation non-linéaire """
@@ -353,14 +405,14 @@ manière simple de faire cela en entrée consiste à transformer les paramètres
 utilise le plus souvent comme référence les valeurs par défaut
 :math:`\mathbf{x}^b` (ébauche, ou valeur nominale). Pourvu que chaque
 composante de :math:`\mathbf{x}^b` soit non nulle, on peut ensuite procéder par
-correction multiplicative. Pour cela, on peut par exemple poser:
+correction multiplicative. Pour cela, on peut par exemple poser :
 
 .. math:: \mathbf{x} = \mathbf{\alpha}\mathbf{x}^b
 
 et optimiser ensuite le paramètre multiplicatif :math:`\mathbf{\alpha}`. Ce
 paramètre a pour valeur par défaut (ou pour ébauche) un vecteur de 1. De
 manière similaire, on peut procéder par correction additive si c'est plus
-judicieux pour la physique sous-jacente. Ainsi, dans ce cas, on peut poser:
+judicieux pour la physique sous-jacente. Ainsi, dans ce cas, on peut poser :
 
 .. math:: \mathbf{x} =\mathbf{x}^b + \mathbf{\alpha}
 
@@ -375,25 +427,28 @@ Une telle démarche suffit rarement à éviter tous les problèmes numériques,
 permet souvent d'améliorer beaucoup le conditionnement numérique de
 l'optimisation.
 
+.. index:: single: InputFunctionAsMulti
+
 Gestion explicite de fonctions "multiples"
 ++++++++++++++++++++++++++++++++++++++++++
 
 .. warning::
 
-  il est fortement recommandé de ne pas utiliser cette gestion explicite de
+  Il est fortement recommandé de ne pas utiliser cette gestion explicite de
   fonctions "multiples" sans une très solide raison informatique pour le faire.
   Cette gestion est déjà effectuée par défaut dans ADAO pour l'amélioration des
   performances. Seul l'utilisateur très averti, cherchant à gérer des cas
   particulièrement difficiles, peut s'intéresser à cette extension. En dépit de
   sa simplicité, c'est au risque explicite de dégrader notablement les
-  performances.
+  performances, ou d'avoir des erreurs d'exécution étranges.
 
 Il est possible, lorsque l'on fournit des fonctions d'opérateurs, de les
 définir comme des fonctions qui traitent non pas un seul argument, mais une
 série d'arguments, pour restituer en sortie la série des valeurs
 correspondantes. En pseudo-code, la fonction "multiple", ici nommée
 ``MultiFunctionO``, représentant l'opérateur classique :math:`O` nommé
-"*DirectOperator*", effectue::
+"*DirectOperator*", effectue :
+::
 
     def MultiFunctionO( Inputs ):
         """ Multiple ! """
@@ -407,8 +462,18 @@ La longueur de la sortie (c'est-à-dire le nombre de valeurs calculées) est
 égale à la longueur de l'entrée (c'est-à-dire le nombre d'états dont on veut
 calculer la valeur par l'opérateur).
 
-Cette possibilité n'est disponible que dans l'interface textuelle d'ADAO. Pour
-cela, lors de la définition d'une fonction d'opérateur, en même temps que l'on
-définit de manière habituelle la fonction ou le script externe, il suffit
-d'indiquer en plus en argument par un booléen "*InputFunctionAsMulti*" que la
-définition est celle d'une fonction "multiple".
+Cette possibilité n'est disponible que dans l'interface textuelle TUI d'ADAO.
+Pour cela, lors de la définition d'une fonction d'opérateur, en même temps que
+l'on définit de manière habituelle la fonction ou le script externe, il suffit
+d'indiquer en plus en argument par un booléen supplémentaire
+"*InputFunctionAsMulti*" que la définition est celle d'une fonction "multiple".
+Par exemple, si c'est l'opérateur d'observation que l'on définit de cette
+manière, il faut écrire (sachant que toutes les autres commandes optionnelles
+restent inchangées) :
+::
+
+    case.set( 'ObservationOperator',
+        OneFunction          = MultiFunctionO,
+        ...
+        InputFunctionAsMulti = True,
+        )