math:unit convert

Version: 0.0.0

Description

Converts an input field/fields container or mesh of a given unit to another unit.

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.

entity_to_convert (Pin 0)

• Required: Yes
• Expected type(s): field, fields_container, abstract_meshed_region, meshes_container

unit_name (Pin 1)

• Required: Yes
• Expected type(s): string, int32, field

unit as a string, ex 'm' for meter, 'Pa' for pascal,... Or ansys unit system's ID, or a field from which expected unit will be extracted.

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.

converted_entity (Pin 0)

• Expected type(s): field, fields_container, abstract_meshed_region, meshes_container

the output entity is the same as the input (inplace operator)

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.

permissive

• Expected type(s): bool
• Default value: false

If this option is set to true, warning checks (like unit or data sizes) won't be done.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: math

Plugin: core

Scripting name: None

Full name: None

Internal name: unit_convert

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("unit_convert"); // operator instantiation
op.connect(0, my_entity_to_convert);
op.connect(1, my_unit_name);
ansys::dpf::Field my_converted_entity = op.getOutput<ansys::dpf::Field>(0);

import ansys.dpf.core as dpf

op = dpf.operators.math.None() # operator instantiation
op.inputs.entity_to_convert.connect(my_entity_to_convert)
op.inputs.unit_name.connect(my_unit_name)
my_converted_entity_as_field = op.outputs.converted_entity_as_field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.None() # operator instantiation
op.inputs.entity_to_convert.Connect(my_entity_to_convert)
op.inputs.unit_name.Connect(my_unit_name)
my_converted_entity = op.outputs.converted_entity.GetData()

Changelog

• Version 0.0.0: Initial release.