    

 ## On this page

  

 

 # Class ansys::dpf::Unit

 Last update: 25.03.2026 

<a id="classansys-dpf-unit"></a>

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")![](https://img.shields.io/badge/-public-brightgreen "public")

Definition of a unit.

## Members

- [c\_str](classansys-dpf-unit.md#classansys-dpf-unit-1af130c0a87a7006258b3fb1e8b83d785b)
- [conversionFactorTo](classansys-dpf-unit.md#classansys-dpf-unit-1a8ca3445a56c372fd3734b5a7d00537f1)
- [divideBy](classansys-dpf-unit.md#classansys-dpf-unit-1af8033c3d0b41a3ea626221e21a7efce7)
- [homogeneity](classansys-dpf-unit.md#classansys-dpf-unit-1a2ca6139006413a975a4995505ab826fc)
- [HomogeneityIdToHomogeneity](classansys-dpf-unit.md#classansys-dpf-unit-1a902fcfaa2fd6df783400f963d557c357)
- [invert](classansys-dpf-unit.md#classansys-dpf-unit-1adfd11657f700e8a4061d56aba08198ba)
- [isHomogeneousTo](classansys-dpf-unit.md#classansys-dpf-unit-1af4a5b081eaec3c708f1488f6191b397e)
- [multiplyWith](classansys-dpf-unit.md#classansys-dpf-unit-1ae55af41a7a8ed1d0a41a5468b74e7d34)
- [operator==](classansys-dpf-unit.md#classansys-dpf-unit-1a7fec3a530cb4a824b017781c476134d2)
- [pow](classansys-dpf-unit.md#classansys-dpf-unit-1a9fe7810a66d3e479ad4dccff226933d8)
- [shiftTo](classansys-dpf-unit.md#classansys-dpf-unit-1a93b566af024726b9b9e2c0687976b10a)
- [toString](classansys-dpf-unit.md#classansys-dpf-unit-1aed255d78340372d1dd05461d8bc29d38)
- [Unit](classansys-dpf-unit.md#classansys-dpf-unit-1a3a9ceab17e3c6f63fed02c704fb8ce0d)
- [Unit](classansys-dpf-unit.md#classansys-dpf-unit-1aa05714fa7ba83322ad7c7e44a7d4da8f)
- [Unit](classansys-dpf-unit.md#classansys-dpf-unit-1af2bd161c5fa67f3f9bf58b9441692753)
- [Unit](classansys-dpf-unit.md#classansys-dpf-unit-1a45db3ce814a1fc50bc7cea8bab197005)

## Public functions

<a id="classansys-dpf-unit-1a3a9ceab17e3c6f63fed02c704fb8ce0d"></a>

### Function Unit

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::Unit::Unit()

```

**Return type**:

<a id="classansys-dpf-unit-1aa05714fa7ba83322ad7c7e44a7d4da8f"></a>

### Function Unit

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::Unit::Unit(std::string const &symbol)

```

Create a [Unit](classansys-dpf-unit.md#classansys-dpf-unit) with given name.

**Parameters**:

- std::string const &amp; **symbol**: \[in\] Symbol name of unit.

**Return type**:

<a id="classansys-dpf-unit-1af2bd161c5fa67f3f9bf58b9441692753"></a>

### Function Unit

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::Unit::Unit(Homogeneity const &homogeneity, UnitSystem const &unit_system)

```

Create a [Unit](classansys-dpf-unit.md#classansys-dpf-unit) with a given homogeneity from given unit\_system.

**Parameters**:

- [Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity) const &amp; **homogeneity**: \[in\] Measurement quantity.
- [UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem) const &amp; **unit\_system**: \[in\] [Unit](classansys-dpf-unit.md#classansys-dpf-unit) system from which to create unit.

**Return type**:

<a id="classansys-dpf-unit-1a45db3ce814a1fc50bc7cea8bab197005"></a>

### Function Unit

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::Unit::Unit(Homogeneity const &homogeneity, std::string const &symbol)

```

Create a [Unit](classansys-dpf-unit.md#classansys-dpf-unit) with a given homogeneity and a given symbol.

**Parameters**:

- [Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity) const &amp; **homogeneity**: \[in\] Measurement quantity.
- std::string const &amp; **symbol**: \[in\] Symbol name of unit.

**Return type**:

<a id="classansys-dpf-unit-1a7fec3a530cb4a824b017781c476134d2"></a>

### Function operator==

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
bool ansys::dpf::Unit::operator==(Unit const &unit) const

```

**Parameters**:

- Unit const &amp; **unit**

**Return type**: bool

<a id="classansys-dpf-unit-1a8ca3445a56c372fd3734b5a7d00537f1"></a>

### Function conversionFactorTo

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
double ansys::dpf::Unit::conversionFactorTo(Unit const &rhs) const

```

**Returns**:

Multiplication factor required to convert to new unit system.

**Parameters**:

- Unit const &amp; **rhs**: \[in\] [Unit](classansys-dpf-unit.md#classansys-dpf-unit) system to which to convert.

**Return type**: double

<a id="classansys-dpf-unit-1a93b566af024726b9b9e2c0687976b10a"></a>

### Function shiftTo

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
double ansys::dpf::Unit::shiftTo(Unit const &rhs) const

```

**Returns**:

Additive factor required to convert to new unit system.

**Parameters**:

- Unit const &amp; **rhs**: \[in\] [Unit](classansys-dpf-unit.md#classansys-dpf-unit) system to which to convert.

**Return type**: double

<a id="classansys-dpf-unit-1af4a5b081eaec3c708f1488f6191b397e"></a>

### Function isHomogeneousTo

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
bool ansys::dpf::Unit::isHomogeneousTo(Unit const &) const

```

**Returns**:

Indication of same measurement quantities.

**Parameters**:

- Unit const &amp;

**Return type**: bool

<a id="classansys-dpf-unit-1a2ca6139006413a975a4995505ab826fc"></a>

### Function homogeneity

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
ansys::dpf::Homogeneity const  & ansys::dpf::Unit::homogeneity() const

```

**Returns**:

Measurement quantity.

**Return type**: [ansys::dpf::Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity) const &amp;

<a id="classansys-dpf-unit-1aed255d78340372d1dd05461d8bc29d38"></a>

### Function toString

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::string const  & ansys::dpf::Unit::toString() const

```

**Returns**:

Symbol name.

**Return type**: std::string const &amp;

<a id="classansys-dpf-unit-1af130c0a87a7006258b3fb1e8b83d785b"></a>

### Function c\_str

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
const char * ansys::dpf::Unit::c_str() const

```

**Returns**:

Symbol name.

**Return type**: const char \*

<a id="classansys-dpf-unit-1ae55af41a7a8ed1d0a41a5468b74e7d34"></a>

### Function multiplyWith

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
Unit ansys::dpf::Unit::multiplyWith(Unit const &rhs) const

```

**Returns**:

new unit that is the product of this unit and another one.

Works only for in process API.

**Parameters**:

- Unit const &amp; **rhs**

**Return type**: Unit

<a id="classansys-dpf-unit-1af8033c3d0b41a3ea626221e21a7efce7"></a>

### Function divideBy

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
Unit ansys::dpf::Unit::divideBy(Unit const &rhs) const

```

**Returns**:

new unit that is the division of this unit by another one.

Works only for in process API.

**Parameters**:

- Unit const &amp; **rhs**

**Return type**: Unit

<a id="classansys-dpf-unit-1adfd11657f700e8a4061d56aba08198ba"></a>

### Function invert

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
Unit ansys::dpf::Unit::invert() const

```

**Returns**:

new the inverse unit to this one.

Works only for in process API.

**Return type**: Unit

<a id="classansys-dpf-unit-1a9fe7810a66d3e479ad4dccff226933d8"></a>

### Function pow

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
Unit ansys::dpf::Unit::pow(double power) const

```

**Returns**:

the powed unit.

Works only for in process API.

**Parameters**:

- double **power**

**Return type**: Unit

## Public static functions

<a id="classansys-dpf-unit-1a902fcfaa2fd6df783400f963d557c357"></a>

### Function HomogeneityIdToHomogeneity

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-static-lightgrey "static")

```cpp
static Homogeneity ansys::dpf::Unit::HomogeneityIdToHomogeneity(int id)

```

**Returns**:

the homogeneity corresponding to a homogeneity id

**Parameters**:

- int **id**

**Return type**: [Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity)