min_max_inc

class ansys.dpf.core.operators.min_max.min_max_inc.min_max_inc(field=None, domain_id=None, config=None, server=None)

Compute the component-wise minimum (out 0) and maximum (out 1) over coming fields.

available inputs:
  • field (Field)

  • domain_id (int) (optional)

available outputs:
  • field_min (Field)

  • field_max (Field)

  • domain_ids_min (Scoping)

  • domain_ids_max (Scoping)

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.min_max.min_max_inc()
>>> # Make input connections
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_domain_id = int()
>>> op.inputs.domain_id.connect(my_domain_id)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.min_max.min_max_inc(field=my_field,domain_id=my_domain_id)
>>> # 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()
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

InputsMinMaxInc

property outputs

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsMinMaxInc

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

Intermediate class used to connect user inputs to min_max_inc operator

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_inc()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_domain_id = int()
>>> op.inputs.domain_id.connect(my_domain_id)
property field

Allows to connect field input to the operator

Parameters

my_field (Field,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_inc()
>>> op.inputs.field.connect(my_field)
>>> #or
>>> op.inputs.field(my_field)
property domain_id

Allows to connect domain_id input to the operator

Parameters

my_domain_id (int,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_inc()
>>> op.inputs.domain_id.connect(my_domain_id)
>>> #or
>>> op.inputs.domain_id(my_domain_id)
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_inc.OutputsMinMaxInc(op: ansys.dpf.core.dpf_operator.Operator)

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

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.min_max.min_max_inc()
>>> # 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()
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_inc()
>>> # 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_inc()
>>> # 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_inc()
>>> # 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_inc()
>>> # Connect inputs : op.inputs. ...
>>> result_domain_ids_max = op.outputs.domain_ids_max()