InputsConcatenateFields

class ansys.dpf.core.operators.utility.concatenate_fields.InputsConcatenateFields(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to concatenate_fields operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.concatenate_fields()
>>> my_rescoping_value = float()
>>> op.inputs.rescoping_value.connect(my_rescoping_value)
>>> my_reference_scoping_index = int()
>>> op.inputs.reference_scoping_index.connect(my_reference_scoping_index)
>>> my_field_support = dpf.AbstractFieldSupport()
>>> op.inputs.field_support.connect(my_field_support)
>>> my_fields1 = dpf.()
>>> op.inputs.fields1.connect(my_fields1)
>>> my_fields2 = dpf.()
>>> op.inputs.fields2.connect(my_fields2)

Overview

Methods

connect

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

Properties

rescoping_value	Allows to connect rescoping_value input to the operator.
reference_scoping_index	Allows to connect reference_scoping_index input to the operator.
field_support	Allows to connect field_support input to the operator.
fields1	Allows to connect fields1 input to the operator.
fields2	Allows to connect fields2 input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.concatenate_fields import InputsConcatenateFields

Property detail

property InputsConcatenateFields.rescoping_value: ansys.dpf.core.inputs.Input[float]

Allows to connect rescoping_value input to the operator.

Value used to fill the missing values when scopings are different. Default is 0.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.concatenate_fields()
>>> op.inputs.rescoping_value.connect(my_rescoping_value)
>>> # or
>>> op.inputs.rescoping_value(my_rescoping_value)

property InputsConcatenateFields.reference_scoping_index: ansys.dpf.core.inputs.Input[int]

Allows to connect reference_scoping_index input to the operator.

Pin of the field of which to take the scoping for the output field. If -1 all scopings will be merged, if -2 all scopings will be intersected. Default is -1

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.concatenate_fields()
>>> op.inputs.reference_scoping_index.connect(my_reference_scoping_index)
>>> # or
>>> op.inputs.reference_scoping_index(my_reference_scoping_index)

property InputsConcatenateFields.field_support: ansys.dpf.core.inputs.Input

Allows to connect field_support input to the operator.

Support of the output field.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.concatenate_fields()
>>> op.inputs.field_support.connect(my_field_support)
>>> # or
>>> op.inputs.field_support(my_field_support)

property InputsConcatenateFields.fields1: ansys.dpf.core.inputs.Input

Allows to connect fields1 input to the operator.

A vector of fields to merge from pin 0 to …

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.concatenate_fields()
>>> op.inputs.fields1.connect(my_fields1)
>>> # or
>>> op.inputs.fields1(my_fields1)

property InputsConcatenateFields.fields2: ansys.dpf.core.inputs.Input

Allows to connect fields2 input to the operator.

A vector of fields to merge from pin 0 to …

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.concatenate_fields()
>>> op.inputs.fields2.connect(my_fields2)
>>> # or
>>> op.inputs.fields2(my_fields2)

Method detail

InputsConcatenateFields.__str__()

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

InputsConcatenateFields.__call__(inpt)

InputsConcatenateFields.__getitem__(item) → Input