update generated code

Author: PProfizi

doc/source/_static/dpf_operators.html

@@ -6185,7 +6185,8 @@ <h2 class="h2-main">Configurating operators</h2>
 </div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Supported file types</h2><supported-file-types content='{"mapdl":["rst","rth","rstp"]}'></supported-file-types><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number-optional n="1" ellipsis = "false"></pin-number-optional></td><td><pin-name name="solver_element_types_ids"></pin-name></td><td><req-type typeName="(int32 | vector<int32>)"></req-type></td><td><div class = "pin-des-text"><p>Element Type ids to recover used by the solver. If not set, all available element types to be recovered.</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="3" ellipsis = "false"></pin-number-optional></td><td><pin-name name="streams"></pin-name></td><td><req-type typeName="(streams_container)"></req-type></td><td><div class = "pin-des-text"><p>Result file container allowed to be kept open to cache data.</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="4" ellipsis = "false"></pin-number></td><td><pin-name name="data_sources"></pin-name></td><td><req-type typeName="(data_sources)"></req-type></td><td><div class = "pin-des-text"><p>Result file path container, used if no streams are set.</p>
-</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="element_types_data"></pin-name></td><td><req-type typeName="(generic_data_container)"></req-type></td><td><div class = "pin-des-text"><p>The generic_data_container has a class_name: ElementTypesProperties. It contains the following property fields: element_routine_number: Element routine number. E.g 186 for SOLID186, keyopts: Element type option keys, kdofs: DOF/node for this element type.This is a bit mapping, nodelm: Number of nodes for this element type, nodfor: Number of nodes per element having nodal forces, nodstr: Number of nodes per element having nodal stresses, new_gen_element: Element of new generation.</p>
+</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="200" ellipsis = "false"></pin-number-optional></td><td><pin-name name="output_type"></pin-name></td><td><req-type typeName="(int32)"></req-type></td><td><div class = "pin-des-text"><p>Get the output as a GenericDataContainer (pin value 1, default) or as a PropertyField (pin value 2). If a PropertyField is recovered, the 200 ElementTypesProperties are recovered for each element type, in order.</p>
+</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="element_types_data"></pin-name></td><td><req-type typeName="(generic_data_container | property_field)"></req-type></td><td><div class = "pin-des-text"><p>The generic_data_container has a class_name: ElementTypesProperties. It contains the following property fields: element_routine_number: Element routine number. E.g 186 for SOLID186, keyopts: Element type option keys, kdofs: DOF/node for this element type.This is a bit mapping, nodelm: Number of nodes for this element type, nodfor: Number of nodes per element having nodal forces, nodstr: Number of nodes per element having nodal stresses, new_gen_element: Element of new generation.</p>
 </div></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><config-spec name="num_threads" default="0" doc="Number of threads to use to run in parallel" types="int32" ></config-spec><config-spec name="run_in_parallel" default="true" doc="Loops are allowed to run in parallel if the value of this config is set to true." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="element_types_provider" license="none" cat="metadata" plugin="core" cpp-name="element_types_provider"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="delegate to operator" scripting_name="delegate_to_operator"plugin="core"cat="utility"><h1 class="op-des-h1">utility: delegate to operator</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Delegate the run to an Operator instantiated by the name in input (forwards all the input of this Operator to the sub Operator).</p>
 </div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="-1" ellipsis = "false"></pin-number></td><td><pin-name name="operator_name"></pin-name></td><td><req-type typeName="(string)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "true"></pin-number></td><td><pin-name name="any"></pin-name></td><td><req-type typeName="(any)"></req-type></td><td><div class = "pin-des-text"><p>inputs</p>
 </div></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="delegate_to_operator" license="none" cat="utility" plugin="core" cpp-name="delegate_to_operator"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="acceleration Y" scripting_name="acceleration_Y"plugin="core"cat="result"><h1 class="op-des-h1">result: acceleration Y</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Read/compute nodal accelerations Y component of the vector (2nd component) by calling the readers defined by the datasources.</p>

src/ansys/dpf/core/operators/metadata/element_types_provider.py

@@ -10,6 +10,7 @@
 from ansys.dpf.core.dpf_operator import Operator
 from ansys.dpf.core.inputs import Input, _Inputs
 from ansys.dpf.core.outputs import Output, _Outputs
+from ansys.dpf.core.outputs import _modify_output_spec_with_one_type
 from ansys.dpf.core.operators.specification import PinSpecification, Specification
 from ansys.dpf.core.config import Config
 from ansys.dpf.core.server_types import AnyServerType
@@ -28,10 +29,12 @@ class element_types_provider(Operator):
         Result file container allowed to be kept open to cache data.
     data_sources: DataSources
         Result file path container, used if no streams are set.
+    output_type: int, optional
+        Get the output as a GenericDataContainer (pin value 1, default) or as a PropertyField (pin value 2). If a PropertyField is recovered, the 200 ElementTypesProperties are recovered for each element type, in order.
 
     Returns
     -------
-    element_types_data: GenericDataContainer
+    element_types_data: GenericDataContainer or PropertyField
         The generic_data_container has a class_name: ElementTypesProperties. It contains the following property fields: element_routine_number: Element routine number. E.g 186 for SOLID186, keyopts: Element type option keys, kdofs: DOF/node for this element type.This is a bit mapping, nodelm: Number of nodes for this element type, nodfor: Number of nodes per element having nodal forces, nodstr: Number of nodes per element having nodal stresses, new_gen_element: Element of new generation.
 
     Examples
