skin#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.mesh.skin.skin(mesh=None, mesh_scoping=None, duplicate_shell=None, add_beam=None, config=None, server=None)#

Extracts a skin of the mesh in a new meshed region. The material ID of initial elements are propagated to their facets.

Parameters:

mesh (MeshedRegion) –
mesh_scoping (Scoping, optional) – Nodal scoping to restrict the skin extraction to a set of nodes. if provided, a skin element is added to the skin mesh if all its nodes are in the scoping.
duplicate_shell (bool, optional) – If input mesh contains shell elements, output mesh shell elements (boolean = 1) are duplicated, one per each orientation, or (boolean = 0) remain unchanged.
add_beam (bool, optional) – If input mesh contains beam elements, output mesh beam elements (boolean = 1) are added or (boolean = 0) are ignored.

Returns:

mesh (MeshedRegion) – Skin meshed region with facets and facets_to_ele property fields.
nodes_mesh_scoping (Scoping)
map_new_elements_to_old
property_field_new_elements_to_old (PropertyField) – This property field provides, for each new face element id (in the scoping), the corresponding 3d volume element index (in the data) it has been extracted from. the 3d volume element id can be found with the element scoping of the input mesh.
facet_indices (PropertyField) – This property field gives, for each new face element id (in the scoping), the corresponding face index on the source 3d volume element. the 3d volume element can be extracted from the previous output.

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.mesh.skin()

>>> # 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)
>>> my_duplicate_shell = bool()
>>> op.inputs.duplicate_shell.connect(my_duplicate_shell)
>>> my_add_beam = bool()
>>> op.inputs.add_beam.connect(my_add_beam)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.mesh.skin(
...     mesh=my_mesh,
...     mesh_scoping=my_mesh_scoping,
...     duplicate_shell=my_duplicate_shell,
...     add_beam=my_add_beam,
... )

>>> # Get output data
>>> result_mesh = op.outputs.mesh()
>>> result_nodes_mesh_scoping = op.outputs.nodes_mesh_scoping()
>>> result_map_new_elements_to_old = op.outputs.map_new_elements_to_old()
>>> result_property_field_new_elements_to_old = op.outputs.property_field_new_elements_to_old()
>>> result_facet_indices = op.outputs.facet_indices()

static 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.

property inputs#

Enables to connect inputs to the operator

Returns:: inputs
Return type:: InputsSkin

property outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsSkin

property config#

Copy of the operator’s current configuration.

You can modify the copy of the configuration and then use operator.config = new_config or instantiate an operator with the new configuration as a parameter.

For information on an operator’s options, see the documentation for that operator.

Returns:: Copy of the operator’s current configuration.
Return type:: ansys.dpf.core.config.Config

Examples

Modify the copy of an operator’s configuration and set it as current config of the operator.

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.add()
>>> config_add = op.config
>>> config_add.set_work_by_index_option(True)
>>> op.config = config_add

connect(pin, inpt, pin_out=0)#

Connect an input on the operator using a pin number.

Parameters:

pin (int) – Number of the input pin.
inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer – Operator, os.PathLike Object to connect to.
MeshedRegion – Operator, os.PathLike Object to connect to.
MeshesContainer – Operator, os.PathLike Object to connect to.
DataSources – Operator, os.PathLike Object to connect to.
CyclicSupport – Operator, os.PathLike Object to connect to.
dict – Operator, os.PathLike Object to connect to.
Outputs – Operator, os.PathLike Object to connect to.
pin_out (int, optional) – If the input is an operator, the output pin of the input operator. The default is 0.

Examples

