user_manual:sesamx:functions_description

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
user_manual:sesamx:functions_description [2023/01/28 10:05]
Ali Baba 		user_manual:sesamx:functions_description [2023/01/28 13:58]
Ali Baba
Line 8: Line 8:
 As a user you must be aware of the behavior regarding the SesamX functions: As a user you must be aware of the behavior regarding the SesamX functions:
   * a function can be **mandatory**: if it is not present in the input file, SesamX will return an error.   * a function can be **mandatory**: if it is not present in the input file, SesamX will return an error.
-  * depending on the function, even if this function is not mandatory (i.e. optional) and not explicitly used, **SesamX can automatically consider this function filled with default preset values**.+  * even if a function is not mandatory (i.e. optional) and not explicitly used, **SesamX can automatically consider this function filled with default preset values**.
   * **some functions cannot be used more than once in an input file**. These functions are qualified as **unique**.   * **some functions cannot be used more than once in an input file**. These functions are qualified as **unique**.
  
-For instance, the ''SET-UNITS'' function is unique, optional and carries default preset values. We cannot call it more than once. If we do not call it, SesamX will consider the function filled with default values.+And the same behaviors apply to branches.
  
-Branches showcase the same rules as functions. For instance the ''PARAMETERS'' branch under the ''SOLVE-LINEAR-STATIC'' function is unique, optional and carries default preset values. Which means that under a ''SOLVE-LINEAR-STATIC'' call, the ''PARAMETERS'' branch cannot be used more than once. And if not present under the function, SesamX will automatically add the branch with default data. Of course, if there is no ''SOLVE-LINEAR-STATIC'' call in the input file, the ''PARAMETERS'' branch will not be considered by SesamX.+For instance, the ''CVG-CRITERIA'' branch of the ''SOLVE-NON-LINEAR-STATIC'' function is unique, optional and carries default preset values. We cannot call it more than once under a ''SOLVE-NON-LINEAR-STATIC'' function. If we do not call it, SesamX will consider the branch filled with default values. Of course, if there is no ''SOLVE-NON-LINEAR-STATIC'' call in the input file, the ''CVG-CRITERIA'' branch will not be considered by SesamX.
  
 ===== Keywords behavior and attributes ===== ===== Keywords behavior and attributes =====
  • user_manual/sesamx/functions_description.txt
  • Last modified: 2023/01/28 13:58
  • by Ali Baba