InputsOverlapFields

class ansys.dpf.core.operators.utility.overlap_fields.InputsOverlapFields(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to overlap_fields operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.overlap_fields()
>>> my_base_field = dpf.Field()
>>> op.inputs.base_field.connect(my_base_field)
>>> my_overlapping_field = dpf.Field()
>>> op.inputs.overlapping_field.connect(my_overlapping_field)

Overview

Methods

connect

Connect any input (an entity or an operator output) to any input pin of this operator.

Properties

base_field	Allows to connect base_field input to the operator.
overlapping_field	Allows to connect overlapping_field input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.overlap_fields import InputsOverlapFields

Property detail

property InputsOverlapFields.base_field: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field]

Allows to connect base_field input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.overlap_fields()
>>> op.inputs.base_field.connect(my_base_field)
>>> # or
>>> op.inputs.base_field(my_base_field)

property InputsOverlapFields.overlapping_field: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field]

Allows to connect overlapping_field input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.overlap_fields()
>>> op.inputs.overlapping_field.connect(my_overlapping_field)
>>> # or
>>> op.inputs.overlapping_field(my_overlapping_field)

Method detail

InputsOverlapFields.__str__()

InputsOverlapFields.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.

Deprecated since version Deprecated: in favor of explicit output-to-input connections.

InputsOverlapFields.__call__(inpt)

InputsOverlapFields.__getitem__(item) → Input