utility:field set property

Version: 0.0.0

Description

Sets a property to an input field/field container. A Fieldin pin 0, a property name (string) in pin 1 and a valid property value in pin 2 are expected as inputs

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.

field (Pin 0)

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

property_name (Pin 1)

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

Property to set. Accepted inputs are specific strings namely: 'unit', 'name', 'time_freq_support', 'scoping', 'header'.

property (Pin 2)

• Required: Yes
• Expected type(s): string, time_freq_support, scoping, abstract_data_tree, int32, double

Property Value to set. Accepted inputs on this pin are: CTimeFreqSupport, CScoping, DataTree, int, double, string.

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, fields_container

Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.

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

Full name: utility.set_property

Internal name: field::set_property

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("field::set_property"); // operator instantiation
op.connect(0, my_field);
op.connect(1, my_property_name);
op.connect(2, my_property);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.set_property() # operator instantiation
op.inputs.field.connect(my_field)
op.inputs.property_name.connect(my_property_name)
op.inputs.property.connect(my_property)
my_field_as_field = op.outputs.field_as_field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.set_property() # operator instantiation
op.inputs.field.Connect(my_field)
op.inputs.property_name.Connect(my_property_name)
op.inputs.property.Connect(my_property)
my_field = op.outputs.field.GetData()

Changelog

• Version 0.0.0: Initial release.