update generated code

Author: PProfizi

doc/source/_static/dpf_operators.html

@@ -59,7 +59,6 @@
 from .coordinates import coordinates
 from .creep_strain_energy_density import creep_strain_energy_density
 from .current_density import current_density
-from .custom import custom
 from .cyclic_analytic_seqv_max import cyclic_analytic_seqv_max
 from .cyclic_analytic_usum_max import cyclic_analytic_usum_max
 from .cyclic_expansion import cyclic_expansion
@@ -246,6 +245,7 @@
 from .recombine_harmonic_indeces_cyclic import recombine_harmonic_indeces_cyclic
 from .remove_rigid_body_motion import remove_rigid_body_motion
 from .remove_rigid_body_motion_fc import remove_rigid_body_motion_fc
+from .result_provider import result_provider
 from .rigid_transformation import rigid_transformation
 from .rigid_transformation_provider import rigid_transformation_provider
 from .rms_static_pressure import rms_static_pressure

src/ansys/dpf/core/operators/result/__init__.py

@@ -1,5 +1,5 @@
 """
-custom
+result_provider
 
 Autogenerated DPF operator classes.
 """
@@ -15,7 +15,7 @@
 from ansys.dpf.core.server_types import AnyServerType
 
 
-class custom(Operator):
+class result_provider(Operator):
     r"""Read/compute user defined result by calling the readers defined by the
     datasources.
 
@@ -37,7 +37,9 @@ class custom(Operator):
     mesh: MeshedRegion or MeshesContainer, optional
         prevents from reading the mesh in the result files
     result_name:
-        Name of the result that must be extracted from the file
+        Specifies the scripting name of the raw/internal Name of the result to extract from the file
+    result_scripting_name: optional
+        Specifies the scripting name of the result to extract;see ResultInfo for details. Use either "result name" or "result scripting name" with their appropriate pin, but not both.
 
     Returns
     -------
@@ -48,7 +50,7 @@ class custom(Operator):
     >>> from ansys.dpf import core as dpf
 
     >>> # Instantiate operator
-    >>> op = dpf.operators.result.custom()
+    >>> op = dpf.operators.result.result_provider()
 
     >>> # Make input connections
     >>> my_time_scoping = dpf.Scoping()
@@ -67,9 +69,11 @@ class custom(Operator):
     >>> op.inputs.mesh.connect(my_mesh)
     >>> my_result_name = dpf.()
     >>> op.inputs.result_name.connect(my_result_name)
+    >>> my_result_scripting_name = dpf.()
+    >>> op.inputs.result_scripting_name.connect(my_result_scripting_name)
 
     >>> # Instantiate operator and connect inputs in one line
-    >>> op = dpf.operators.result.custom(
+    >>> op = dpf.operators.result.result_provider(
     ...     time_scoping=my_time_scoping,
     ...     mesh_scoping=my_mesh_scoping,
     ...     fields_container=my_fields_container,
@@ -78,6 +82,7 @@ class custom(Operator):
     ...     bool_rotate_to_global=my_bool_rotate_to_global,
     ...     mesh=my_mesh,
     ...     result_name=my_result_name,
+    ...     result_scripting_name=my_result_scripting_name,
     ... )
 
     >>> # Get output data
@@ -94,12 +99,13 @@ def __init__(
         bool_rotate_to_global=None,
         mesh=None,
         result_name=None,
+        result_scripting_name=None,
         config=None,
         server=None,
     ):
-        super().__init__(name="custom", config=config, server=server)
-        self._inputs = InputsCustom(self)
-        self._outputs = OutputsCustom(self)
+        super().__init__(name="result_provider", config=config, server=server)
+        self._inputs = InputsResultProvider(self)
+        self._outputs = OutputsResultProvider(self)
         if time_scoping is not None:
             self.inputs.time_scoping.connect(time_scoping)
         if mesh_scoping is not None:
@@ -116,6 +122,8 @@ def __init__(
             self.inputs.mesh.connect(mesh)
         if result_name is not None:
             self.inputs.result_name.connect(result_name)
+        if result_scripting_name is not None:
+            self.inputs.result_scripting_name.connect(result_scripting_name)
 
     @staticmethod
     def _spec() -> Specification:
@@ -178,7 +186,13 @@ def _spec() -> Specification:
                     name="result_name",
                     type_names=["any"],
                     optional=False,
-                    document=r"""Name of the result that must be extracted from the file""",
+                    document=r"""Specifies the scripting name of the raw/internal Name of the result to extract from the file""",
+                ),
+                64: PinSpecification(
+                    name="result_scripting_name",
+                    type_names=["any"],
+                    optional=True,
+                    document=r"""Specifies the scripting name of the result to extract;see ResultInfo for details. Use either "result name" or "result scripting name" with their appropriate pin, but not both.""",
                 ),
             },
             map_output_pin_spec={
@@ -211,39 +225,39 @@ def default_config(server: AnyServerType = None) -> Config:
         config:
             A new Config instance equivalent to the default config for this operator.
         """
