..
- Copyright (C) 2008-2015 EDF R&D
+ Copyright (C) 2008-2021 EDF R&D
This file is part of SALOME ADAO module.
.. _section_ref_entry_types:
-Liste des types d'entrées possibles
------------------------------------
+Liste des types d'entrées possibles pour les variables utilisateurs
+-------------------------------------------------------------------
-Chaque variable ADAO présente un pseudo-type qui aide à la remplir et à la
-valider. Les différents pseudo-types sont:
+Chaque variable à renseigner pour l'utilisation d'ADAO peut être représentée à
+l'aide de "pseudo-types" particuliers, qui aident à la remplir logiquement et à
+la valider informatiquement. Ces pseudo-types représentent explicitement des
+formes mathématiques (:ref:`section_ref_entry_types_math`) ou informatiques
+simples (:ref:`section_ref_entry_types_info`), que l'on détaille ici. On
+utilise aussi les :ref:`section_notations`, en même temps que les
+:ref:`section_ref_entry_types_names`.
-.. index:: single: Dict
+Le test explicite :ref:`section_ref_algorithm_InputValuesTest` est prévu pour
+que l'utilisateur puisse vérifier spécifiquement certaines entrées, avec les
+mêmes analyses et critères que lors de la mise en place usuelle d'une étude.
-**Dict**
- Cela indique une variable qui doit être remplie avec un dictionnaire Python
- ``{"clé":"valeur"...}``, usuellement donné soit par une chaîne de caractères
- soit par un fichier script.
+.. _section_ref_entry_types_math:
-.. index:: single: Function
+Pseudo-types de représentation mathématique des données
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-**Function**
- Cela indique une variable qui doit être donnée comme une fonction Python,
- usuellement donnée soit par une chaîne de caractères soit par un fichier
- script.
+Les entrées sont décrites selon une logique la plus simple possible, de
+représentation mathématique, pour des algorithmes ou outils de calculs.
-.. index:: single: Matrix
+.. include:: snippets/EntryTypeVector.rst
-**Matrix**
- Cela indique une variable qui doit être donnée comme une matrice,
- usuellement donnée soit par une chaîne de caractères soit par un fichier
- script.
+.. include:: snippets/EntryTypeVectorSerie.rst
-.. index:: single: ScalarSparseMatrix
+.. include:: snippets/EntryTypeMatrix.rst
-**ScalarSparseMatrix**
- Cela indique une variable qui doit être donnée comme un nombre unique (qui
- sera utilisé pour multiplier une matrice identité), usuellement donné soit
- par une chaîne de caractères soit par un fichier script.
+.. include:: snippets/EntryTypeFunction.rst
-.. index:: single: DiagonalSparseMatrix
+.. include:: snippets/EntryTypeDict.rst
-**DiagonalSparseMatrix**
- Cela indique une variable qui doit , (qui sera
- utilisé pour remplacer la diagonale d'une matrice identité), usuellement
- donné soit par une chaîne de caractères soit par un fichier script.
+Les variables auxquelles ces pseudo-types s'appliquent peuvent elles-mêmes être
+données à l'aide des descriptions informatiques qui suivent.
-.. index:: single: Script
+.. _section_ref_entry_types_info:
-**Script**
- Cela indique un script donné comme un fichier externe. Il peut être désigné
- par un nom de fichier avec chemin complet ou seulement par un nom de fichier
- sans le chemin. Si le fichier est donné uniquement par un nom sans chemin,
- et si un répertoire d'étude est aussi indiqué, le fichier est recherché dans
- le répertoire d'étude donné.
+Pseudo-types de description informatique des données
+++++++++++++++++++++++++++++++++++++++++++++++++++++
-.. index:: single: String
+Trois pseudo-types, purement informatiques, permettent de désigner la manière
+dont on fournit les variables en entrée.
-**String**
- Cela indique une chaîne de caractères fournissant une représentation
- littérale d'une matrice, d'un vecteur ou d'une collection de vecteurs, comme
- par exemple "1 2 ; 3 4" ou "[[1,2],[3,4]]" pour une matrice carrée de taille
- 2x2.
+.. include:: snippets/EntryTypeScript.rst
-.. index:: single: Vector
+.. include:: snippets/EntryTypeString.rst
-**Vector**
- Cela indique une variable qui doit être remplie comme un vecteur,
- usuellement donné soit par une chaîne de caractères soit par un fichier
- script.
+.. include:: snippets/EntryTypeDataFile.rst
-.. index:: single: VectorSerie
+.. _section_ref_entry_types_names:
-**VectorSerie**
- Cela indique une variable qui doit être remplie comme une liste de vecteurs,
- usuellement donnée soit par une chaîne de caractères soit par un fichier
- script.
+Informations sur les noms imposés pour les entrées par fichier
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-Lorsqu'une commande ou un mot-clé peut être rempli par un nom de fichier script,
-ce script doit présenter une variable ou une méthode que porte le même nom que
-la variable à remplir. En d'autres mots, lorsque l'on importe le script dans un
-noeud Python de YACS, il doit créer une variable du bon nom dans l'espace de
-nommage courant du noeud.
+Lorsqu'une commande ou un mot-clé peuvent être renseignés à l'aide d'un fichier
+script désigné par le pseudo-type "*Script*", ce script doit présenter une
+variable ou une méthode qui porte le même nom que la variable à remplir. En
+d'autres termes, lorsque l'on importe un tel script dans une commande Python ou
+un noeud Python de YACS, il doit créer une variable du bon nom dans l'espace de
+nommage courant du noeud. Par exemple, un script Python rendant disponible la
+variable d'ébauche, nommée "*Background*", doit présenter la forme suivante ::
+
+ ...
+ ...
+ Background =...
+ ...
+ ...
+
+Son importation permet ainsi de créer la variable "*Background*" dans l'espace
+de nommage courant. Les points "..." symbolisent du code quelconque autour de
+ce début particulier de ligne.
+
+De la même manière, lorsqu'un vecteur particulier peut être renseigné à l'aide
+d'un fichier de données désigné par le pseudo-type "*DataFile*", les
+informations présentes dans le fichier "*DataFile*" doivent porter le nom du
+vecteur à charger.
