merge_fields_by_label

class ansys.dpf.core.operators.logic.merge_fields_by_label.merge_fields_by_label(fields_container=None, label=None, merged_field_support=None, sumMerge=None, config=None, server=None)

Take a fields container and merge its fields that share the same label value.

available inputs:
  • fields_container (FieldsContainer)

  • label (str)

  • merged_field_support (AbstractFieldSupport) (optional)

  • sumMerge (bool) (optional)

available outputs:
  • fields_container (FieldsContainer)

  • merged_field_support (AbstractFieldSupport)

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.logic.merge_fields_by_label()
>>> # Make input connections
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_label = str()
>>> op.inputs.label.connect(my_label)
>>> my_merged_field_support = dpf.AbstractFieldSupport()
>>> op.inputs.merged_field_support.connect(my_merged_field_support)
>>> my_sumMerge = bool()
>>> op.inputs.sumMerge.connect(my_sumMerge)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.logic.merge_fields_by_label(fields_container=my_fields_container,label=my_label,merged_field_support=my_merged_field_support,sumMerge=my_sumMerge)
>>> # Get output data
>>> result_fields_container = op.outputs.fields_container()
>>> result_merged_field_support = op.outputs.merged_field_support()
static default_config()

Returns the default config for a given operator. This config can then be changed to the user needs and be used to instantiate the given operator

Parameters
  • name (str) – Name of the operator. For example ‘U’.

  • 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

InputsMergeFieldsByLabel

property outputs

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsMergeFieldsByLabel

property config

Returns a copy of the current config of the operator. To use the config that you modify, please use operator.config = new_config or create an operator with the new config as a parameter.

Returns

config

Return type

Config

connect(pin, inpt, pin_out=0)

Connect an input on the operator using a pin number.

Parameters

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 ]])
get_output(pin=0, output_type=None)

Returns the output of the operator on the pin number.

Parameters
  • pin (int, optional) – Number of the output pin.

  • output_type (core.type enum, optional) – The requested type of the output.

run()

Evaluate this operator

class ansys.dpf.core.operators.logic.merge_fields_by_label.InputsMergeFieldsByLabel(op: ansys.dpf.core.dpf_operator.Operator)

Intermediate class used to connect user inputs to merge_fields_by_label operator

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.merge_fields_by_label()
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_label = str()
>>> op.inputs.label.connect(my_label)
>>> my_merged_field_support = dpf.AbstractFieldSupport()
>>> op.inputs.merged_field_support.connect(my_merged_field_support)
>>> my_sumMerge = bool()
>>> op.inputs.sumMerge.connect(my_sumMerge)
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.logic.merge_fields_by_label()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> #or
>>> op.inputs.fields_container(my_fields_container)
property label

Allows to connect label input to the operator

  • pindoc: Label identifier that should be merged.

Parameters

my_label (str,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.merge_fields_by_label()
>>> op.inputs.label.connect(my_label)
>>> #or
>>> op.inputs.label(my_label)
property merged_field_support

Allows to connect merged_field_support input to the operator

  • pindoc: The FieldsContainer’s support that has already been merged.

Parameters

my_merged_field_support (AbstractFieldSupport,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.merge_fields_by_label()
>>> op.inputs.merged_field_support.connect(my_merged_field_support)
>>> #or
>>> op.inputs.merged_field_support(my_merged_field_support)
property sumMerge

Allows to connect sumMerge input to the operator

  • pindoc: Default is false. If true redundant quantities are summed instead of being ignored.

Parameters

my_sumMerge (bool,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.merge_fields_by_label()
>>> op.inputs.sumMerge.connect(my_sumMerge)
>>> #or
>>> op.inputs.sumMerge(my_sumMerge)
connect(inpt)

Allows you to connect any input (an entity or an operator output) to any input pin of this operator.

The matching input type corresponding to the output is looked for.

Parameters

inpt (str, int, double, Field, FieldsContainer, Scoping, DataSources, MeshedRegion, ScopingsContainer, CyclicSupport, ..., Output, Outputs, Operator) – input of the operator

class ansys.dpf.core.operators.logic.merge_fields_by_label.OutputsMergeFieldsByLabel(op: ansys.dpf.core.dpf_operator.Operator)

Intermediate class used to get outputs from merge_fields_by_label operator .. rubric:: Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.merge_fields_by_label()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()
>>> result_merged_field_support = op.outputs.merged_field_support()
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.logic.merge_fields_by_label()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()
property merged_field_support

Allows to get merged_field_support output of the operator

Returns

my_merged_field_support

Return type

AbstractFieldSupport,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.merge_fields_by_label()
>>> # Connect inputs : op.inputs. ...
>>> result_merged_field_support = op.outputs.merged_field_support()