logic:same meshes container?

Version: 0.0.0

Description

Checks if two meshes_container are identical.

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.

meshes_containerA (Pin 0)

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

meshes_containerB (Pin 1)

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

small_value (Pin 2)

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

Double positive small value. Smallest value which will be considered during the comparison step. All the abs(values) in the field less than this value are considered as null, (default value:1.0e-14).

tolerance (Pin 3)

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

Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001).

compare_auxiliary (Pin 4)

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

compare auxiliary data (i.e property fields, scopings...). Default value 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.

boolean (Pin 0)

• Expected type(s): bool

bool (true if identical...)

message (Pin 1)

• Expected type(s): string

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

Full name: logic.identical_mc

Internal name: compare::meshes_container

License: None

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("compare::meshes_container"); // operator instantiation
op.connect(0, my_meshes_containerA);
op.connect(1, my_meshes_containerB);
op.connect(2, my_small_value);
op.connect(3, my_tolerance);
op.connect(4, my_compare_auxiliary);
bool my_boolean = op.getOutput<bool>(0);
std::string my_message = op.getOutput<std::string>(1);

import ansys.dpf.core as dpf

op = dpf.operators.logic.identical_mc() # operator instantiation
op.inputs.meshes_containerA.connect(my_meshes_containerA)
op.inputs.meshes_containerB.connect(my_meshes_containerB)
op.inputs.small_value.connect(my_small_value)
op.inputs.tolerance.connect(my_tolerance)
op.inputs.compare_auxiliary.connect(my_compare_auxiliary)
my_boolean = op.outputs.boolean()
my_message = op.outputs.message()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.logic.identical_mc() # operator instantiation
op.inputs.meshes_containerA.Connect(my_meshes_containerA)
op.inputs.meshes_containerB.Connect(my_meshes_containerB)
op.inputs.small_value.Connect(my_small_value)
op.inputs.tolerance.Connect(my_tolerance)
op.inputs.compare_auxiliary.Connect(my_compare_auxiliary)
my_boolean = op.outputs.boolean.GetData()
my_message = op.outputs.message.GetData()

Changelog

• Version 0.0.0: Initial release.