utility:extract field

Version: 0.0.0

Description

Extracts the fields at the indices defined in the vector (in 1) from the fields container (in 0). If a single index is provided, returns a field; if multiple indices are provided, returns a fields container.

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): field, fields_container

Fields container or single field. If a field is provided, it is passed through as output

indices (Pin 1)

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

Indices of fields to extract. Default is [0] (first field). Single index returns a field, multiple indices return a fields container

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.

field (Pin 0)

• Expected type(s): field

Extracted field(s). Single index produces a field, multiple indices produce a 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_field

Full name: utility.extract_field

Internal name: ExtractFromFC

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("ExtractFromFC"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_indices);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.extract_field() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.indices.connect(my_indices)
my_field = op.outputs.field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.extract_field() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.indices.Connect(my_indices)
my_field = op.outputs.field.GetData()

Changelog

• Version 0.0.0: Initial release.