## On this page

  

 

 # ansys::dpf::Unit Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [Unit](classansys_1_1dpf_1_1Unit.xhtml#aa05714fa7ba83322ad7c7e44a7d4da8f) (std::string const &amp;symbol)  [Unit](classansys_1_1dpf_1_1Unit.xhtml#af2bd161c5fa67f3f9bf58b9441692753) ([Homogeneity](classansys_1_1dpf_1_1Homogeneity.xhtml) const &amp;[homogeneity](classansys_1_1dpf_1_1Unit.xhtml#a2ca6139006413a975a4995505ab826fc), [UnitSystem](structansys_1_1dpf_1_1UnitSystem.xhtml) const &amp;unit\_system)  [Unit](classansys_1_1dpf_1_1Unit.xhtml#a45db3ce814a1fc50bc7cea8bab197005) ([Homogeneity](classansys_1_1dpf_1_1Homogeneity.xhtml) const &amp;[homogeneity](classansys_1_1dpf_1_1Unit.xhtml#a2ca6139006413a975a4995505ab826fc), std::string const &amp;symbol) <a id="a7fec3a530cb4a824b017781c476134d2" name="a7fec3a530cb4a824b017781c476134d2"></a>bool **operator==** ([Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;unit) const double [conversionFactorTo](classansys_1_1dpf_1_1Unit.xhtml#a8ca3445a56c372fd3734b5a7d00537f1) ([Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;rhs) const double [shiftTo](classansys_1_1dpf_1_1Unit.xhtml#a93b566af024726b9b9e2c0687976b10a) ([Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;rhs) const bool [isHomogeneousTo](classansys_1_1dpf_1_1Unit.xhtml#af4a5b081eaec3c708f1488f6191b397e) ([Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;) const [ansys::dpf::Homogeneity](classansys_1_1dpf_1_1Homogeneity.xhtml) const &amp; [homogeneity](classansys_1_1dpf_1_1Unit.xhtml#a2ca6139006413a975a4995505ab826fc) () const std::string const &amp; [toString](classansys_1_1dpf_1_1Unit.xhtml#aed255d78340372d1dd05461d8bc29d38) () const const char \* [c\_str](classansys_1_1dpf_1_1Unit.xhtml#af130c0a87a7006258b3fb1e8b83d785b) () const [Unit](classansys_1_1dpf_1_1Unit.xhtml) [multiplyWith](classansys_1_1dpf_1_1Unit.xhtml#ae55af41a7a8ed1d0a41a5468b74e7d34) ([Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;rhs) const [Unit](classansys_1_1dpf_1_1Unit.xhtml) [divideBy](classansys_1_1dpf_1_1Unit.xhtml#af8033c3d0b41a3ea626221e21a7efce7) ([Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;rhs) const [Unit](classansys_1_1dpf_1_1Unit.xhtml) [invert](classansys_1_1dpf_1_1Unit.xhtml#adfd11657f700e8a4061d56aba08198ba) () const [Unit](classansys_1_1dpf_1_1Unit.xhtml) [pow](classansys_1_1dpf_1_1Unit.xhtml#a9fe7810a66d3e479ad4dccff226933d8) (double power) const <a id="details" name="details"></a>## Detailed Description

Definition of a unit.

