Skip to main content

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

InputNameExpected type(s)Description
Pin -2sum_mergeboolDefault is false. If true, redundant quantities are summed instead of being ignored.
Pin -1merged_supportabstract_field_supportAlready merged field support.
Pin 0
Required
fieldsvector<shared_ptr<field>>, field, fields_containerEither a fields container, a vector of fields to merge, or fields from pin 0 to ...
Pin 1000
Required
weightsvector<shared_ptr<property_field>>, property_fieldWeights to apply to each field from pin 1000 to ...

Outputs

OutputNameExpected type(s)Description
Pin 0merged_fieldfield

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.

Scripting

Category: utility

Plugin: core

Scripting name: merge_weighted_fields

Full name: utility.merge_weighted_fields

Internal name: merge::weighted_field

License: None

Changelog

  • Version 0.0.0: Initial release.