-        return Operator.default_config(name="custom", server=server)
+        return Operator.default_config(name="result_provider", server=server)
 
     @property
-    def inputs(self) -> InputsCustom:
+    def inputs(self) -> InputsResultProvider:
         """Enables to connect inputs to the operator
 
         Returns
         --------
         inputs:
-            An instance of InputsCustom.
+            An instance of InputsResultProvider.
         """
         return super().inputs
 
     @property
-    def outputs(self) -> OutputsCustom:
+    def outputs(self) -> OutputsResultProvider:
         """Enables to get outputs of the operator by evaluating it
 
         Returns
         --------
         outputs:
-            An instance of OutputsCustom.
+            An instance of OutputsResultProvider.
         """
         return super().outputs
 
 
-class InputsCustom(_Inputs):
+class InputsResultProvider(_Inputs):
     """Intermediate class used to connect user inputs to
-    custom operator.
+    result_provider operator.
 
     Examples
     --------
     >>> from ansys.dpf import core as dpf
-    >>> op = dpf.operators.result.custom()
+    >>> op = dpf.operators.result.result_provider()
     >>> my_time_scoping = dpf.Scoping()
     >>> op.inputs.time_scoping.connect(my_time_scoping)
     >>> my_mesh_scoping = dpf.ScopingsContainer()
@@ -260,26 +274,34 @@ class InputsCustom(_Inputs):
     >>> op.inputs.mesh.connect(my_mesh)
     >>> my_result_name = dpf.()
     >>> op.inputs.result_name.connect(my_result_name)
+    >>> my_result_scripting_name = dpf.()
+    >>> op.inputs.result_scripting_name.connect(my_result_scripting_name)
     """
 
     def __init__(self, op: Operator):
-        super().__init__(custom._spec().inputs, op)
-        self._time_scoping = Input(custom._spec().input_pin(0), 0, op, -1)
+        super().__init__(result_provider._spec().inputs, op)
+        self._time_scoping = Input(result_provider._spec().input_pin(0), 0, op, -1)
         self._inputs.append(self._time_scoping)
-        self._mesh_scoping = Input(custom._spec().input_pin(1), 1, op, -1)
+        self._mesh_scoping = Input(result_provider._spec().input_pin(1), 1, op, -1)
         self._inputs.append(self._mesh_scoping)
-        self._fields_container = Input(custom._spec().input_pin(2), 2, op, -1)
+        self._fields_container = Input(result_provider._spec().input_pin(2), 2, op, -1)
         self._inputs.append(self._fields_container)
-        self._streams_container = Input(custom._spec().input_pin(3), 3, op, -1)
+        self._streams_container = Input(result_provider._spec().input_pin(3), 3, op, -1)
         self._inputs.append(self._streams_container)
-        self._data_sources = Input(custom._spec().input_pin(4), 4, op, -1)
+        self._data_sources = Input(result_provider._spec().input_pin(4), 4, op, -1)
         self._inputs.append(self._data_sources)
-        self._bool_rotate_to_global = Input(custom._spec().input_pin(5), 5, op, -1)
+        self._bool_rotate_to_global = Input(
+            result_provider._spec().input_pin(5), 5, op, -1
+        )
         self._inputs.append(self._bool_rotate_to_global)
-        self._mesh = Input(custom._spec().input_pin(7), 7, op, -1)
+        self._mesh = Input(result_provider._spec().input_pin(7), 7, op, -1)
         self._inputs.append(self._mesh)
-        self._result_name = Input(custom._spec().input_pin(60), 60, op, -1)
+        self._result_name = Input(result_provider._spec().input_pin(60), 60, op, -1)
         self._inputs.append(self._result_name)
