salome.kernel 9.14.0.post6__cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

salome/kernel/salome/kernel/parametric/__init__.py

@@ -0,0 +1,26 @@
+# Copyright (C) 2011-2024  CEA, EDF, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+## \defgroup salome_kernel_parametric salome.kernel.parametric
+#  \{ 
+#  \details Package for parametric studies
+#  \defgroup study_exchange_vars
+#  \defgroup compo_utils
+#  \defgroup pyscript_utils
+#  \}

salome/kernel/salome/kernel/parametric/compo_utils.py

@@ -0,0 +1,137 @@
+# Copyright (C) 2011-2024  CEA, EDF, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+## \defgroup compo_utils compo_utils
+#  \{ 
+#  \details
+#  This module provides utility functions for the computation codes intended for
+#  use in parametric studies. The computation codes must be implemented as %SALOME
+#  components to use these functions. If the computation code is implemented as a
+#  Python script or function, use module 
+#  <a href="group__compo__utils.html">salome.kernel.parametric.compo_utils</a> instead.  
+#  \}
+
+"""
+This module provides utility functions for the computation codes intended for
+use in parametric studies. The computation codes must be implemented as SALOME
+components to use these functions. If the computation code is implemented as a
+Python script or function, use module
+:mod:`salome.kernel.parametric.pyscript_utils` instead. 
+"""
+
+from . import SALOME_TYPES
+
+## This function returns a dictionary containing the input values to be used
+#  in the computation code.
+#
+#  \param deterministic_dict (dict) dictionary containing the fixed values (i.e.
+#  non-parametric). This dictionary can be empty if all variables are parametric.
+#
+#  \param parametric_input (SALOME_TYPES/ParametricInput) structure containing 
+#  the description and values of the parametric variables.
+#
+#  \return a dictionary containing the input values for the computation code.
+#  \ingroup compo_utils
+def create_input_dict(deterministic_dict, parametric_input):
+    """
+    This function returns a dictionary containing the input values to be used
+    in the computation code.
+    
+    :type  deterministic_dict: dict
+    :param deterministic_dict: dictionary containing the fixed values (i.e.
+                               non-parametric). This dictionary can be empty
+                               if all variables are parametric.
+
+    :type  parametric_input: SALOME_TYPES/ParametricInput
+    :param parametric_input: structure containing the description and values
+                             of the parametric variables.
+
+    :return: a dictionary containing the input values for the computation code.
+    """
+    # Simply get the first point from input (no time series, single observation)
+    input_point = parametric_input.inputValues[0][0]
+
+    if len(input_point) != len(parametric_input.inputVarList):
+        raise Exception("Size mismatch between inputVarList and point to evaluate")
+
+    input_dict = deterministic_dict.copy()
+    for i in range(len(input_point)):
+        input_dict[parametric_input.inputVarList[i]] = input_point[i][0]
+
+    return input_dict
+
+## This function returns a structure describing the output of the computation
+#  code in parametric studies.
+#
+#  \param output_dict (dict) dictionary containing the output values of the
+#  computation code (the keys are the variable names, the values are the variable values).
+#
+#  \param parametric_input (SALOME_TYPES/ParametricInput) structure containing 
+#  the description and values of the parametric variables.
+#
+#  \return a structure of type SALOME_TYPES/ParametricOutput containing the
+#  output of the computation code.
+#  \ingroup compo_utils
+def create_normal_parametric_output(output_dict, parametric_input):
+    """
+    This function returns a structure describing the output of the computation
+    code in parametric studies.
+    
+    :type  output_dict: dict
+    :param output_dict: dictionary containing the output values of the
+                        computation code (the keys are the variable names, the
+                        values are the variable values).
+
+    :type  parametric_input: SALOME_TYPES/ParametricInput
+    :param parametric_input: structure containing the description and values
+                             of the parametric variables.
+
+    :return: a structure of type SALOME_TYPES/ParametricOutput containing the
+             output of the computation code.
+    """
+    output_values = [[[]]]
+    for output_var in parametric_input.outputVarList:
+        output_values[0][0].append([output_dict[output_var]])
+    return SALOME_TYPES.ParametricOutput(outputValues = output_values,
+                                         specificOutputInfos = [],
+                                         returnCode = 0,
+                                         errorMessage = "")
+
+## This function returns a structure describing the output of the computation
+#  code in parametric studies in case of error.
+#
+#  \param error_message (string) the error message.
+#
+#  \return a structure of type SALOME_TYPES/ParametricOutput describing the error.
+#  \ingroup compo_utils
+def create_error_parametric_output(error_message):
+    """
+    This function returns a structure describing the output of the computation
+    code in parametric studies in case of error.
+    
+    :type  error_message: string
+    :param error_message: the error message.
+
+    :return: a structure of type SALOME_TYPES/ParametricOutput describing the
+             error.
+    """
+    return SALOME_TYPES.ParametricOutput(outputValues = [],
+                                         specificOutputInfos = [],
+                                         returnCode = 1,
+                                         errorMessage = error_message)

