InputsExtractSubSc

class ansys.dpf.core.operators.utility.extract_sub_sc.InputsExtractSubSc(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to extract_sub_sc operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_sub_sc()
>>> my_scopings_container = dpf.ScopingsContainer()
>>> op.inputs.scopings_container.connect(my_scopings_container)
>>> my_label_space = dict()
>>> op.inputs.label_space.connect(my_label_space)
>>> my_collapse_labels = bool()
>>> op.inputs.collapse_labels.connect(my_collapse_labels)

Overview

Methods

connect

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

Properties

scopings_container	Allows to connect scopings_container input to the operator.
label_space	Allows to connect label_space input to the operator.
collapse_labels	Allows to connect collapse_labels input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.extract_sub_sc import InputsExtractSubSc

Property detail

property InputsExtractSubSc.scopings_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.scopings_container.ScopingsContainer]

Allows to connect scopings_container input to the operator.

scopings_container

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_sub_sc()
>>> op.inputs.scopings_container.connect(my_scopings_container)
>>> # or
>>> op.inputs.scopings_container(my_scopings_container)

property InputsExtractSubSc.label_space: ansys.dpf.core.inputs.Input[dict | ansys.dpf.core.scoping.Scoping]

Allows to connect label_space input to the operator.

Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs)

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_sub_sc()
>>> op.inputs.label_space.connect(my_label_space)
>>> # or
>>> op.inputs.label_space(my_label_space)

property InputsExtractSubSc.collapse_labels: ansys.dpf.core.inputs.Input[bool]

Allows to connect collapse_labels input to the operator.

If set to true (default) the input label space (scoping location) is suppressed from the output scopings container, otherwise, label space is kept.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_sub_sc()
>>> op.inputs.collapse_labels.connect(my_collapse_labels)
>>> # or
>>> op.inputs.collapse_labels(my_collapse_labels)

Method detail

InputsExtractSubSc.__str__()

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

InputsExtractSubSc.__call__(inpt)

InputsExtractSubSc.__getitem__(item) → Input