InputsExtractScoping

class ansys.dpf.core.operators.utility.extract_scoping.InputsExtractScoping(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to extract_scoping operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_scoping()
>>> my_field_or_fields_container = dpf.Field()
>>> op.inputs.field_or_fields_container.connect(my_field_or_fields_container)
>>> my_requested_location = int()
>>> op.inputs.requested_location.connect(my_requested_location)

Overview

Methods

connect

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

Properties

field_or_fields_container	Allows to connect field_or_fields_container input to the operator.
requested_location	Allows to connect requested_location input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.extract_scoping import InputsExtractScoping

Property detail

property InputsExtractScoping.field_or_fields_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field | ansys.dpf.core.fields_container.FieldsContainer | ansys.dpf.core.property_field.PropertyField | ansys.dpf.core.property_fields_container.PropertyFieldsContainer | ansys.dpf.core.custom_type_field.CustomTypeField | ansys.dpf.core.string_field.StringField | ansys.dpf.core.scoping.Scoping | ansys.dpf.core.scopings_container.ScopingsContainer | ansys.dpf.core.meshed_region.MeshedRegion | ansys.dpf.core.meshes_container.MeshesContainer]

Allows to connect field_or_fields_container 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.extract_scoping()
>>> op.inputs.field_or_fields_container.connect(my_field_or_fields_container)
>>> # or
>>> op.inputs.field_or_fields_container(my_field_or_fields_container)

property InputsExtractScoping.requested_location: ansys.dpf.core.inputs.Input[int]

Allows to connect requested_location input to the operator.

If input 0 is a mesh or a meshes_container, the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_scoping()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> # or
>>> op.inputs.requested_location(my_requested_location)

Method detail

InputsExtractScoping.__str__()

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

InputsExtractScoping.__call__(inpt)

InputsExtractScoping.__getitem__(item) → Input