logic:enrich materials

Version: 0.0.0

Description

Takes a MaterialContainer and a stream and enriches the MaterialContainer using stream data.

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.

MaterialContainer (Pin 0)

• Required: Yes
• Expected type(s):

streams (Pin 1)

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

streams_mapping (Pin 2)

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

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.

MaterialContainer (Pin 0)

• Expected type(s): bool

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

Plugin: core

Scripting name: enrich_materials

Full name: logic.enrich_materials

Internal name: enrich_materials

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("enrich_materials"); // operator instantiation
op.connect(0, my_MaterialContainer);
op.connect(1, my_streams);
op.connect(2, my_streams_mapping);
bool my_MaterialContainer = op.getOutput<bool>(0);

import ansys.dpf.core as dpf

op = dpf.operators.logic.enrich_materials() # operator instantiation
op.inputs.MaterialContainer.connect(my_MaterialContainer)
op.inputs.streams.connect(my_streams)
op.inputs.streams_mapping.connect(my_streams_mapping)
my_MaterialContainer = op.outputs.MaterialContainer()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.logic.enrich_materials() # operator instantiation
op.inputs.MaterialContainer.Connect(my_MaterialContainer)
op.inputs.streams.Connect(my_streams)
op.inputs.streams_mapping.Connect(my_streams_mapping)
my_MaterialContainer = op.outputs.MaterialContainer.GetData()

Changelog

• Version 0.0.0: Initial release.