Skip to content

Commit

Permalink
Update generated code for DPF 251_test on master (#1641)
Browse files Browse the repository at this point in the history
* update generated code

* Update collection_grpcapi.py
  • Loading branch information
pyansys-ci-bot authored Jun 28, 2024
1 parent 9e31a5b commit a36f1f8
Show file tree
Hide file tree
Showing 15 changed files with 570 additions and 70 deletions.
8 changes: 4 additions & 4 deletions doc/source/_static/dpf_operators.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions src/ansys/dpf/core/operators/mesh/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
from .mesh_to_graphics_edges import mesh_to_graphics_edges
from .mesh_to_pyvista import mesh_to_pyvista
from .mesh_to_tetra import mesh_to_tetra
from .meshed_edges_extractors import meshed_edges_extractors
from .meshes_provider import meshes_provider
from .node_coordinates import node_coordinates
from .points_from_coordinates import points_from_coordinates
Expand Down
220 changes: 220 additions & 0 deletions src/ansys/dpf/core/operators/mesh/meshed_edges_extractors.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
"""
meshed_edges_extractors
=======================
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 meshed_edges_extractors(Operator):
"""Build meshed edges from a scoping of points.
Parameters
----------
mesh : MeshedRegion
mesh_scoping : Scoping
Nodal scoping of nodes that define the
extracted edge.
Examples
--------
>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.mesh.meshed_edges_extractors()
>>> # Make input connections
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.mesh.meshed_edges_extractors(
... mesh=my_mesh,
... mesh_scoping=my_mesh_scoping,
... )
>>> # Get output data
>>> result_mesh = op.outputs.mesh()
"""

def __init__(self, mesh=None, mesh_scoping=None, config=None, server=None):
super().__init__(name="meshed_edges_extractor", config=config, server=server)
self._inputs = InputsMeshedEdgesExtractors(self)
self._outputs = OutputsMeshedEdgesExtractors(self)
if mesh is not None:
self.inputs.mesh.connect(mesh)
if mesh_scoping is not None:
self.inputs.mesh_scoping.connect(mesh_scoping)

@staticmethod
def _spec():
description = """Build meshed edges from a scoping of points."""
spec = Specification(
description=description,
map_input_pin_spec={
0: PinSpecification(
name="mesh",
type_names=["abstract_meshed_region"],
optional=False,
document="""""",
),
1: PinSpecification(
name="mesh_scoping",
type_names=["scoping"],
optional=False,
document="""Nodal scoping of nodes that define the
extracted edge.""",
),
},
map_output_pin_spec={
0: PinSpecification(
name="mesh",
type_names=["abstract_meshed_region"],
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="meshed_edges_extractor", server=server)

@property
def inputs(self):
"""Enables to connect inputs to the operator
Returns
--------
inputs : InputsMeshedEdgesExtractors
"""
return super().inputs

@property
def outputs(self):
"""Enables to get outputs of the operator by evaluating it
Returns
--------
outputs : OutputsMeshedEdgesExtractors
"""
return super().outputs


class InputsMeshedEdgesExtractors(_Inputs):
"""Intermediate class used to connect user inputs to
meshed_edges_extractors operator.
Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.meshed_edges_extractors()
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
"""

def __init__(self, op: Operator):
super().__init__(meshed_edges_extractors._spec().inputs, op)
self._mesh = Input(meshed_edges_extractors._spec().input_pin(0), 0, op, -1)
self._inputs.append(self._mesh)
self._mesh_scoping = Input(
meshed_edges_extractors._spec().input_pin(1), 1, op, -1
)
self._inputs.append(self._mesh_scoping)

@property
def mesh(self):
"""Allows to connect mesh input to the operator.
Parameters
----------
my_mesh : MeshedRegion
Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.meshed_edges_extractors()
>>> op.inputs.mesh.connect(my_mesh)
>>> # or
>>> op.inputs.mesh(my_mesh)
"""
return self._mesh

@property
def mesh_scoping(self):
"""Allows to connect mesh_scoping input to the operator.
Nodal scoping of nodes that define the
extracted edge.
Parameters
----------
my_mesh_scoping : Scoping
Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.meshed_edges_extractors()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)
"""
return self._mesh_scoping


class OutputsMeshedEdgesExtractors(_Outputs):
"""Intermediate class used to get outputs from
meshed_edges_extractors operator.
Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.meshed_edges_extractors()
>>> # Connect inputs : op.inputs. ...
>>> result_mesh = op.outputs.mesh()
"""

def __init__(self, op: Operator):
super().__init__(meshed_edges_extractors._spec().outputs, op)
self._mesh = Output(meshed_edges_extractors._spec().output_pin(0), 0, op)
self._outputs.append(self._mesh)

@property
def mesh(self):
"""Allows to get mesh output of the operator
Returns
----------
my_mesh : MeshedRegion
Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.meshed_edges_extractors()
>>> # Connect inputs : op.inputs. ...
>>> result_mesh = op.outputs.mesh()
""" # noqa: E501
return self._mesh
1 change: 1 addition & 0 deletions src/ansys/dpf/core/operators/utility/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
from .make_overall import make_overall
from .make_producer_consumer_for_each_iterator import make_producer_consumer_for_each_iterator
from .merge_any import merge_any
from .merge_collections import merge_collections
from .merge_data_tree import merge_data_tree
from .merge_fields import merge_fields
from .merge_fields_by_label import merge_fields_by_label
Expand Down
47 changes: 24 additions & 23 deletions src/ansys/dpf/core/operators/utility/field_get_attribute.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,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


Expand All @@ -19,7 +20,8 @@ class field_get_attribute(Operator):
----------
field : Field
property_name : str
Accepted inputs are: 'time_freq_support'.
Accepted inputs are: 'time_freq_support' and
'scoping'.
Examples
Expand Down Expand Up @@ -71,13 +73,14 @@ def _spec():
name="property_name",
type_names=["string"],
optional=False,
document="""Accepted inputs are: 'time_freq_support'.""",
document="""Accepted inputs are: 'time_freq_support' and
'scoping'.""",
),
},
map_output_pin_spec={
0: PinSpecification(
name="property",
type_names=["time_freq_support"],
type_names=["time_freq_support", "scoping"],
optional=False,
document="""Property value.""",
),
Expand Down Expand Up @@ -165,7 +168,8 @@ def field(self):
def property_name(self):
"""Allows to connect property_name input to the operator.
Accepted inputs are: 'time_freq_support'.
Accepted inputs are: 'time_freq_support' and
'scoping'.
Parameters
----------
Expand Down Expand Up @@ -196,22 +200,19 @@ class OutputsFieldGetAttribute(_Outputs):

def __init__(self, op: Operator):
super().__init__(field_get_attribute._spec().outputs, op)
self._property = Output(field_get_attribute._spec().output_pin(0), 0, op)
self._outputs.append(self._property)

@property
def property(self):
"""Allows to get property output of the operator
Returns
----------
my_property : TimeFreqSupport
Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.field_get_attribute()
>>> # Connect inputs : op.inputs. ...
>>> result_property = op.outputs.property()
""" # noqa: E501
return self._property
self.property_as_time_freq_support = Output(
_modify_output_spec_with_one_type(
field_get_attribute._spec().output_pin(0), "time_freq_support"
),
0,
op,
)
self._outputs.append(self.property_as_time_freq_support)
self.property_as_scoping = Output(
_modify_output_spec_with_one_type(
field_get_attribute._spec().output_pin(0), "scoping"
),
0,
op,
)
self._outputs.append(self.property_as_scoping)
Loading

0 comments on commit a36f1f8

Please sign in to comment.