merge_fields#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.utility.merge_fields.merge_fields(sum_merge=None, merged_support=None, fields1=None, fields2=None, config=None, server=None)#

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

Parameters
  • sum_merge (bool, optional) – Default is false. if true redundant quantities are summed instead of being ignored.

  • merged_support (AbstractFieldSupport, optional) – Already merged field support.

  • fields1 (Field) – A vector of fields to merge or fields from pin 0 to …

  • fields2 (Field) – A vector of fields to merge or fields from pin 0 to …

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.utility.merge_fields()
>>> # Make input connections
>>> my_sum_merge = bool()
>>> op.inputs.sum_merge.connect(my_sum_merge)
>>> my_merged_support = dpf.AbstractFieldSupport()
>>> op.inputs.merged_support.connect(my_merged_support)
>>> my_fields1 = dpf.Field()
>>> op.inputs.fields1.connect(my_fields1)
>>> my_fields2 = dpf.Field()
>>> op.inputs.fields2.connect(my_fields2)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.utility.merge_fields(
...     sum_merge=my_sum_merge,
...     merged_support=my_merged_support,
...     fields1=my_fields1,
...     fields2=my_fields2,
... )
>>> # Get output data
>>> result_merged_field = op.outputs.merged_field()
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 the global server.

property inputs#

Enables to connect inputs to the operator

Returns

inputs

Return type

InputsMergeFields

property outputs#

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsMergeFields

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 of int, list of doubles,) –

    Field, FieldsContainer, Scoping, ScopingsContainer, MeshedRegion,

    MeshesContainer, DataSources, 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
array([[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, 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)#

Put the grpc spec message in self._spec

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.

class ansys.dpf.core.operators.utility.merge_fields.InputsMergeFields(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to merge_fields operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> my_sum_merge = bool()
>>> op.inputs.sum_merge.connect(my_sum_merge)
>>> my_merged_support = dpf.AbstractFieldSupport()
>>> op.inputs.merged_support.connect(my_merged_support)
>>> my_fields1 = dpf.Field()
>>> op.inputs.fields1.connect(my_fields1)
>>> my_fields2 = dpf.Field()
>>> op.inputs.fields2.connect(my_fields2)
property sum_merge#

Allows to connect sum_merge input to the operator.

Default is false. if true redundant quantities are summed instead of being ignored.

Parameters

my_sum_merge (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> op.inputs.sum_merge.connect(my_sum_merge)
>>> # or
>>> op.inputs.sum_merge(my_sum_merge)
property merged_support#

Allows to connect merged_support input to the operator.

Already merged field support.

Parameters

my_merged_support (AbstractFieldSupport) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> op.inputs.merged_support.connect(my_merged_support)
>>> # or
>>> op.inputs.merged_support(my_merged_support)
property fields1#

Allows to connect fields1 input to the operator.

A vector of fields to merge or fields from pin 0 to …

Parameters

my_fields1 (Field) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> op.inputs.fields1.connect(my_fields1)
>>> # or
>>> op.inputs.fields1(my_fields1)
property fields2#

Allows to connect fields2 input to the operator.

A vector of fields to merge or fields from pin 0 to …

Parameters

my_fields2 (Field) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> op.inputs.fields2.connect(my_fields2)
>>> # or
>>> op.inputs.fields2(my_fields2)
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, Field, FieldsContainer, Scoping,) –

DataSources, MeshedRegion, ScopingsContainer, CyclicSupport,

…, Output, Outputs, Operator, os.PathLike

Input of the operator.

class ansys.dpf.core.operators.utility.merge_fields.OutputsMergeFields(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from merge_fields operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> # Connect inputs : op.inputs. ...
>>> result_merged_field = op.outputs.merged_field()
property merged_field#

Allows to get merged_field output of the operator

Returns

my_merged_field

Return type

Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> # Connect inputs : op.inputs. ...
>>> result_merged_field = op.outputs.merged_field()