Skip to main content

averaging:elemental fraction (fields container)

Version: 0.0.0

Description

Transforms Elemental Nodal fields into Elemental fields. Each elemental value is the fraction between the elemental difference and the entity average. The result is computed on a given element's scoping.

Inputs

InputNameExpected type(s)Description
Pin 0
Required
fields_containerfields_container
Pin 1meshabstract_meshed_regionThe mesh region in this pin is used to perform the averaging. It is used if there is no fields support.
Pin 3scopingscopingAverage only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers.
Pin 6denominatorfields_containerIf a fields container is set in this pin, it is used as the denominator of the fraction instead of entity_average_fc.
Pin 10collapse_shell_layersboolIf true, the data across different shell layers is averaged as well (default is false).

Outputs

OutputNameExpected type(s)Description
Pin 0fields_containerfields_container

Configurations

NameExpected type(s)Default valueDescription
mutexboolfalseIf this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.
num_threadsint320Number of threads to use to run in parallel
run_in_parallelbooltrueLoops are allowed to run in parallel if the value of this config is set to true.

Scripting

Category: averaging

Plugin: core

Scripting name: elemental_fraction_fc

Full name: averaging.elemental_fraction_fc

Internal name: elemental_fraction_fc

License: any_dpf_supported_increments

Changelog

  • Version 0.0.0: Initial release.