InputsIntsToScoping#

class ansys.dpf.core.operators.utility.ints_to_scoping.InputsIntsToScoping(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to ints_to_scoping operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.ints_to_scoping()
>>> my_ids = int()
>>> op.inputs.ids.connect(my_ids)
>>> my_location = str()
>>> op.inputs.location.connect(my_location)
>>> my_upper_bound = int()
>>> op.inputs.upper_bound.connect(my_upper_bound)

Overview#

connect

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

ids

Allows to connect ids input to the operator.

location

Allows to connect location input to the operator.

upper_bound

Allows to connect upper_bound input to the operator.

__getattr__

__str__

__call__

__getitem__

Import detail#

from ansys.dpf.core.operators.utility.ints_to_scoping import InputsIntsToScoping

Property detail#

property InputsIntsToScoping.ids: ansys.dpf.core.inputs.Input[int | ansys.dpf.core.scoping.Scoping]#

Allows to connect ids input to the operator.

Integer ID(s) for the scoping: single int, vector of ints, or existing scoping

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.ints_to_scoping()
>>> op.inputs.ids.connect(my_ids)
>>> # or
>>> op.inputs.ids(my_ids)
property InputsIntsToScoping.location: ansys.dpf.core.inputs.Input[str]#

Allows to connect location input to the operator.

Location string for the scoping (e.g., ‘Nodal’, ‘Elemental’). Default is empty

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.ints_to_scoping()
>>> op.inputs.location.connect(my_location)
>>> # or
>>> op.inputs.location(my_location)
property InputsIntsToScoping.upper_bound: ansys.dpf.core.inputs.Input[int | ansys.dpf.core.scoping.Scoping]#

Allows to connect upper_bound input to the operator.

Upper bound for creating a range scoping. Creates IDs from pin 0 value to this upper bound (inclusive)

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.ints_to_scoping()
>>> op.inputs.upper_bound.connect(my_upper_bound)
>>> # or
>>> op.inputs.upper_bound(my_upper_bound)

Method detail#

InputsIntsToScoping.__getattr__(name)#
InputsIntsToScoping.__str__()#
InputsIntsToScoping.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.

InputsIntsToScoping.__call__(inpt)#
InputsIntsToScoping.__getitem__(item) → Input#