included_fields

class ansys.dpf.core.operators.logic.included_fields.included_fields(fieldA=None, fieldB=None, double_value=None, double_tolerance=None, config=None, server=None)

Check if one field belongs to another.

available inputs:
  • fieldA (Field)

  • fieldB (Field)

  • double_value (float)

  • double_tolerance (float) (optional)

available outputs:
  • included (bool)

  • message (str)

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.logic.included_fields()
>>> # Make input connections
>>> my_fieldA = dpf.Field()
>>> op.inputs.fieldA.connect(my_fieldA)
>>> my_fieldB = dpf.Field()
>>> op.inputs.fieldB.connect(my_fieldB)
>>> my_double_value = float()
>>> op.inputs.double_value.connect(my_double_value)
>>> my_double_tolerance = float()
>>> op.inputs.double_tolerance.connect(my_double_tolerance)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.logic.included_fields(fieldA=my_fieldA,fieldB=my_fieldB,double_value=my_double_value,double_tolerance=my_double_tolerance)
>>> # Get output data
>>> result_included = op.outputs.included()
>>> result_message = op.outputs.message()
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

InputsIncludedFields

property outputs

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsIncludedFields

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

Intermediate class used to connect user inputs to included_fields operator

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.included_fields()
>>> my_fieldA = dpf.Field()
>>> op.inputs.fieldA.connect(my_fieldA)
>>> my_fieldB = dpf.Field()
>>> op.inputs.fieldB.connect(my_fieldB)
>>> my_double_value = float()
>>> op.inputs.double_value.connect(my_double_value)
>>> my_double_tolerance = float()
>>> op.inputs.double_tolerance.connect(my_double_tolerance)
property fieldA

Allows to connect fieldA input to the operator

Parameters

my_fieldA (Field,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.included_fields()
>>> op.inputs.fieldA.connect(my_fieldA)
>>> #or
>>> op.inputs.fieldA(my_fieldA)
property fieldB

Allows to connect fieldB input to the operator

Parameters

my_fieldB (Field,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.included_fields()
>>> op.inputs.fieldB.connect(my_fieldB)
>>> #or
>>> op.inputs.fieldB(my_fieldB)
property double_value

Allows to connect double_value input to the operator

  • pindoc: Double positive small value. Smallest value which will be considered during the comparison step: all the abs(values) in field less than this value is considered as null, (default value:1.0e-14).

Parameters

my_double_value (float,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.included_fields()
>>> op.inputs.double_value.connect(my_double_value)
>>> #or
>>> op.inputs.double_value(my_double_value)
property double_tolerance

Allows to connect double_tolerance input to the operator

  • pindoc: Double relative tolerance. Maximum tolerance gap between to compared values: values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001).

Parameters

my_double_tolerance (float,) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.included_fields()
>>> op.inputs.double_tolerance.connect(my_double_tolerance)
>>> #or
>>> op.inputs.double_tolerance(my_double_tolerance)
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.included_fields.OutputsIncludedFields(op: ansys.dpf.core.dpf_operator.Operator)

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

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.included_fields()
>>> # Connect inputs : op.inputs. ...
>>> result_included = op.outputs.included()
>>> result_message = op.outputs.message()
property included

Allows to get included output of the operator

  • pindoc: bool (true if belongs…)

Returns

my_included

Return type

bool,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.included_fields()
>>> # Connect inputs : op.inputs. ...
>>> result_included = op.outputs.included()
property message

Allows to get message output of the operator

Returns

my_message

Return type

str,

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.logic.included_fields()
>>> # Connect inputs : op.inputs. ...
>>> result_message = op.outputs.message()