on_coordinates#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates(fields_container=None, coordinates=None, create_support=None, mapping_on_scoping=None, mesh=None, use_quadratic_elements=None, config=None, server=None)#

Evaluates a result on specified coordinates (interpolates results inside elements with shape functions).

Parameters:

fields_container (FieldsContainer) –
coordinates (Field or FieldsContainer or MeshedRegion or MeshesContainer) –
create_support (bool, optional) – If this pin is set to true, then, a support associated to the fields consisting of points is created
mapping_on_scoping (bool, optional) – If this pin is set to true, then the mapping between the coordinates and the fields is created only on the first field scoping
mesh (MeshedRegion or MeshesContainer, optional) – If the first field in input has no mesh in support, then the mesh in this pin is expected (default is false), if a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container
use_quadratic_elements (bool, optional) – If this pin is set to true, the element search for each coordinate is computed on the quadratic element if the element is quadratic (more precise but less performant). default is false.

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.mapping.on_coordinates()

>>> # Make input connections
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_coordinates = dpf.Field()
>>> op.inputs.coordinates.connect(my_coordinates)
>>> my_create_support = bool()
>>> op.inputs.create_support.connect(my_create_support)
>>> my_mapping_on_scoping = bool()
>>> op.inputs.mapping_on_scoping.connect(my_mapping_on_scoping)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_use_quadratic_elements = bool()
>>> op.inputs.use_quadratic_elements.connect(my_use_quadratic_elements)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.mapping.on_coordinates(
...     fields_container=my_fields_container,
...     coordinates=my_coordinates,
...     create_support=my_create_support,
...     mapping_on_scoping=my_mapping_on_scoping,
...     mesh=my_mesh,
...     use_quadratic_elements=my_use_quadratic_elements,
... )

>>> # Get output data
>>> result_fields_container = op.outputs.fields_container()

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:: InputsOnCoordinates

property outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsOnCoordinates

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.mapping.on_coordinates.InputsOnCoordinates(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to on_coordinates operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.on_coordinates()
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_coordinates = dpf.Field()
>>> op.inputs.coordinates.connect(my_coordinates)
>>> my_create_support = bool()
>>> op.inputs.create_support.connect(my_create_support)
>>> my_mapping_on_scoping = bool()
>>> op.inputs.mapping_on_scoping.connect(my_mapping_on_scoping)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_use_quadratic_elements = bool()
>>> op.inputs.use_quadratic_elements.connect(my_use_quadratic_elements)

property fields_container#

Allows to connect fields_container input to the operator.

Parameters:: my_fields_container (FieldsContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.on_coordinates()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)

property coordinates#

Allows to connect coordinates input to the operator.

Parameters:: my_coordinates (Field or FieldsContainer or MeshedRegion or MeshesContainer) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.on_coordinates()
>>> op.inputs.coordinates.connect(my_coordinates)
>>> # or
>>> op.inputs.coordinates(my_coordinates)

property create_support#

Allows to connect create_support input to the operator.

If this pin is set to true, then, a support associated to the fields consisting of points is created

Parameters:: my_create_support (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.on_coordinates()
>>> op.inputs.create_support.connect(my_create_support)
>>> # or
>>> op.inputs.create_support(my_create_support)

property mapping_on_scoping#

Allows to connect mapping_on_scoping input to the operator.

If this pin is set to true, then the mapping between the coordinates and the fields is created only on the first field scoping

Parameters:: my_mapping_on_scoping (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.on_coordinates()
>>> op.inputs.mapping_on_scoping.connect(my_mapping_on_scoping)
>>> # or
>>> op.inputs.mapping_on_scoping(my_mapping_on_scoping)

property mesh#

Allows to connect mesh input to the operator.

If the first field in input has no mesh in support, then the mesh in this pin is expected (default is false), if a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container

Parameters:: my_mesh (MeshedRegion or MeshesContainer) –

Examples

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

property use_quadratic_elements#

Allows to connect use_quadratic_elements input to the operator.

If this pin is set to true, the element search for each coordinate is computed on the quadratic element if the element is quadratic (more precise but less performant). default is false.

Parameters:: my_use_quadratic_elements (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.on_coordinates()
>>> op.inputs.use_quadratic_elements.connect(my_use_quadratic_elements)
>>> # or
>>> op.inputs.use_quadratic_elements(my_use_quadratic_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.mapping.on_coordinates.OutputsOnCoordinates(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from on_coordinates operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.on_coordinates()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()

property fields_container#

Allows to get fields_container output of the operator

Returns:: my_fields_container
Return type:: FieldsContainer

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.on_coordinates()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()