metadata:property field provider by property name

Version: 0.0.0

Description

Provides the property values for a set of elements for a defined property name.

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

mesh_scoping (Pin 1)

• Required: No
• Expected type(s): scoping

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

streams_container (Pin 3)

• Required: No
• Expected type(s): streams_container

optional if using a dataSources

data_sources (Pin 4)

• Required: Yes
• Expected type(s): data_sources

optional if using a streamsContainer

property_name (Pin 13)

• Required: Yes
• Expected type(s): string

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

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

property_field (Pin 0)

• Expected type(s): property_field

property field

Configurations

This operator supports configuration options that modify its behavior.

mutex

• Expected type(s): bool
• Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: metadata

Plugin: core

Scripting name: property_field_provider_by_name

Full name: metadata.property_field_provider_by_name

Internal name: property_field_provider_by_name

License: None

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

#include "dpf_api.h"

ansys::dpf::Operator op("property_field_provider_by_name"); // operator instantiation
op.connect(1, my_mesh_scoping);
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
op.connect(13, my_property_name);
ansys::dpf::PropertyField my_property_field = op.getOutput<ansys::dpf::PropertyField>(0);

import ansys.dpf.core as dpf

op = dpf.operators.metadata.property_field_provider_by_name() # operator instantiation
op.inputs.mesh_scoping.connect(my_mesh_scoping)
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.property_name.connect(my_property_name)
my_property_field = op.outputs.property_field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.metadata.property_field_provider_by_name() # operator instantiation
op.inputs.mesh_scoping.Connect(my_mesh_scoping)
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.property_name.Connect(my_property_name)
my_property_field = op.outputs.property_field.GetData()

Changelog

• Version 0.0.0: Initial release.