Examples[AveragingTest.cpp](AveragingTest_8cpp-example.xhtml#_a23), [CompleteRST.cpp](CompleteRST_8cpp-example.xhtml#_a11), [DataApis.cpp](DataApis_8cpp-example.xhtml#_a23), [DataExport.cpp](DataExport_8cpp-example.xhtml#_a9), [ModelTest.cpp](ModelTest_8cpp-example.xhtml#_a30), and [ResultTest.cpp](ResultTest_8cpp-example.xhtml#_a11).

## Constructor &amp; Destructor Documentation

<a id="aa05714fa7ba83322ad7c7e44a7d4da8f" name="aa05714fa7ba83322ad7c7e44a7d4da8f"></a>## [◆ ](#aa05714fa7ba83322ad7c7e44a7d4da8f)Unit() \[1/3\]

 ansys::dpf::Unit::Unit  ( std::string const &amp;  *symbol*)   explicit 

Create a [Unit](classansys_1_1dpf_1_1Unit.xhtml) with given name.

Parameters \[in\]symbolSymbol name of unit. 



<a id="af2bd161c5fa67f3f9bf58b9441692753" name="af2bd161c5fa67f3f9bf58b9441692753"></a>## [◆ ](#af2bd161c5fa67f3f9bf58b9441692753)Unit() \[2/3\]

 ansys::dpf::Unit::Unit  ( [Homogeneity](classansys_1_1dpf_1_1Homogeneity.xhtml) const &amp;  *homogeneity*,    [UnitSystem](structansys_1_1dpf_1_1UnitSystem.xhtml) const &amp;  *unit\_system*   )   explicit 

Create a [Unit](classansys_1_1dpf_1_1Unit.xhtml) with a given homogeneity from given unit\_system.

Parameters \[in\]homogeneityMeasurement quantity. \[in\]unit\_system[Unit](classansys_1_1dpf_1_1Unit.xhtml) system from which to create unit. 



<a id="a45db3ce814a1fc50bc7cea8bab197005" name="a45db3ce814a1fc50bc7cea8bab197005"></a>## [◆ ](#a45db3ce814a1fc50bc7cea8bab197005)Unit() \[3/3\]

 ansys::dpf::Unit::Unit  ( [Homogeneity](classansys_1_1dpf_1_1Homogeneity.xhtml) const &amp;  *homogeneity*,    std::string const &amp;  *symbol*   )   explicit 

Create a [Unit](classansys_1_1dpf_1_1Unit.xhtml) with a given homogeneity and a given symbol.

Parameters \[in\]homogeneityMeasurement quantity. \[in\]symbolSymbol name of unit. 



## Member Function Documentation

<a id="af130c0a87a7006258b3fb1e8b83d785b" name="af130c0a87a7006258b3fb1e8b83d785b"></a>## [◆ ](#af130c0a87a7006258b3fb1e8b83d785b)c\_str()

 const char \* ansys::dpf::Unit::c\_str  ( )  const

ReturnsSymbol name. 



<a id="a8ca3445a56c372fd3734b5a7d00537f1" name="a8ca3445a56c372fd3734b5a7d00537f1"></a>## [◆ ](#a8ca3445a56c372fd3734b5a7d00537f1)conversionFactorTo()

 double ansys::dpf::Unit::conversionFactorTo  ( [Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;  *rhs*)  const

ReturnsMultiplication factor required to convert to new unit system. Parameters \[in\]rhs[Unit](classansys_1_1dpf_1_1Unit.xhtml) system to which to convert. 



<a id="af8033c3d0b41a3ea626221e21a7efce7" name="af8033c3d0b41a3ea626221e21a7efce7"></a>## [◆ ](#af8033c3d0b41a3ea626221e21a7efce7)divideBy()

 [Unit](classansys_1_1dpf_1_1Unit.xhtml) ansys::dpf::Unit::divideBy  ( [Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;  *rhs*)  const

Returnsnew unit that is the division of this unit by another one.Works only for in process API.





<a id="a2ca6139006413a975a4995505ab826fc" name="a2ca6139006413a975a4995505ab826fc"></a>## [◆ ](#a2ca6139006413a975a4995505ab826fc)homogeneity()

 [ansys::dpf::Homogeneity](classansys_1_1dpf_1_1Homogeneity.xhtml) const &amp; ansys::dpf::Unit::homogeneity  ( )  const

ReturnsMeasurement quantity. Examples[CompleteRST.cpp](CompleteRST_8cpp-example.xhtml#a14), and [ResultTest.cpp](ResultTest_8cpp-example.xhtml#a13).



<a id="adfd11657f700e8a4061d56aba08198ba" name="adfd11657f700e8a4061d56aba08198ba"></a>## [◆ ](#adfd11657f700e8a4061d56aba08198ba)invert()

 [Unit](classansys_1_1dpf_1_1Unit.xhtml) ansys::dpf::Unit::invert  ( )  const

Returnsnew the inverse unit to this one.Works only for in process API.





<a id="af4a5b081eaec3c708f1488f6191b397e" name="af4a5b081eaec3c708f1488f6191b397e"></a>## [◆ ](#af4a5b081eaec3c708f1488f6191b397e)isHomogeneousTo()

 bool ansys::dpf::Unit::isHomogeneousTo  ( [Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;  )  const

ReturnsIndication of same measurement quantities. 



<a id="ae55af41a7a8ed1d0a41a5468b74e7d34" name="ae55af41a7a8ed1d0a41a5468b74e7d34"></a>## [◆ ](#ae55af41a7a8ed1d0a41a5468b74e7d34)multiplyWith()

 [Unit](classansys_1_1dpf_1_1Unit.xhtml) ansys::dpf::Unit::multiplyWith  ( [Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;  *rhs*)  const

Returnsnew unit that is the product of this unit and another one.Works only for in process API.





<a id="a9fe7810a66d3e479ad4dccff226933d8" name="a9fe7810a66d3e479ad4dccff226933d8"></a>## [◆ ](#a9fe7810a66d3e479ad4dccff226933d8)pow()

 [Unit](classansys_1_1dpf_1_1Unit.xhtml) ansys::dpf::Unit::pow  ( double  *power*)  const

Returnsthe powed unit.Works only for in process API.





<a id="a93b566af024726b9b9e2c0687976b10a" name="a93b566af024726b9b9e2c0687976b10a"></a>## [◆ ](#a93b566af024726b9b9e2c0687976b10a)shiftTo()

 double ansys::dpf::Unit::shiftTo  ( [Unit](classansys_1_1dpf_1_1Unit.xhtml) const &amp;  *rhs*)  const

ReturnsAdditive factor required to convert to new unit system. Parameters \[in\]rhs[Unit](classansys_1_1dpf_1_1Unit.xhtml) system to which to convert. 



<a id="aed255d78340372d1dd05461d8bc29d38" name="aed255d78340372d1dd05461d8bc29d38"></a>## [◆ ](#aed255d78340372d1dd05461d8bc29d38)toString()

 std::string const &amp; ansys::dpf::Unit::toString  ( )  const

ReturnsSymbol name. Examples[CompleteRST.cpp](CompleteRST_8cpp-example.xhtml#a13).