utility:extract sub fields container

Version: 0.0.0

Description

Creates a new fields container with all the fields corresponding to the label space in input 1. If pin 1 is not defined, pin 0 input will be copied to the output.

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

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

fields_container

label_space (Pin 1)

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

Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs)

collapse_labels (Pin 2)

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

If set to true (default) the input label space (scoping location) is suppressed from the output fields container, otherwise, label space is kept.

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

• Expected type(s): fields_container

fields_container

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

Full name: utility.extract_sub_fc

Internal name: extract_sub_fc

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("extract_sub_fc"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_label_space);
op.connect(2, my_collapse_labels);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.extract_sub_fc() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.label_space.connect(my_label_space)
op.inputs.collapse_labels.connect(my_collapse_labels)
my_fields_container = op.outputs.fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.extract_sub_fc() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.label_space.Connect(my_label_space)
op.inputs.collapse_labels.Connect(my_collapse_labels)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.