point_cloud_search

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.mesh.point_cloud_search.point_cloud_search(search_domain=None, reference_domain=None, tolerance=None, exclusive_search=None, config=None, server=None)

For every node in the search domain, search the nearest node in the reference domain within tolerance. By default, the search is not exclusive (different nodes in the search domain can be assigned to the same node in the reference domain). By default, no tolerance is imposed (the nearest node is matched).

Parameters

• search_domain (Field or MeshedRegion) – Search domain

• reference_domain (Field or MeshedRegion) – Reference domain

• tolerance (float, optional) – Tolerance. default: no tolerance (match nearest)

• exclusive_search (bool, optional) – Make the search exclusive. default: false

Examples

>>> from ansys.dpf import core as dpf

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

>>> # Make input connections
>>> my_search_domain = dpf.Field()
>>> op.inputs.search_domain.connect(my_search_domain)
>>> my_reference_domain = dpf.Field()
>>> op.inputs.reference_domain.connect(my_reference_domain)
>>> my_tolerance = float()
>>> op.inputs.tolerance.connect(my_tolerance)
>>> my_exclusive_search = bool()
>>> op.inputs.exclusive_search.connect(my_exclusive_search)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.mesh.point_cloud_search(
...     search_domain=my_search_domain,
...     reference_domain=my_reference_domain,
...     tolerance=my_tolerance,
...     exclusive_search=my_exclusive_search,
... )

>>> # Get output data
>>> result_search_indices = op.outputs.search_indices()
>>> result_reference_indices = op.outputs.reference_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

InputsPointCloudSearch

property outputs

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsPointCloudSearch

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 create an operator with the new configuration as a parameter.

Returns

Copy of the operator’s current configuration.

Return type

ansys.dpf.core.config.Config

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.

• 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.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 ]]...

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.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.point_cloud_search.InputsPointCloudSearch(op: ansys.dpf.core.dpf_operator.Operator)

Intermediate class used to connect user inputs to point_cloud_search operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.point_cloud_search()
>>> my_search_domain = dpf.Field()
>>> op.inputs.search_domain.connect(my_search_domain)
>>> my_reference_domain = dpf.Field()
>>> op.inputs.reference_domain.connect(my_reference_domain)
>>> my_tolerance = float()
>>> op.inputs.tolerance.connect(my_tolerance)
>>> my_exclusive_search = bool()
>>> op.inputs.exclusive_search.connect(my_exclusive_search)

property search_domain

Allows to connect search_domain input to the operator.

Search domain

Parameters

my_search_domain (Field or MeshedRegion) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.point_cloud_search()
>>> op.inputs.search_domain.connect(my_search_domain)
>>> # or
>>> op.inputs.search_domain(my_search_domain)

property reference_domain

Allows to connect reference_domain input to the operator.

Reference domain

Parameters

my_reference_domain (Field or MeshedRegion) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.point_cloud_search()
>>> op.inputs.reference_domain.connect(my_reference_domain)
>>> # or
>>> op.inputs.reference_domain(my_reference_domain)

property tolerance

Allows to connect tolerance input to the operator.

Tolerance. default: no tolerance (match nearest)

Parameters

my_tolerance (float) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.point_cloud_search()
>>> op.inputs.tolerance.connect(my_tolerance)
>>> # or
>>> op.inputs.tolerance(my_tolerance)

property exclusive_search

Allows to connect exclusive_search input to the operator.

Make the search exclusive. default: false

Parameters

my_exclusive_search (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.point_cloud_search()
>>> op.inputs.exclusive_search.connect(my_exclusive_search)
>>> # or
>>> op.inputs.exclusive_search(my_exclusive_search)

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.point_cloud_search.OutputsPointCloudSearch(op: ansys.dpf.core.dpf_operator.Operator)

Intermediate class used to get outputs from point_cloud_search operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.point_cloud_search()
>>> # Connect inputs : op.inputs. ...
>>> result_search_indices = op.outputs.search_indices()
>>> result_reference_indices = op.outputs.reference_indices()

property search_indices

Allows to get search_indices output of the operator

Returns

my_search_indices

Return type

Scoping

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.point_cloud_search()
>>> # Connect inputs : op.inputs. ...
>>> result_search_indices = op.outputs.search_indices()

property reference_indices

Allows to get reference_indices output of the operator

Returns

my_reference_indices

Return type

Scoping

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.point_cloud_search()
>>> # Connect inputs : op.inputs. ...
>>> result_reference_indices = op.outputs.reference_indices()