This module provides utility functions for the computation codes intended for use in parametric studies. The computation codes must be implemented as a Python script or function to use these functions. If the computation code is implemented as a SALOME component, use module salome.kernel.parametric.compo_utils instead.
| def pyscript_utils.create_input_dict |
( |
|
deterministic_dict, |
|
|
|
parametric_input |
|
) |
| |
This function returns a dictionary containing the input values to be used in the computation code.
- Parameters
-
| deterministic_dict | (dict) dictionary containing the fixed values (i.e. non-parametric). This dictionary can be empty if all variables are parametric. |
| parametric_input | (dict) dictionary containing the description and values of the parametric variables. |
- Returns
- a dictionary containing the input values for the computation code.
| def pyscript_utils.create_normal_parametric_output |
( |
|
output_dict, |
|
|
|
parametric_input |
|
) |
| |
This function returns a dictionary describing the output of the computation code in parametric studies.
- Parameters
-
| output_dict | (dict) dictionary containing the output values of the computation code (the keys are the variable names, the values are the variable values). |
| parametric_input | (dict) dictionary containing the description and values of the parametric variables. |
- Returns
- a dictionary containing the representation of the output of the computation code.
| def pyscript_utils.create_error_parametric_output |
( |
|
error_message | ) |
|
This function returns a dictionary describing the output of the computation code in parametric studies in case of error.
- Parameters
-
| error_message | (string) the error message. |
- Returns
- a dictionary describing the error.
