merge_meshes#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.utility.merge_meshes.merge_meshes(naive_merge_elements=None, should_merge_named_selections=None, meshes1=None, meshes2=None, merge_method=None, box_size=None, remove_duplicate_elements=None, config=None, server=None)#

Take a set of mesh and assemble them in a unique one

Parameters:

  • naive_merge_elements (bool, optional) – If true, merge the elemental property fields of the input meshes assuming that there is no repetition in their scoping ids. default is false.

  • should_merge_named_selections (bool, optional) – For certain types of files (such as rst), scoping from names selection does not need to be merged.if this pin is true, the merge occurs. if this pin is false, the merge does not occur. default is true.

  • meshes1 (MeshedRegion) – A vector of meshed region to merge or meshed region from pin 0 to …

  • meshes2 (MeshedRegion) – A vector of meshed region to merge or meshed region from pin 0 to …

  • merge_method (int, optional) – 0: merge by distance, 1: merge by node id (default)

  • box_size (float, optional) – Box size used when merging by distance. default value is 1e-12.

  • remove_duplicate_elements (int, optional) – 0: keep duplicate elements (default), 1: remove duplicate elements

Returns:

merges_mesh

Return type:

MeshedRegion

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.utility.merge_meshes()

>>> # Make input connections
>>> my_naive_merge_elements = bool()
>>> op.inputs.naive_merge_elements.connect(my_naive_merge_elements)
>>> my_should_merge_named_selections = bool()
>>> op.inputs.should_merge_named_selections.connect(my_should_merge_named_selections)
>>> my_meshes1 = dpf.MeshedRegion()
>>> op.inputs.meshes1.connect(my_meshes1)
>>> my_meshes2 = dpf.MeshedRegion()
>>> op.inputs.meshes2.connect(my_meshes2)
>>> my_merge_method = int()
>>> op.inputs.merge_method.connect(my_merge_method)
>>> my_box_size = float()
>>> op.inputs.box_size.connect(my_box_size)
>>> my_remove_duplicate_elements = int()
>>> op.inputs.remove_duplicate_elements.connect(my_remove_duplicate_elements)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.utility.merge_meshes(
...     naive_merge_elements=my_naive_merge_elements,
...     should_merge_named_selections=my_should_merge_named_selections,
...     meshes1=my_meshes1,
...     meshes2=my_meshes2,
...     merge_method=my_merge_method,
...     box_size=my_box_size,
...     remove_duplicate_elements=my_remove_duplicate_elements,
... )

>>> # Get output data
>>> result_merges_mesh = op.outputs.merges_mesh()
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:

InputsMergeMeshes

property outputs#

Enables to get outputs of the operator by evaluating it

Returns:

outputs

Return type:

OutputsMergeMeshes

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.utility.merge_meshes.InputsMergeMeshes(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to merge_meshes operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> my_naive_merge_elements = bool()
>>> op.inputs.naive_merge_elements.connect(my_naive_merge_elements)
>>> my_should_merge_named_selections = bool()
>>> op.inputs.should_merge_named_selections.connect(my_should_merge_named_selections)
>>> my_meshes1 = dpf.MeshedRegion()
>>> op.inputs.meshes1.connect(my_meshes1)
>>> my_meshes2 = dpf.MeshedRegion()
>>> op.inputs.meshes2.connect(my_meshes2)
>>> my_merge_method = int()
>>> op.inputs.merge_method.connect(my_merge_method)
>>> my_box_size = float()
>>> op.inputs.box_size.connect(my_box_size)
>>> my_remove_duplicate_elements = int()
>>> op.inputs.remove_duplicate_elements.connect(my_remove_duplicate_elements)
property naive_merge_elements#

Allows to connect naive_merge_elements input to the operator.

If true, merge the elemental property fields of the input meshes assuming that there is no repetition in their scoping ids. default is false.

Parameters:

my_naive_merge_elements (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> op.inputs.naive_merge_elements.connect(my_naive_merge_elements)
>>> # or
>>> op.inputs.naive_merge_elements(my_naive_merge_elements)
property should_merge_named_selections#

Allows to connect should_merge_named_selections input to the operator.

For certain types of files (such as rst), scoping from names selection does not need to be merged.if this pin is true, the merge occurs. if this pin is false, the merge does not occur. default is true.

Parameters:

my_should_merge_named_selections (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> op.inputs.should_merge_named_selections.connect(my_should_merge_named_selections)
>>> # or
>>> op.inputs.should_merge_named_selections(my_should_merge_named_selections)
property meshes1#

Allows to connect meshes1 input to the operator.

A vector of meshed region to merge or meshed region from pin 0 to …

Parameters:

my_meshes1 (MeshedRegion) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> op.inputs.meshes1.connect(my_meshes1)
>>> # or
>>> op.inputs.meshes1(my_meshes1)
property meshes2#

Allows to connect meshes2 input to the operator.

A vector of meshed region to merge or meshed region from pin 0 to …

Parameters:

my_meshes2 (MeshedRegion) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> op.inputs.meshes2.connect(my_meshes2)
>>> # or
>>> op.inputs.meshes2(my_meshes2)
property merge_method#

Allows to connect merge_method input to the operator.

0: merge by distance, 1: merge by node id (default)

Parameters:

my_merge_method (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> op.inputs.merge_method.connect(my_merge_method)
>>> # or
>>> op.inputs.merge_method(my_merge_method)
property box_size#

Allows to connect box_size input to the operator.

Box size used when merging by distance. default value is 1e-12.

Parameters:

my_box_size (float) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> op.inputs.box_size.connect(my_box_size)
>>> # or
>>> op.inputs.box_size(my_box_size)
property remove_duplicate_elements#

Allows to connect remove_duplicate_elements input to the operator.

0: keep duplicate elements (default), 1: remove duplicate elements

Parameters:

my_remove_duplicate_elements (int) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> op.inputs.remove_duplicate_elements.connect(my_remove_duplicate_elements)
>>> # or
>>> op.inputs.remove_duplicate_elements(my_remove_duplicate_elements)
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.utility.merge_meshes.OutputsMergeMeshes(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from merge_meshes operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> # Connect inputs : op.inputs. ...
>>> result_merges_mesh = op.outputs.merges_mesh()
property merges_mesh#

Allows to get merges_mesh output of the operator

Returns:

my_merges_mesh

Return type:

MeshedRegion

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_meshes()
>>> # Connect inputs : op.inputs. ...
>>> result_merges_mesh = op.outputs.merges_mesh()