utility:convert to scoping

Version: 0.0.0

Description

Creates a scoping from integer data. Converts single integers, integer vectors, or existing scopings into a properly formatted DPF scoping.

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.

ids (Pin 0)

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

Integer ID(s) for the scoping: single int, vector of ints, or existing scoping

location (Pin 1)

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

Location string for the scoping (e.g., 'Nodal', 'Elemental'). Default is empty

upper_bound (Pin 2)

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

Upper bound for creating a range scoping. Creates IDs from pin 0 value to this upper bound (inclusive)

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.

scoping (Pin 0)

• Expected type(s): scoping

Generated scoping with the specified IDs and location

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

Plugin: core

Scripting name: ints_to_scoping

Full name: utility.ints_to_scoping

Internal name: scopingify

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("scopingify"); // operator instantiation
op.connect(0, my_ids);
op.connect(1, my_location);
op.connect(2, my_upper_bound);
ansys::dpf::Scoping my_scoping = op.getOutput<ansys::dpf::Scoping>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.ints_to_scoping() # operator instantiation
op.inputs.ids.connect(my_ids)
op.inputs.location.connect(my_location)
op.inputs.upper_bound.connect(my_upper_bound)
my_scoping = op.outputs.scoping()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.ints_to_scoping() # operator instantiation
op.inputs.ids.Connect(my_ids)
op.inputs.location.Connect(my_location)
op.inputs.upper_bound.Connect(my_upper_bound)
my_scoping = op.outputs.scoping.GetData()

Changelog

• Version 0.0.0: Initial release.