utility:merge weighted fields

Version: 0.0.0

Description

Assembles a set of fields into a unique one, applying a weight on the sum of the fields.

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.

sum_merge (Pin -2)

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

Default is false. If true, redundant quantities are summed instead of being ignored.

merged_support (Pin -1)

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

Already merged field support.

fields (Pin 0)

• Required: Yes
• Expected type(s): vector<shared_ptr<field>>, field, fields_container

Either a fields container, a vector of fields to merge, or fields from pin 0 to ...

weights (Pin 1000)

• Required: Yes
• Expected type(s): vector<shared_ptr<property_field>>, property_field

Weights to apply to each field from pin 1000 to ...

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.

merged_field (Pin 0)

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

Scripting

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

Category: utility

Plugin: core

Scripting name: merge_weighted_fields

Full name: utility.merge_weighted_fields

Internal name: merge::weighted_field

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("merge::weighted_field"); // operator instantiation
op.connect(-2, my_sum_merge);
op.connect(-1, my_merged_support);
op.connect(0, my_fields);
op.connect(1000, my_weights);
ansys::dpf::Field my_merged_field = op.getOutput<ansys::dpf::Field>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.merge_weighted_fields() # operator instantiation
op.inputs.sum_merge.connect(my_sum_merge)
op.inputs.merged_support.connect(my_merged_support)
op.inputs.fields1.connect(my_fields1)
op.inputs.fields2.connect(my_fields2)
op.inputs.weights1.connect(my_weights1)
op.inputs.weights2.connect(my_weights2)
my_merged_field = op.outputs.merged_field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.merge_weighted_fields() # operator instantiation
op.inputs.sum_merge.Connect(my_sum_merge)
op.inputs.merged_support.Connect(my_merged_support)
op.inputs.fields.Connect(my_fields)
op.inputs.weights.Connect(my_weights)
my_merged_field = op.outputs.merged_field.GetData()

Changelog

• Version 0.0.0: Initial release.