scoping:on property

Version: 0.0.0

Description

Provides a scoping at a given location based on a given property name and a property number.

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.

requested_location (Pin 0)

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

Nodal or Elemental location are expected

property_name (Pin 1)

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

ex "mapdl_element_type", "mapdl_element_type_id", "apdl_type_index", "mapdl_type_id", "material", "apdl_section_id", "apdl_real_id", "apdl_esys_id", "apdl_tshape", "shell_axi", "volume_axi"...

property_id (Pin 2)

• Required: Yes
• Expected type(s): vector<string>, int32

property_id or vector of property ids

streams_container (Pin 3)

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

data_sources (Pin 4)

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

inclusive (Pin 5)

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

If element scoping is requested on a nodal named selection, if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included

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.

mesh_scoping (Pin 0)

• Expected type(s): scoping

Scoping

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

Plugin: core

Scripting name: on_property

Full name: scoping.on_property

Internal name: scoping_provider_by_prop

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("scoping_provider_by_prop"); // operator instantiation
op.connect(0, my_requested_location);
op.connect(1, my_property_name);
op.connect(2, my_property_id);
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
op.connect(5, my_inclusive);
ansys::dpf::Scoping my_mesh_scoping = op.getOutput<ansys::dpf::Scoping>(0);

import ansys.dpf.core as dpf

op = dpf.operators.scoping.on_property() # operator instantiation
op.inputs.requested_location.connect(my_requested_location)
op.inputs.property_name.connect(my_property_name)
op.inputs.property_id.connect(my_property_id)
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.inclusive.connect(my_inclusive)
my_mesh_scoping = op.outputs.mesh_scoping()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.scoping.on_property() # operator instantiation
op.inputs.requested_location.Connect(my_requested_location)
op.inputs.property_name.Connect(my_property_name)
op.inputs.property_id.Connect(my_property_id)
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.inclusive.Connect(my_inclusive)
my_mesh_scoping = op.outputs.mesh_scoping.GetData()

Changelog

• Version 0.0.0: Initial release.