scoping:rescope

Version: 0.0.0

Description

Rescopes a field on the given scoping. If an ID does not exist in the original field, the default value (in 2) is used when defined.

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.

fields (Pin 0)

• Required: Yes
• Expected type(s): fields_container, field

mesh_scoping (Pin 1)

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

default_value (Pin 2)

• Required: No
• Expected type(s): double, vector<double>

If pin 2 is used, the IDs not found in the field are added with this default value.

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.

fields (Pin 0)

• Expected type(s): fields_container, 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.

num_threads

• Expected type(s): int32
• Default value: 0

Number of threads to use to run in parallel

run_in_parallel

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

Loops are allowed to run in parallel if the value of this config is set to true.

Scripting

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

Category: scoping

Plugin: core

Scripting name: rescope

Full name: scoping.rescope

Internal name: Rescope

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("Rescope"); // operator instantiation
op.connect(0, my_fields);
op.connect(1, my_mesh_scoping);
op.connect(2, my_default_value);
ansys::dpf::FieldsContainer my_fields = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.scoping.rescope() # operator instantiation
op.inputs.fields.connect(my_fields)
op.inputs.mesh_scoping.connect(my_mesh_scoping)
op.inputs.default_value.connect(my_default_value)
my_fields_as_fields_container = op.outputs.fields_as_fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.scoping.rescope() # operator instantiation
op.inputs.fields.Connect(my_fields)
op.inputs.mesh_scoping.Connect(my_mesh_scoping)
op.inputs.default_value.Connect(my_default_value)
my_fields = op.outputs.fields.GetData()

Changelog

• Version 0.0.0: Initial release.