Update generated code for DPF 251_daily on maint/update_code_for_251_daily_on_master

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

@@ -1,4 +1,5 @@
 from .adapt_with_scopings_container import adapt_with_scopings_container
+from .change_fc import change_fc
 from .compute_element_centroids import compute_element_centroids
 from .connectivity_ids import connectivity_ids
 from .elemental_from_mesh import elemental_from_mesh

src/ansys/dpf/core/operators/scoping/change_fc.py

@@ -0,0 +1,225 @@
+"""
+change_fc
+=========
+Autogenerated DPF operator classes.
+"""
+
+from warnings import warn
+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.operators.specification import PinSpecification, Specification
+
+
+class change_fc(Operator):
+    """DEPRECATED, PLEASE USE ADAPT WITH SCOPINGS CONTAINER. Rescopes/splits
+    a fields container to correspond to a scopings container.
+
+    Parameters
+    ----------
+    field_or_fields_container : FieldsContainer or Field
+    scopings_container : ScopingsContainer
+
+    Returns
+    -------
+    fields_container : FieldsContainer
+
+    Examples
+    --------
+    >>> from ansys.dpf import core as dpf
+
+    >>> # Instantiate operator
+    >>> op = dpf.operators.scoping.change_fc()
+
+    >>> # Make input connections
+    >>> my_field_or_fields_container = dpf.FieldsContainer()
+    >>> op.inputs.field_or_fields_container.connect(my_field_or_fields_container)
+    >>> my_scopings_container = dpf.ScopingsContainer()
+    >>> op.inputs.scopings_container.connect(my_scopings_container)
+
+    >>> # Instantiate operator and connect inputs in one line
+    >>> op = dpf.operators.scoping.change_fc(
+    ...     field_or_fields_container=my_field_or_fields_container,
+    ...     scopings_container=my_scopings_container,
+    ... )
+
+    >>> # Get output data
+    >>> result_fields_container = op.outputs.fields_container()
+    """
+
+    def __init__(
+        self,
+        field_or_fields_container=None,
+        scopings_container=None,
+        config=None,
+        server=None,
+    ):
+        super().__init__(name="change_fc", config=config, server=server)
+        self._inputs = InputsChangeFc(self)
+        self._outputs = OutputsChangeFc(self)
+        if field_or_fields_container is not None:
+            self.inputs.field_or_fields_container.connect(field_or_fields_container)
+        if scopings_container is not None:
+            self.inputs.scopings_container.connect(scopings_container)
+
+    @staticmethod
+    def _spec():
+        description = """DEPRECATED, PLEASE USE ADAPT WITH SCOPINGS CONTAINER. Rescopes/splits
+            a fields container to correspond to a scopings container."""
+        spec = Specification(
+            description=description,
+            map_input_pin_spec={
+                0: PinSpecification(
+                    name="field_or_fields_container",
+                    type_names=["fields_container", "field"],
+                    optional=False,
+                    document="""""",
+                ),
+                1: PinSpecification(
+                    name="scopings_container",
+                    type_names=["scopings_container"],
+                    optional=False,
+                    document="""""",
+                ),
+            },
+            map_output_pin_spec={
+                0: PinSpecification(
+                    name="fields_container",
+                    type_names=["fields_container"],
+                    optional=False,
+                    document="""""",
+                ),
+            },
+        )
+        return spec
+
+    @staticmethod
+    def default_config(server=None):
+        """Returns the default config of the operator.
+
+        This config can then be changed to the user needs and be used to
+        instantiate the operator. The Configuration allows to customize
+        how the operation will be processed by the operator.
+
+        Parameters
+        ----------
+        server : server.DPFServer, optional
+            Server with channel connected to the remote or local instance. When
+            ``None``, attempts to use the global server.
+        """
+        return Operator.default_config(name="change_fc", server=server)
+
+    @property
+    def inputs(self):
+        """Enables to connect inputs to the operator
+
+        Returns
+        --------
+        inputs : InputsChangeFc
+        """
+        return super().inputs
+
+    @property
+    def outputs(self):
+        """Enables to get outputs of the operator by evaluating it
+
+        Returns
+        --------
+        outputs : OutputsChangeFc
+        """
+        return super().outputs
+
+
+class InputsChangeFc(_Inputs):
+    """Intermediate class used to connect user inputs to
+    change_fc operator.
+
+    Examples
+    --------
+    >>> from ansys.dpf import core as dpf
+    >>> op = dpf.operators.scoping.change_fc()
+    >>> my_field_or_fields_container = dpf.FieldsContainer()
+    >>> op.inputs.field_or_fields_container.connect(my_field_or_fields_container)
+    >>> my_scopings_container = dpf.ScopingsContainer()
+    >>> op.inputs.scopings_container.connect(my_scopings_container)
+    """
+
+    def __init__(self, op: Operator):
+        super().__init__(change_fc._spec().inputs, op)
+        self._field_or_fields_container = Input(
+            change_fc._spec().input_pin(0), 0, op, -1
+        )
+        self._inputs.append(self._field_or_fields_container)
+        self._scopings_container = Input(change_fc._spec().input_pin(1), 1, op, -1)
+        self._inputs.append(self._scopings_container)
+
+    @property
+    def field_or_fields_container(self):
+        """Allows to connect field_or_fields_container input to the operator.
+
+        Parameters
+        ----------
+        my_field_or_fields_container : FieldsContainer or Field
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.scoping.change_fc()
+        >>> op.inputs.field_or_fields_container.connect(my_field_or_fields_container)
+        >>> # or
+        >>> op.inputs.field_or_fields_container(my_field_or_fields_container)
+        """
+        return self._field_or_fields_container
+
+    @property
+    def scopings_container(self):
+        """Allows to connect scopings_container input to the operator.
+
+        Parameters
+        ----------
+        my_scopings_container : ScopingsContainer
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.scoping.change_fc()
+        >>> op.inputs.scopings_container.connect(my_scopings_container)
+        >>> # or
+        >>> op.inputs.scopings_container(my_scopings_container)
+        """
+        return self._scopings_container
+
+
+class OutputsChangeFc(_Outputs):
+    """Intermediate class used to get outputs from
+    change_fc operator.
+
+    Examples
+    --------
+    >>> from ansys.dpf import core as dpf
+    >>> op = dpf.operators.scoping.change_fc()
+    >>> # Connect inputs : op.inputs. ...
+    >>> result_fields_container = op.outputs.fields_container()
+    """
+
+    def __init__(self, op: Operator):
+        super().__init__(change_fc._spec().outputs, op)
+        self._fields_container = Output(change_fc._spec().output_pin(0), 0, op)
+        self._outputs.append(self._fields_container)
+
+    @property
+    def fields_container(self):
+        """Allows to get fields_container output of the operator
+
+        Returns
+        ----------
+        my_fields_container : FieldsContainer
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.scoping.change_fc()
+        >>> # Connect inputs : op.inputs. ...
+        >>> result_fields_container = op.outputs.fields_container()
+        """  # noqa: E501
+        return self._fields_container