+        self._result_scripting_name = Input(
+            result_provider._spec().input_pin(64), 64, op, -1
+        )
+        self._inputs.append(self._result_scripting_name)
 
     @property
     def time_scoping(self) -> Input:
@@ -295,7 +317,7 @@ def time_scoping(self) -> Input:
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.result.custom()
+        >>> op = dpf.operators.result.result_provider()
         >>> op.inputs.time_scoping.connect(my_time_scoping)
         >>> # or
         >>> op.inputs.time_scoping(my_time_scoping)
@@ -316,7 +338,7 @@ def mesh_scoping(self) -> Input:
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.result.custom()
+        >>> op = dpf.operators.result.result_provider()
         >>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
         >>> # or
         >>> op.inputs.mesh_scoping(my_mesh_scoping)
@@ -337,7 +359,7 @@ def fields_container(self) -> Input:
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.result.custom()
+        >>> op = dpf.operators.result.result_provider()
         >>> op.inputs.fields_container.connect(my_fields_container)
         >>> # or
         >>> op.inputs.fields_container(my_fields_container)
@@ -358,7 +380,7 @@ def streams_container(self) -> Input:
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.result.custom()
+        >>> op = dpf.operators.result.result_provider()
         >>> op.inputs.streams_container.connect(my_streams_container)
         >>> # or
         >>> op.inputs.streams_container(my_streams_container)
@@ -379,7 +401,7 @@ def data_sources(self) -> Input:
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.result.custom()
+        >>> op = dpf.operators.result.result_provider()
         >>> op.inputs.data_sources.connect(my_data_sources)
         >>> # or
         >>> op.inputs.data_sources(my_data_sources)
@@ -400,7 +422,7 @@ def bool_rotate_to_global(self) -> Input:
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.result.custom()
+        >>> op = dpf.operators.result.result_provider()
         >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
         >>> # or
         >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)
@@ -421,7 +443,7 @@ def mesh(self) -> Input:
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.result.custom()
+        >>> op = dpf.operators.result.result_provider()
         >>> op.inputs.mesh.connect(my_mesh)
         >>> # or
         >>> op.inputs.mesh(my_mesh)
@@ -432,7 +454,7 @@ def mesh(self) -> Input:
     def result_name(self) -> Input:
         r"""Allows to connect result_name input to the operator.
 
-        Name of the result that must be extracted from the file
+        Specifies the scripting name of the raw/internal Name of the result to extract from the file
 
         Returns
         -------
@@ -442,29 +464,50 @@ def result_name(self) -> Input:
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.result.custom()
+        >>> op = dpf.operators.result.result_provider()
         >>> op.inputs.result_name.connect(my_result_name)
         >>> # or
         >>> op.inputs.result_name(my_result_name)
         """
         return self._result_name
 
+    @property
+    def result_scripting_name(self) -> Input:
+        r"""Allows to connect result_scripting_name input to the operator.
+
+        Specifies the scripting name of the result to extract;see ResultInfo for details. Use either "result name" or "result scripting name" with their appropriate pin, but not both.
+
+        Returns
+        -------
+        input:
+            An Input instance for this pin.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.result.result_provider()
+        >>> op.inputs.result_scripting_name.connect(my_result_scripting_name)
+        >>> # or
+        >>> op.inputs.result_scripting_name(my_result_scripting_name)
+        """
+        return self._result_scripting_name
+
 
-class OutputsCustom(_Outputs):
+class OutputsResultProvider(_Outputs):
     """Intermediate class used to get outputs from
-    custom operator.
+    result_provider operator.
 
     Examples
     --------
     >>> from ansys.dpf import core as dpf
-    >>> op = dpf.operators.result.custom()
+    >>> op = dpf.operators.result.result_provider()
     >>> # Connect inputs : op.inputs. ...
     >>> result_fields_container = op.outputs.fields_container()
     """
 
     def __init__(self, op: Operator):
-        super().__init__(custom._spec().outputs, op)
-        self._fields_container = Output(custom._spec().output_pin(0), 0, op)
+        super().__init__(result_provider._spec().outputs, op)
+        self._fields_container = Output(result_provider._spec().output_pin(0), 0, op)
         self._outputs.append(self._fields_container)
 
     @property
@@ -479,7 +522,7 @@ def fields_container(self) -> Output:
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.result.custom()
+        >>> op = dpf.operators.result.result_provider()
         >>> # Get the output from op.outputs. ...
         >>> result_fields_container = op.outputs.fields_container()
         """