scoping:on named selection

Version: 0.0.0

Description

provides a scoping at a given location based on a given named selection

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

named_selection_name (Pin 1)

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

the string is expected to be in upper case

int_inclusive (Pin 2)

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

If element scoping is requested on a nodal named selection, if Inclusive == 1 then add all the elements adjacent to the nodes.If Inclusive == 0, only the elements which have all their nodes in the named selection are included

streams_container (Pin 3)

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

data_sources (Pin 4)

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

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

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_named_selection

Full name: scoping.on_named_selection

Internal name: scoping_provider_by_ns

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

import ansys.dpf.core as dpf

op = dpf.operators.scoping.on_named_selection() # operator instantiation
op.inputs.requested_location.connect(my_requested_location)
op.inputs.named_selection_name.connect(my_named_selection_name)
op.inputs.int_inclusive.connect(my_int_inclusive)
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
my_mesh_scoping = op.outputs.mesh_scoping()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.scoping.on_named_selection() # operator instantiation
op.inputs.requested_location.Connect(my_requested_location)
op.inputs.named_selection_name.Connect(my_named_selection_name)
op.inputs.int_inclusive.Connect(my_int_inclusive)
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
my_mesh_scoping = op.outputs.mesh_scoping.GetData()

Changelog

• Version 0.0.0: Initial release.