math:accumulation per scoping

Version: 0.0.0

Description

This operator calculates the sum and the percentage of total sum of the input fields container for each scoping of the scopings 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): fields_container

mesh_scoping (Pin 1)

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

Master scoping. All scopings in the Scopings Container will be intersected with this scoping.

streams_container (Pin 3)

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

data_sources (Pin 4)

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

scopings_container (Pin 5)

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

The intersection between the of the first will be used.

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.

accumulation_per_scoping (Pin 0)

• Expected type(s): fields_container

accumulation_per_scoping_percentage (Pin 1)

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

Plugin: core

Scripting name: accumulation_per_scoping

Full name: math.accumulation_per_scoping

Internal name: accumulation_per_scoping

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("accumulation_per_scoping"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_mesh_scoping);
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
op.connect(5, my_scopings_container);
ansys::dpf::FieldsContainer my_accumulation_per_scoping = op.getOutput<ansys::dpf::FieldsContainer>(0);
ansys::dpf::FieldsContainer my_accumulation_per_scoping_percentage = op.getOutput<ansys::dpf::FieldsContainer>(1);

import ansys.dpf.core as dpf

op = dpf.operators.math.accumulation_per_scoping() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.mesh_scoping.connect(my_mesh_scoping)
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.scopings_container.connect(my_scopings_container)
my_accumulation_per_scoping = op.outputs.accumulation_per_scoping()
my_accumulation_per_scoping_percentage = op.outputs.accumulation_per_scoping_percentage()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.accumulation_per_scoping() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.mesh_scoping.Connect(my_mesh_scoping)
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.scopings_container.Connect(my_scopings_container)
my_accumulation_per_scoping = op.outputs.accumulation_per_scoping.GetData()
my_accumulation_per_scoping_percentage = op.outputs.accumulation_per_scoping_percentage.GetData()

Changelog

• Version 0.0.0: Initial release.