InputsPropertyFieldProviderByName

class ansys.dpf.core.operators.metadata.property_field_provider_by_name.InputsPropertyFieldProviderByName(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to property_field_provider_by_name operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.property_field_provider_by_name()
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_streams_container = dpf.StreamsContainer()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_property_name = str()
>>> op.inputs.property_name.connect(my_property_name)

Overview

Methods

connect

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

Properties

mesh_scoping	Allows to connect mesh_scoping input to the operator.
streams_container	Allows to connect streams_container input to the operator.
data_sources	Allows to connect data_sources input to the operator.
property_name	Allows to connect property_name input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.metadata.property_field_provider_by_name import InputsPropertyFieldProviderByName

Property detail

property InputsPropertyFieldProviderByName.mesh_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping]

Allows to connect mesh_scoping input to the operator.

scoping that defines the set of elements to fetch the property values for. If not specified, applied on all the elements of the mesh.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.property_field_provider_by_name()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)

property InputsPropertyFieldProviderByName.streams_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.streams_container.StreamsContainer]

Allows to connect streams_container input to the operator.

optional if using a dataSources

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.property_field_provider_by_name()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)

property InputsPropertyFieldProviderByName.data_sources: ansys.dpf.core.inputs.Input[ansys.dpf.core.data_sources.DataSources]

Allows to connect data_sources input to the operator.

optional if using a streamsContainer

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.property_field_provider_by_name()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)

property InputsPropertyFieldProviderByName.property_name: ansys.dpf.core.inputs.Input[str]

Allows to connect property_name input to the operator.

property to read, that can be the following: elements_connectivity, nodes_connectivity, material, element_type, apdl_section_id, apdl_real_id, apdl_esys_id, apdl_tshape, mapdl_element_type, mapdl_element_type_id, harmonic_index, step, substep, keyopt_i (i = 1 -> 18).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.property_field_provider_by_name()
>>> op.inputs.property_name.connect(my_property_name)
>>> # or
>>> op.inputs.property_name(my_property_name)

Method detail

InputsPropertyFieldProviderByName.__str__()

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

InputsPropertyFieldProviderByName.__call__(inpt)

InputsPropertyFieldProviderByName.__getitem__(item) → Input