metadata:mesh property provider

Version: 0.0.0

Description

Reads a property related to the mesh, defined by its name, by calling the readers defined by the data sources. These properties can be used to fill in the mesh.

Supported file types

This operator supports the following keys (file formats) for each listed namespace (plugin/solver):

• cff: cas, flprj
• cgns: cgns
• hdf5: h5dpf
• lsdyna: d3plot
• mapdl: cms, dsub, mode, rdsp, rfrq, rst, rstp, rth

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

Retrieves a property field on a subset of elements or nodes.

streams_container (Pin 3)

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

streams (result file container) (optional)

data_sources (Pin 4)

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

If the stream is null, retrieves the file path from the data sources.

property_name (Pin 13)

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

Supported property names are: "mat", "named_selection", "named_selection_names", "apdl_element_type", "section", "elprops", "keyopt_1" to "keyopt_18".

property_identifier (Pin 17)

• Required: No
• Expected type(s): int32, string

Retrieves a property at a given index or by name. For example, a named selection's number or a named selection's name.

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 (Pin 0)

• Expected type(s): scoping, property_field, string_field

Returns a property field for properties: "mat", "apdl_element_type", "section", "elprops", "keyopt_1" to "keyopt_18" (or any mesh's property field), a scoping for properties:"named_selection", a string field for properties: "named_selection_names".

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: mesh_property_provider

Full name: metadata.mesh_property_provider

Internal name: mesh_property_provider

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("mesh_property_provider"); // 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);
op.connect(17, my_property_identifier);
ansys::dpf::Scoping my_property = op.getOutput<ansys::dpf::Scoping>(0);

import ansys.dpf.core as dpf

op = dpf.operators.metadata.mesh_property_provider() # 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)
op.inputs.property_identifier.connect(my_property_identifier)
my_property_as_scoping = op.outputs.property_as_scoping()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.metadata.mesh_property_provider() # 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)
op.inputs.property_identifier.Connect(my_property_identifier)
my_property = op.outputs.property.GetData()

Changelog

• Version 0.0.0: Initial release.