InputsChangeLocation

class ansys.dpf.core.operators.utility.change_location.InputsChangeLocation(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to change_location operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.change_location()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_new_location = str()
>>> op.inputs.new_location.connect(my_new_location)

Overview

Methods

connect

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

Properties

field	Allows to connect field input to the operator.
new_location	Allows to connect new_location input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.change_location import InputsChangeLocation

Property detail

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

Allows to connect field input to the operator.

Field whose location will be changed

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.change_location()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)

property InputsChangeLocation.new_location: ansys.dpf.core.inputs.Input[str]

Allows to connect new_location input to the operator.

New location string for the field (e.g., ‘Nodal’, ‘ElementalNodal’, ‘Elemental’)

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.change_location()
>>> op.inputs.new_location.connect(my_new_location)
>>> # or
>>> op.inputs.new_location(my_new_location)

Method detail

InputsChangeLocation.__str__()

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

InputsChangeLocation.__call__(inpt)

InputsChangeLocation.__getitem__(item) → Input