math:mac

Version: 0.0.0

Description

Computes MAC Matrix between two fields container, both for real and complex cases. For mixed cases (real-complex and complex) only the real part is considered. Providing inputs with the same component scoping is an user responsability.

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

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

Fields Container A.

fields_containerB (Pin 1)

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

Fields Container B.

weights (Pin 2)

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

Field M, optional weighting for MAC Matrix computation.

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

MAC Matrix for all the combinations between mode fields of Field Container A and Field Container B. Results listed row by row.

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

Plugin: core

Scripting name: mac

Full name: math.mac

Internal name: mac

License: any_dpf_supported_increments

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("mac"); // operator instantiation
op.connect(0, my_fields_containerA);
op.connect(1, my_fields_containerB);
op.connect(2, my_weights);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);

import ansys.dpf.core as dpf

op = dpf.operators.math.mac() # operator instantiation
op.inputs.fields_containerA.connect(my_fields_containerA)
op.inputs.fields_containerB.connect(my_fields_containerB)
op.inputs.weights.connect(my_weights)
my_field = op.outputs.field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.mac() # operator instantiation
op.inputs.fields_containerA.Connect(my_fields_containerA)
op.inputs.fields_containerB.Connect(my_fields_containerB)
op.inputs.weights.Connect(my_weights)
my_field = op.outputs.field.GetData()

Changelog

• Version 0.0.0: Initial release.