averaging:elemental difference (fields container)

Version: 0.0.0

Description

Transforms an Elemental Nodal or Nodal field into an Elemental field. Each elemental value is the maximum difference between the unaveraged or averaged (depending on the input fields) computed result for all nodes in this element. The result is computed on a given element scoping. If the input fields are mixed shell/solid, and the shell's layers are not specified as collapsed, then the fields are split by element shape and the output fields container has an elshape label.

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 (Pin 1)

• Required: No
• Expected type(s): abstract_meshed_region, meshes_container

The mesh region in this pin is used to perform the averaging, used if there is no fields support.

scoping (Pin 3)

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

Average only on these elements. If it is scoping container, the label must correspond to the one of the fields container.

collapse_shell_layers (Pin 10)

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

If true, the data across different shell layers is averaged as well (default is false).

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.

fields_container (Pin 0)

• 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.

num_threads

• Expected type(s): int32
• Default value: 0

Number of threads to use to run in parallel

run_in_parallel

• Expected type(s): bool
• Default value: true

Loops are allowed to run in parallel if the value of this config is set to true.

Scripting

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

Category: averaging

Plugin: core

Scripting name: elemental_difference_fc

Full name: averaging.elemental_difference_fc

Internal name: elemental_difference_fc

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("elemental_difference_fc"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_mesh);
op.connect(3, my_scoping);
op.connect(10, my_collapse_shell_layers);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.averaging.elemental_difference_fc() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.mesh.connect(my_mesh)
op.inputs.scoping.connect(my_scoping)
op.inputs.collapse_shell_layers.connect(my_collapse_shell_layers)
my_fields_container = op.outputs.fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.averaging.elemental_difference_fc() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.mesh.Connect(my_mesh)
op.inputs.scoping.Connect(my_scoping)
op.inputs.collapse_shell_layers.Connect(my_collapse_shell_layers)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.