min_max_over_label_fc

class ansys.dpf.core.operators.min_max.min_max_over_label_fc.min_max_over_label_fc(fields_container=None, label=None, config=None, server=None)

Create two fields (0 min 1 max) by looping over the fields container in input and taking the min/max value by component through all the fields having the same id for the label set in input (in pin 1). If no label is specified or if the specified label doesn’t exist, the operation is done over all the fields. The fields out are located on the label set in input, so their scoping are the labels ids.For each min max value, the label id for one other fields container labels is kept and returned in a scoping in pin 2 (min) and 3 (max).The field’s scoping ids of the value kept in min max are also returned in the scopings in pin 4 (min) and 5 (max).

available inputs:
  • fields_container (FieldsContainer)

  • label (str)

available outputs:
  • field_min (Field)

  • field_max (Field)

  • domain_ids_min (Scoping)

  • domain_ids_max (Scoping)

  • scoping_ids_min (Scoping)

  • scoping_ids_max (Scoping)

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> # 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)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.min_max.min_max_over_label_fc(fields_container=my_fields_container,label=my_label)
>>> # Get output data
>>> result_field_min = op.outputs.field_min()
>>> result_field_max = op.outputs.field_max()
>>> result_domain_ids_min = op.outputs.domain_ids_min()
>>> result_domain_ids_max = op.outputs.domain_ids_max()
>>> result_scoping_ids_min = op.outputs.scoping_ids_min()
>>> result_scoping_ids_max = op.outputs.scoping_ids_max()
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

InputsMinMaxOverLabelFc

property outputs

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsMinMaxOverLabelFc

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.min_max.min_max_over_label_fc.InputsMinMaxOverLabelFc(op: ansys.dpf.core.dpf_operator.Operator)

Intermediate class used to connect user inputs to min_max_over_label_fc operator

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_label = str()
>>> op.inputs.label.connect(my_label)
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.min_max.min_max_over_label_fc()
>>> 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 name from the fields container

Parameters

my_label (str,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> op.inputs.label.connect(my_label)
>>> #or
>>> op.inputs.label(my_label)
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.min_max.min_max_over_label_fc.OutputsMinMaxOverLabelFc(op: ansys.dpf.core.dpf_operator.Operator)

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

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> # Connect inputs : op.inputs. ...
>>> result_field_min = op.outputs.field_min()
>>> result_field_max = op.outputs.field_max()
>>> result_domain_ids_min = op.outputs.domain_ids_min()
>>> result_domain_ids_max = op.outputs.domain_ids_max()
>>> result_scoping_ids_min = op.outputs.scoping_ids_min()
>>> result_scoping_ids_max = op.outputs.scoping_ids_max()
property field_min

Allows to get field_min output of the operator

Returns

my_field_min

Return type

Field,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> # Connect inputs : op.inputs. ...
>>> result_field_min = op.outputs.field_min()
property field_max

Allows to get field_max output of the operator

Returns

my_field_max

Return type

Field,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> # Connect inputs : op.inputs. ...
>>> result_field_max = op.outputs.field_max()
property domain_ids_min

Allows to get domain_ids_min output of the operator

Returns

my_domain_ids_min

Return type

Scoping,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> # Connect inputs : op.inputs. ...
>>> result_domain_ids_min = op.outputs.domain_ids_min()
property domain_ids_max

Allows to get domain_ids_max output of the operator

Returns

my_domain_ids_max

Return type

Scoping,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> # Connect inputs : op.inputs. ...
>>> result_domain_ids_max = op.outputs.domain_ids_max()
property scoping_ids_min

Allows to get scoping_ids_min output of the operator

Returns

my_scoping_ids_min

Return type

Scoping,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> # Connect inputs : op.inputs. ...
>>> result_scoping_ids_min = op.outputs.scoping_ids_min()
property scoping_ids_max

Allows to get scoping_ids_max output of the operator

Returns

my_scoping_ids_max

Return type

Scoping,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_over_label_fc()
>>> # Connect inputs : op.inputs. ...
>>> result_scoping_ids_max = op.outputs.scoping_ids_max()