@@ -48,12 +51,15 @@ class element_types_provider(Operator):
     >>> op.inputs.streams.connect(my_streams)
     >>> my_data_sources = dpf.DataSources()
     >>> op.inputs.data_sources.connect(my_data_sources)
+    >>> my_output_type = int()
+    >>> op.inputs.output_type.connect(my_output_type)
 
     >>> # Instantiate operator and connect inputs in one line
     >>> op = dpf.operators.metadata.element_types_provider(
     ...     solver_element_types_ids=my_solver_element_types_ids,
     ...     streams=my_streams,
     ...     data_sources=my_data_sources,
+    ...     output_type=my_output_type,
     ... )
 
     >>> # Get output data
@@ -65,6 +71,7 @@ def __init__(
         solver_element_types_ids=None,
         streams=None,
         data_sources=None,
+        output_type=None,
         config=None,
         server=None,
     ):
@@ -77,6 +84,8 @@ def __init__(
             self.inputs.streams.connect(streams)
         if data_sources is not None:
             self.inputs.data_sources.connect(data_sources)
+        if output_type is not None:
+            self.inputs.output_type.connect(output_type)
 
     @staticmethod
     def _spec() -> Specification:
@@ -104,11 +113,17 @@ def _spec() -> Specification:
                     optional=False,
                     document=r"""Result file path container, used if no streams are set.""",
                 ),
+                200: PinSpecification(
+                    name="output_type",
+                    type_names=["int32"],
+                    optional=True,
+                    document=r"""Get the output as a GenericDataContainer (pin value 1, default) or as a PropertyField (pin value 2). If a PropertyField is recovered, the 200 ElementTypesProperties are recovered for each element type, in order.""",
+                ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
                     name="element_types_data",
-                    type_names=["generic_data_container"],
+                    type_names=["generic_data_container", "property_field"],
                     optional=False,
                     document=r"""The generic_data_container has a class_name: ElementTypesProperties. It contains the following property fields: element_routine_number: Element routine number. E.g 186 for SOLID186, keyopts: Element type option keys, kdofs: DOF/node for this element type.This is a bit mapping, nodelm: Number of nodes for this element type, nodfor: Number of nodes per element having nodal forces, nodstr: Number of nodes per element having nodal stresses, new_gen_element: Element of new generation.""",
                 ),
@@ -174,6 +189,8 @@ class InputsElementTypesProvider(_Inputs):
     >>> op.inputs.streams.connect(my_streams)
     >>> my_data_sources = dpf.DataSources()
     >>> op.inputs.data_sources.connect(my_data_sources)
+    >>> my_output_type = int()
+    >>> op.inputs.output_type.connect(my_output_type)
     """
 
     def __init__(self, op: Operator):
@@ -188,6 +205,10 @@ def __init__(self, op: Operator):
             element_types_provider._spec().input_pin(4), 4, op, -1
         )
         self._inputs.append(self._data_sources)
+        self._output_type = Input(
+            element_types_provider._spec().input_pin(200), 200, op, -1
+        )
+        self._inputs.append(self._output_type)
 
     @property
     def solver_element_types_ids(self) -> Input:
@@ -252,6 +273,27 @@ def data_sources(self) -> Input:
         """
         return self._data_sources
 
+    @property
+    def output_type(self) -> Input:
+        r"""Allows to connect output_type input to the operator.
+
+        Get the output as a GenericDataContainer (pin value 1, default) or as a PropertyField (pin value 2). If a PropertyField is recovered, the 200 ElementTypesProperties are recovered for each element type, in order.
+
+        Returns
+        -------
+        input:
+            An Input instance for this pin.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.metadata.element_types_provider()
+        >>> op.inputs.output_type.connect(my_output_type)
+        >>> # or
+        >>> op.inputs.output_type(my_output_type)
+        """
+        return self._output_type
+
 
 class OutputsElementTypesProvider(_Outputs):
     """Intermediate class used to get outputs from
@@ -267,27 +309,19 @@ class OutputsElementTypesProvider(_Outputs):
 
     def __init__(self, op: Operator):
         super().__init__(element_types_provider._spec().outputs, op)
-        self._element_types_data = Output(
-            element_types_provider._spec().output_pin(0), 0, op
+        self.element_types_data_as_generic_data_container = Output(
+            _modify_output_spec_with_one_type(
+                element_types_provider._spec().output_pin(0), "generic_data_container"
+            ),
+            0,
+            op,
         )
-        self._outputs.append(self._element_types_data)
-
-    @property
-    def element_types_data(self) -> Output:
-        r"""Allows to get element_types_data output of the operator
-
-        The generic_data_container has a class_name: ElementTypesProperties. It contains the following property fields: element_routine_number: Element routine number. E.g 186 for SOLID186, keyopts: Element type option keys, kdofs: DOF/node for this element type.This is a bit mapping, nodelm: Number of nodes for this element type, nodfor: Number of nodes per element having nodal forces, nodstr: Number of nodes per element having nodal stresses, new_gen_element: Element of new generation.
-
-        Returns
-        -------
-        output:
-            An Output instance for this pin.
-
-        Examples
-        --------
-        >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.metadata.element_types_provider()
-        >>> # Get the output from op.outputs. ...
-        >>> result_element_types_data = op.outputs.element_types_data()
-        """
-        return self._element_types_data
+        self._outputs.append(self.element_types_data_as_generic_data_container)
+        self.element_types_data_as_property_field = Output(
+            _modify_output_spec_with_one_type(
+                element_types_provider._spec().output_pin(0), "property_field"
+            ),
+            0,
+            op,
+        )
+        self._outputs.append(self.element_types_data_as_property_field)