logic:same meshes?

Version: 0.0.0

Description

Takes two meshes and compares them. Note: When comparing mesh properties, the current behaviour is to verify that the properties in the first mesh (pin 0) are included in the second mesh (pin 1).

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.

Pin number	Name	Status	Expected type(s)
0	meshA	Required	`abstract_meshed_region`
1	meshB	Required	`abstract_meshed_region`
2	small_value		`double`
3	tolerance		`double`
4	compare_auxiliary	Required	`bool`

meshA (Pin 0)

Required: Yes
Expected type(s): abstract_meshed_region

meshB (Pin 1)

Required: Yes
Expected type(s): abstract_meshed_region

small_value (Pin 2)

Required: No
Expected type(s): double

define what is a small value for numeric comparison (default value:1.0e-14).

tolerance (Pin 3)

Required: No
Expected type(s): double

define the relative tolerance ceil for numeric comparison (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.

Pin number	Name	Expected type(s)
0	are_identical	`bool`

are_identical (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: identical_meshes

Full name: logic.identical_meshes

Internal name: compare::mesh

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.

C++

#include "dpf_api.h"

ansys::dpf::Operator op("compare::mesh"); // operator instantiation
op.connect(0, my_meshA);
op.connect(1, my_meshB);
op.connect(2, my_small_value);
op.connect(3, my_tolerance);
op.connect(4, my_compare_auxiliary);
bool my_are_identical = op.getOutput<bool>(0);

CPython

import ansys.dpf.core as dpf

op = dpf.operators.logic.identical_meshes() # operator instantiation
op.inputs.meshA.connect(my_meshA)
op.inputs.meshB.connect(my_meshB)
op.inputs.small_value.connect(my_small_value)
op.inputs.tolerance.connect(my_tolerance)
op.inputs.compare_auxiliary.connect(my_compare_auxiliary)
my_are_identical = op.outputs.are_identical()

IPython

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.logic.identical_meshes() # operator instantiation
op.inputs.meshA.Connect(my_meshA)
op.inputs.meshB.Connect(my_meshB)
op.inputs.small_value.Connect(my_small_value)
op.inputs.tolerance.Connect(my_tolerance)
op.inputs.compare_auxiliary.Connect(my_compare_auxiliary)
my_are_identical = op.outputs.are_identical.GetData()

Changelog

Version 0.0.0: Initial release.

DPF Framework 2026 R1