..
- Copyright (C) 2008-2019 EDF R&D
+ Copyright (C) 2008-2023 EDF R&D
This file is part of SALOME ADAO module.
List of possible input types
----------------------------
-Each ADAO variable has a pseudo-type to help filling it and validation. These
-pseudo-types explicitly represent some simple computing or mathematical types.
-Two pseudo-types, purely computing ones, allows to designate how the input
-variables are provided:
+Each variable to be entered for the use of ADAO can be represented by means of
+particular "pseudo-types", which help to logically fill it in and validate it
+computationally. These pseudo-types explicitly represent mathematical forms
+(:ref:`section_ref_entry_types_math`) or simple computer forms
+(:ref:`section_ref_entry_types_info`), which are detailed here.
+:ref:`section_notations` are also used, together with
+:ref:`section_ref_entry_types_names`.
-.. index:: single: Script
+The explicit :ref:`section_ref_algorithm_InputValuesTest` test is designed so
+that the user can specifically check some entries, with the same analysis and
+criteria as during the usual setup of a study.
-**Script**
- This indicates a script given as an external file. It can be described by a
- full absolute path name or only by the file name without path. If the file
- is given only by a file name without path, and if a study directory is also
- indicated, the file is searched in the given study directory.
+.. _section_ref_entry_types_math:
-.. index:: single: String
+Pseudo-types of mathematical representation of data
++++++++++++++++++++++++++++++++++++++++++++++++++++
-**String**
- This indicates a string giving a literal representation of a matrix, a
- vector or a vector series, such as "1 2 ; 3 4" or "[[1,2],[3,4]]" for a
- square 2x2 matrix.
+The inputs are described according to the simplest possible logic, in
+mathematical representation, for algorithms or calculation tools.
-The various other pseudo-types are as follows. The variables they apply
-themselves may be either a data string (a "*String*"), or a script file (a
-"*Script*"):
+.. include:: snippets/EntryTypeVector.rst
-.. index:: single: Dict
+.. include:: snippets/EntryTypeVectorSerie.rst
-**Dict**
- This indicates a variable that has to be filled by a Python dictionary
- ``{"key":"value...}``.
+.. include:: snippets/EntryTypeMatrix.rst
-.. index:: single: Function
+.. include:: snippets/EntryTypeFunction.rst
-**Function**
- This indicates a variable that has to be filled by a Python function. The
- functions are special entries described by the
- :ref:`section_ref_operator_requirements`.
+.. include:: snippets/EntryTypeDict.rst
-.. index:: single: Matrix
+The variables to which these pseudo-types apply can themselves be given using
+the following computer descriptions.
-**Matrix**
- This indicates a variable that has to be filled by a matrix.
+.. _section_ref_entry_types_info:
-.. index:: single: ScalarSparseMatrix
+Pseudo-types of digital data description
+++++++++++++++++++++++++++++++++++++++++
-**ScalarSparseMatrix**
- This indicates a variable that has to be filled by a unique number (which
- will be used to multiply an identity matrix).
+Three pseudo-types, purely computer-based, are used to specify the way in which
+input variables are provided.
-.. index:: single: DiagonalSparseMatrix
+.. include:: snippets/EntryTypeScript.rst
-**DiagonalSparseMatrix**
- This indicates a variable that has to be filled by a vector (which will be
- used as the diagonal of a square matrix).
+.. include:: snippets/EntryTypeString.rst
-.. index:: single: Vector
+.. include:: snippets/EntryTypeDataFile.rst
-**Vector**
- This indicates a variable that has to be filled by a vector.
+.. _section_ref_entry_types_names:
-.. index:: single: VectorSerie
+Information on the names required for file entries
+++++++++++++++++++++++++++++++++++++++++++++++++++
-**VectorSerie**
- This indicates a variable that has to be filled by a list of vectors.
-
-When a command or keyword can be filled by a script file name, specified by the
-pseudo-type "*Script*", the script has to contain a variable or a method that
-has the same name as the one to be filled. In other words, when importing the
-script in a YACS Python node, it must create a variable of the good name in the
-current name space of the node. For example, a Python script making available
-the background variable, named "*Background*", must have the following form::
+When a command or keyword can be entered using a script file identified by the
+pseudo-type "*Script*", this script must contain a variable or method that has
+the same name than the variable to be completed. In other words, when importing
+such a script into a Python command or Python node, it must create a variable
+of the correct name in the current namespace of the node. For example, a Python
+script making available the draft variable, named "*Background*", must have the
+following form::
+ ...
...
Background =...
...
+ ...
+
+Its import thus makes it possible to create the variable "*Background*" in the
+current namespace. The dots"..." symbolize any code around this particular line
+beginning.
-Its import allows the creation of the variable "*Background*". The dots "..."
-symbolize any code around this particular beginning of the line.
+Similarly, when a particular vector can be filled in using a data file
+designated by the pseudo-type "*DataFile*", the information in the file
+"*DataFile*" must be named after the vector to be loaded.
