unit_convert class

Namespace: Ans.DataProcessing.operators.math

Summary

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

available inputs: entity_to_convert (Field, FieldsContainer, MeshedRegion, MeshesContainer), unit_name (string, Int32, Field)

available outputs: converted_entity (Field ,FieldsContainer ,MeshedRegion ,MeshesContainer)

Example

op = unit_convert()

op = unit_convert(entity_to_convert=my_entity_to_convert,unit_name=my_unit_name)

Class Information

Property	Value
Namespace	Ans.DataProcessing.operators.math
Assembly	Ans_Dpf_Native_dll_cs
Base Class	Ans.DataProcessing.internal_objects.BaseOperator

Inputs

entity_to_convert

Type: LinkableInput

unit_name

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.

Type: LinkableInput

Outputs

converted_entity

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

Type: LinkableOutput

Constructors

Constructor

unit_convert()

Constructor

unit_convert(entity_to_convert, unit_name, config)

Parameters:

• entity_to_convert (object)
• unit_name (object)
• config (OperatorConfig)

Constructor

unit_convert(config)

Parameters:

• config (OperatorConfig)

Methods

Properties

inputs

Type: InputSpec

# Get or set the property
value = obj.inputs
obj.inputs = new_value

outputs

Type: OutputSpec

# Get or set the property
value = obj.outputs
obj.outputs = new_value

defaultConfig

Type: Config

# Get the property (read-only)
value = obj.defaultConfig