salome/kernel/salome/kernel/parametric/pyscript_utils.py

@@ -0,0 +1,135 @@
+# Copyright (C) 2011-2024  CEA, EDF, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+## \defgroup pyscript_utils pyscript_utils
+#  \{ 
+#  \details
+#  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 
+#  <a href="group__compo__utils.html">salome.kernel.parametric.compo_utils</a> instead. 
+#  \}
+
+"""
+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
+:mod:`salome.kernel.parametric.compo_utils` instead. 
+"""
+
+## This function returns a dictionary containing the input values to be used
+#  in the computation code.
+#
+#  \param deterministic_dict (dict) dictionary containing the fixed values (i.e.
+#  non-parametric). This dictionary can be empty if all variables are parametric.
+#
+#  \param parametric_input (dict) dictionary containing the description and values
+#  of the parametric variables.
+#
+#  \return a dictionary containing the input values for the computation code.
+#  \ingroup pyscript_utils
+def create_input_dict(deterministic_dict, parametric_input):
+    """
+    This function returns a dictionary containing the input values to be used
+    in the computation code.
+    
+    :type  deterministic_dict: dict
+    :param deterministic_dict: dictionary containing the fixed values (i.e.
+                               non-parametric). This dictionary can be empty
+                               if all variables are parametric.
+
+    :type  parametric_input: dict
+    :param parametric_input: dictionary containing the description and values
+                             of the parametric variables.
+
+    :return: a dictionary containing the input values for the computation code.
+    """
+    # Simply get the first point from input (no time series, single observation)
+    input_point = parametric_input["inputValues"][0][0]
+
+    if len(input_point) != len(parametric_input["inputVarList"]):
+        raise Exception("Size mismatch between inputVarList and point to evaluate")
+
+    input_dict = deterministic_dict.copy()
+    for i in range(len(input_point)):
+        input_dict[parametric_input["inputVarList"][i]] = input_point[i][0]
+
+    return input_dict
+
+## This function returns a dictionary describing the output of the
+#  computation code in parametric studies.
+#
+#  \param output_dict (dict) dictionary containing the output values of the
+#  computation code (the keys are the variable names, the
+#  values are the variable values).
+#
+#  \param parametric_input (dict) dictionary containing the description and values
+#  of the parametric variables.
+#
+#  \return a dictionary containing the representation of the output of the
+#  computation code.
+#  \ingroup pyscript_utils
+def create_normal_parametric_output(output_dict, parametric_input):
+    """
+    This function returns a dictionary describing the output of the
+    computation code in parametric studies.
+    
+    :type  output_dict: dict
+    :param output_dict: dictionary containing the output values of the
+                        computation code (the keys are the variable names, the
+                        values are the variable values).
+
+    :type  parametric_input: dict
+    :param parametric_input: dictionary containing the description and values
+                             of the parametric variables.
+
+    :return: a dictionary containing the representation of the output of the
+             computation code.
+    """
+    output_values = [[[]]]
+    for output_var in parametric_input["outputVarList"]:
+        output_values[0][0].append([output_dict[output_var]])
+    return {"outputValues" : output_values,
+            "specificOutputInfos" : [],
+            "returnCode" : 0,
+            "errorMessage" : ""}
+
+## This function returns a dictionary describing the output of the
+#  computation code in parametric studies in case of error.
+#
+#  \param error_message (string) the error message.
+#
+#  \return a dictionary describing the error.
+#  \ingroup pyscript_utils
+def 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.
+    
+    :type  error_message: string
+    :param error_message: the error message.
+
+    :return: a dictionary describing the error.
+    """
+    return {"outputValues" : [],
+            "specificOutputInfos" : [],
+            "returnCode" : 1,
+            "errorMessage" : error_message}

salome/kernel/salome/kernel/parametric/study_exchange_vars.py

@@ -0,0 +1,285 @@
+# Copyright (C) 2011-2024  CEA, EDF, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+## \defgroup study_exchange_vars study_exchange_vars
+#  \{ 
+#  \details
+#  This module provides classes and functions to handle "Exchange Variables",
+#  i.e. description of variables to be exchanged between a supervision code and a
+#  computation code. These Exchange Variables can be stored in a SObject in
+#  Salome study.
+#  \}
+
+"""
+This module provides classes and functions to handle "Exchange Variables",
+i.e. description of variables to be exchanged between a supervision code and a
+computation code. These Exchange Variables can be stored in a SObject in
+Salome study.
+"""
+
+from xml.dom.minidom import getDOMImplementation, parse
+from salome.kernel.studyedit import getStudyEditor
+
+DEFAULT_NAME = "Variables"
+INPUT_VAR_NAMES = "ExchangeVariables.InputVarNames"
+OUTPUT_VAR_NAMES = "ExchangeVariables.OutputVarNames"
+REF_ENTRY = "ExchangeVariables.RefEntry"
+
+## This class describes a single variable. For now, it is only described by
+#  its name. Other attributes are reserved for future use.
+#  \ingroup study_exchange_vars
+class Variable:
+    """
+    This class describes a single variable. For now, it is only described by
+    its name. Other attributes are reserved for future use.
+    """
+    
+    def __init__(self, name, dimension = None, minValue = None, maxValue = None,
+                 initialValue = None):
+        if dimension is None:
+            dimension = []
+        self.name = name
+        
+        # Reserved for future use
+        self.dimension = dimension
+        self.minValue = minValue
+        self.maxValue = maxValue
+        self.initialValue = initialValue
+
+## This class describes "Exchange Variables", i.e. a structure containing all
+#  the necessary information to exchange variables between a supervision code
+#  and a computation code.
+#
+#  \param inputVarList This instance attribute is a list of \b Variable objects,
+#  describing the input variables for the computation code.
+#
+#  \param outputVarList This instance attribute is a list of \b Variable objects,
+#  describing the output variables for the computation code.
+#
+#  \param refEntry This instance attribute is optional and can be used to store a
+#  reference to a Salome entry containing an "Exchange Variable" SObject
+#  that was used to build this one (when the current object has been built
+#  by selecting variables of interest in a list of potential variables).
+#  \ingroup study_exchange_vars
+class ExchangeVariables:
+    """
+    This class describes "Exchange Variables", i.e. a structure containing all
+    the necessary information to exchange variables between a supervision code
+    and a computation code.
+
+    .. attribute:: inputVarList
+    
+       This instance attribute is a list of :class:`Variable` objects,
+       describing the input variables for the computation code.
+
+    .. attribute:: outputVarList
+    
+       This instance attribute is a list of :class:`Variable` objects,
+       describing the output variables for the computation code.
+
+    .. attribute:: refEntry
+
+       This instance attribute is optional and can be used to store a
+       reference to a Salome entry containing an "Exchange Variable" SObject
+       that was used to build this one (when the current object has been built
+       by selecting variables of interest in a list of potential variables).
+
+    """
+    
+    def __init__(self, inputVarList = None, outputVarList = None,
+                 refEntry = None):
+        if inputVarList is None:
+            inputVarList = []
+        if outputVarList is None:
+            outputVarList = []
+        self.inputVarList = inputVarList
+        self.outputVarList = outputVarList
+        self.refEntry = refEntry
+
+    ## Save this object to an XML file.
+    #
+    #  \param filepath (string) path of the XML file.
+    def saveToXmlFile(self, filepath):
+        """
+        Save this object to an XML file.
+    
+        :type  filepath: string
+        :param filepath: path of the XML file.
+    
+        """
+        doc = getDOMImplementation().createDocument(None, "variables", None)
+        top_el = doc.documentElement
+        top_el.setAttribute("version", "6.4")
+        input_variables_el = doc.createElement("input_variables")
+        top_el.appendChild(input_variables_el)
+        output_variables_el = doc.createElement("output_variables")
+        top_el.appendChild(output_variables_el)
+        for input_var in self.inputVarList:
+            input_var_el = doc.createElement("variable")
+            input_var_el.setAttribute("name", input_var.name)
+            input_variables_el.appendChild(input_var_el)
+        for output_var in self.outputVarList:
+            output_var_el = doc.createElement("variable")
+            output_var_el.setAttribute("name", output_var.name)
+            output_variables_el.appendChild(output_var_el)
+        f = open(filepath, "w")
+        f.write(doc.toprettyxml(indent = "  "))
+        f.close()
+
+## Create a SObject to store an \b ExchangeVariables instance.
+#
+#  \param fatherSobj (SObject) parent of the SObject to create.
+#
+#  \param exchangeVariables (ExchangeVariables) \b ExchangeVariables instance to store in
+#  Salome study.
+#
+#  \param name (string) name of the SObject to create.
+#
+#  \param icon (string) icon of the SObject to create.
+#
+#  \param typeId (integer) type of the SObject to create.
+#
+#  \return the newly created SObject.
+#  \ingroup study_exchange_vars
+def createSObjectForExchangeVariables(fatherSobj, exchangeVariables,
+                                      name = DEFAULT_NAME,
+                                      icon = None, typeId = None):
+    """
+    Create a SObject to store an :class:`ExchangeVariables` instance.
+
+    :type  fatherSobj: SObject
+    :param fatherSobj: parent of the SObject to create.
+
+    :type  exchangeVariables: :class:`ExchangeVariables`
+    :param exchangeVariables: :class:`ExchangeVariables` instance to store in
+                              Salome study.
+
+    :type  name: string
+    :param name: name of the SObject to create.
+
+    :type  icon: string
+    :param icon: icon of the SObject to create.
+
+    :type  typeId: integer
+    :param typeId: type of the SObject to create.
+
+    :return: the newly created SObject.
+
+    """
+    editor = getStudyEditor()
+    sobj = editor.createItem(fatherSobj,
+                             name = name,
+                             icon = icon,
+                             typeId = typeId)
+    _setSObjectForExchangeVariables(editor, sobj, exchangeVariables)
+
+## Update an existing SObject storing an \b ExchangeVariables instance.
+#
+#  \param sobj (SObject) the SObject to update.
+#
+#  See \b createSObjectForExchangeVariables() for the description of the
+#  other parameters.
+#  \ingroup study_exchange_vars
+def updateSObjectForExchangeVariables(sobj, exchangeVariables,
+                                      name = DEFAULT_NAME,
+                                      icon = None, typeId = None):
+    """
+    Update an existing SObject storing an :class:`ExchangeVariables` instance.
+
+    :type  sobj: SObject
+    :param sobj: the SObject to update.
+
+    See :func:`createSObjectForExchangeVariables` for the description of the
+    other parameters.
+
+    """
+    editor = getStudyEditor()
+    editor.setItem(sobj, name = name, icon = icon, typeId = typeId)
+    editor.builder.RemoveAttribute(sobj, "AttributeParameter")
+    _setSObjectForExchangeVariables(editor, sobj, exchangeVariables)
+
+def _setSObjectForExchangeVariables(editor, sobj, exchangeVariables):
+    attr = editor.builder.FindOrCreateAttribute(sobj, "AttributeParameter")
+    attr.SetStrArray(INPUT_VAR_NAMES,
+                     [x.name for x in exchangeVariables.inputVarList])
+    attr.SetStrArray(OUTPUT_VAR_NAMES,
+                     [x.name for x in exchangeVariables.outputVarList])
+    if exchangeVariables.refEntry is not None:
+        attr.SetString(REF_ENTRY, exchangeVariables.refEntry)
+
+## Get an \b ExchangeVariables instance from a SObject that stores it.
+#
+#  \param sobj (SObject) the SObject from which to read the \b ExchangeVariables
+#  instance.
+#
+#  \return the newly created \b ExchangeVariables instance.
+#  \ingroup study_exchange_vars
+def getExchangeVariablesFromSObject(sobj):
+    """
+    Get an :class:`ExchangeVariables` instance from a SObject that stores it.
+
+    :type  sobj: SObject
+    :param sobj: the SObject from which to read the :class:`ExchangeVariables`
+                 instance.
+
+    :return: the newly created :class:`ExchangeVariables` instance.
+
+    """
+    (found, attr) = sobj.FindAttribute("AttributeParameter")
+    if not found:
+        return None
+    refEntry = None
+    if attr.IsSet(REF_ENTRY, 3):
+        refEntry = attr.GetString(REF_ENTRY)
+    return ExchangeVariables(
+            [Variable(name) for name in attr.GetStrArray(INPUT_VAR_NAMES)],
+            [Variable(name) for name in attr.GetStrArray(OUTPUT_VAR_NAMES)],
+            refEntry)
+
+## Load an \b ExchangeVariables instance from an XML file.
+#
+#  \param filepath (string) path of the XML file to load.
+#
+#  \return the newly created \b ExchangeVariables instance.
+#  \ingroup study_exchange_vars
+def loadExchangeVariablesFromXmlFile(filepath):
+    """
+    Load an :class:`ExchangeVariables` instance from an XML file.
+
+    :type  filepath: string
+    :param filepath: path of the XML file to load.
+
+    :return: the newly created :class:`ExchangeVariables` instance.
+
+    """
+    doc = parse(filepath)
+    top_el = doc.documentElement
+    # Check version
+    version = top_el.getAttribute("version")
+    if version != "6.4":
+        raise Exception(self.tr("Unsupported version: %s" % version))
+    input_variables_el = top_el.getElementsByTagName("input_variables")[0]
+    input_var_list = [Variable(input_var_el.getAttribute("name"))
+                      for input_var_el
+                      in input_variables_el.getElementsByTagName("variable")]
+    output_variables_el = top_el.getElementsByTagName("output_variables")[0]
+    output_var_list = [Variable(output_var_el.getAttribute("name"))
+                       for output_var_el
+                       in output_variables_el.getElementsByTagName("variable")]
+    return ExchangeVariables(input_var_list, output_var_list)