Compute the minimum of displacement by chaining the "U" and "min_max_fc" operators.

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> max_fc_op = dpf.operators.min_max.min_max_fc()
>>> max_fc_op.inputs.connect(disp_op.outputs)
>>> max_field = max_fc_op.outputs.field_max()
>>> max_field.data
DPFArray([[0.59428386, 0.00201751, 0.0006032 ]]...

connect_operator_as_input(pin, op)#: Connects an operator as an input on a pin. :type pin: :param pin: Number of the output pin. The default is 0. :type pin: int :type op: :param op: Requested type of the output. The default is None. :type op: ansys.dpf.core.dpf_operator.Operator

eval(pin=None)#

Evaluate this operator.

Parameters:: pin (int) – Number of the output pin. The default is None.
Returns:: output – Returns the first output of the operator by default and the output of a given pin when specified. Or, it only evaluates the operator without output.
Return type:: FieldsContainer, Field, MeshedRegion, Scoping

Examples

Use the eval method.

>>> from ansys.dpf import core as dpf
>>> import ansys.dpf.core.operators.math as math
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> normfc = math.norm_fc(disp_op).eval()

get_output(pin=0, output_type=None)#

Retrieve the output of the operator on the pin number.

To activate the progress bar for server version higher or equal to 3.0, use my_op.progress_bar=True

Parameters:

pin (int, optional) – Number of the output pin. The default is 0.
output_type (ansys.dpf.core.common.types, type, optional) – Requested type of the output. The default is None.

Returns:

Output of the operator.

Return type:

type

static operator_specification(op_name, server=None)#: Documents an Operator with its description (what the Operator does), its inputs and outputs and some properties

property progress_bar: bool#: With this property, the user can choose to print a progress bar when the operator’s output is requested, default is False

run()#: Evaluate this operator.

property specification#

Returns the Specification (or documentation) of this Operator

Return type:: Specification

class ansys.dpf.core.operators.mesh.skin.InputsSkin(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to skin operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_duplicate_shell = bool()
>>> op.inputs.duplicate_shell.connect(my_duplicate_shell)
>>> my_add_beam = bool()
>>> op.inputs.add_beam.connect(my_add_beam)

property mesh#

Allows to connect mesh input to the operator.

Parameters:: my_mesh (MeshedRegion) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> op.inputs.mesh.connect(my_mesh)
>>> # or
>>> op.inputs.mesh(my_mesh)

property mesh_scoping#

Allows to connect mesh_scoping input to the operator.

Nodal scoping to restrict the skin extraction to a set of nodes. if provided, a skin element is added to the skin mesh if all its nodes are in the scoping.

Parameters:: my_mesh_scoping (Scoping) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)

property duplicate_shell#

Allows to connect duplicate_shell input to the operator.

If input mesh contains shell elements, output mesh shell elements (boolean = 1) are duplicated, one per each orientation, or (boolean = 0) remain unchanged.

Parameters:: my_duplicate_shell (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> op.inputs.duplicate_shell.connect(my_duplicate_shell)
>>> # or
>>> op.inputs.duplicate_shell(my_duplicate_shell)

property add_beam#

Allows to connect add_beam input to the operator.

If input mesh contains beam elements, output mesh beam elements (boolean = 1) are added or (boolean = 0) are ignored.

Parameters:: my_add_beam (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> op.inputs.add_beam.connect(my_add_beam)
>>> # or
>>> op.inputs.add_beam(my_add_beam)

connect(inpt)#

Connect any input (an entity or an operator output) to any input pin of this operator. Searches for the input type corresponding to the output.

Parameters:

inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer (E501) – Input of the operator.
MeshedRegion (E501) – Input of the operator.
MeshesContainer (E501) – Input of the operator.
DataSources (E501) – Input of the operator.
CyclicSupport (E501) – Input of the operator.
Outputs (E501) – Input of the operator.
noqa (os.PathLike #) – Input of the operator.

class ansys.dpf.core.operators.mesh.skin.OutputsSkin(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from skin operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> # Connect inputs : op.inputs. ...
>>> result_mesh = op.outputs.mesh()
>>> result_nodes_mesh_scoping = op.outputs.nodes_mesh_scoping()
>>> result_map_new_elements_to_old = op.outputs.map_new_elements_to_old()
>>> result_property_field_new_elements_to_old = op.outputs.property_field_new_elements_to_old()
>>> result_facet_indices = op.outputs.facet_indices()

property mesh#

Allows to get mesh output of the operator

Returns:: my_mesh
Return type:: MeshedRegion

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> # Connect inputs : op.inputs. ...
>>> result_mesh = op.outputs.mesh()

property nodes_mesh_scoping#

Allows to get nodes_mesh_scoping output of the operator

Returns:: my_nodes_mesh_scoping
Return type:: Scoping

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> # Connect inputs : op.inputs. ...
>>> result_nodes_mesh_scoping = op.outputs.nodes_mesh_scoping()

property map_new_elements_to_old#

Allows to get map_new_elements_to_old output of the operator

Return type:: my_map_new_elements_to_old

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> # Connect inputs : op.inputs. ...
>>> result_map_new_elements_to_old = op.outputs.map_new_elements_to_old()

property property_field_new_elements_to_old#

Allows to get property_field_new_elements_to_old output of the operator

Returns:: my_property_field_new_elements_to_old
Return type:: PropertyField

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> # Connect inputs : op.inputs. ...
>>> result_property_field_new_elements_to_old = op.outputs.property_field_new_elements_to_old()

property facet_indices#

Allows to get facet_indices output of the operator

Returns:: my_facet_indices
Return type:: PropertyField

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.skin()
>>> # Connect inputs : op.inputs. ...
>>> result_facet_indices = op.outputs.facet_indices()