## On this page

  

 

 # ansys::Project::RunOutputAttr Class Reference

 Last update: 16.07.2025 

Base class for [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."), [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") - provide built-in variable set/get functions. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#details)

`#include "<a class="el" href="_run_output_attr_8hpp_source.xhtml">RunOutputAttr.hpp</a>"`

Inheritance diagram for ansys::Project::RunOutputAttr:

 ![](/sites/default/files/migrate-content/common_fluids_format_2024_r1/classansys_1_1_project_1_1_run_output_attr.png)



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

<a id="a3552775077206a3eb84c63548b1dce8f" name="a3552775077206a3eb84c63548b1dce8f"></a>std::vector&lt; std::string &gt; **getValues** (const std::vector&lt; std::string &gt; &amp;pVars, bool pFlagInherited) const Returns the values for a list of variables.   
 <a id="afd9f573f991216d001360be85a476827" name="afd9f573f991216d001360be85a476827"></a>int **getIndex** () const Returns the output index (incremental id in a run) - always available.   
 <a id="a9341f80aeb8c06eae7405815daabc2de" name="a9341f80aeb8c06eae7405815daabc2de"></a>int **getSolverIteration** () const Returns the number of solver iterations (if available)   
 <a id="a43a2d325edb0332bd89dd279da60de88" name="a43a2d325edb0332bd89dd279da60de88"></a>double **getTime** () const Returns the transient time value (if available)   
 <a id="a8e79b641bdf6cd9fa3132839b2314cfa" name="a8e79b641bdf6cd9fa3132839b2314cfa"></a>void **setIndex** (int pValue) Changes the specified variable.   
 <a id="a5aef7a029fa3a7f830710275035c4bae" name="a5aef7a029fa3a7f830710275035c4bae"></a>void **setSolverIteration** (int pValue) Changes the specified variable.   
 <a id="a7223a840d264a500994bc1a424772c19" name="a7223a840d264a500994bc1a424772c19"></a>void **setTime** (double pValue) Changes the specified variable.   
 <a id="a2722c5a61bdf6ae862f77277cb799dae" name="a2722c5a61bdf6ae862f77277cb799dae"></a>double **getCrankAngle** () const Returns the specified variable (if available)   
 <a id="a399cfa854a08df9c39ed9c7324651012" name="a399cfa854a08df9c39ed9c7324651012"></a>void **setCrankAngle** (double pValue) Changes the specified variable.   
 <a id="a3c9c4e3b8a1901e526c252b9beda9580" name="a3c9c4e3b8a1901e526c252b9beda9580"></a>int **getCaseId** () const Returns the specified variable (if available)   
 int [getInputSettingsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a267138500fe47e1c74adebc0b3b3082e) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a267138500fe47e1c74adebc0b3b3082e)  
 int [getDomainTransformationId](classansys_1_1_project_1_1_run_output_attr.xhtml#ae1427ae2518b3bf20a72183388307d4e) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#ae1427ae2518b3bf20a72183388307d4e)  
 int [getPhysicsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a212e33422926cc6ce0c06ee08b301f83) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a212e33422926cc6ce0c06ee08b301f83)  
 <a id="a5b718ea67c8d4abcec38f3968ffe71f6" name="a5b718ea67c8d4abcec38f3968ffe71f6"></a>int **getOutputSettingsId** () const Returns the specified variable (if available)   
 <a id="a9b573f92ba0532e9af0181634727d876" name="a9b573f92ba0532e9af0181634727d876"></a>int **getMeshId** () const Returns the specified variable (if available)   
 int [getTopologyId](classansys_1_1_project_1_1_run_output_attr.xhtml#a2088deca6c0239248d5c7d1d81b6c3a3) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a2088deca6c0239248d5c7d1d81b6c3a3)  
 int [getConnectivityId](classansys_1_1_project_1_1_run_output_attr.xhtml#aef3b9200f5924db3428e31e0c8c6e80e) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#aef3b9200f5924db3428e31e0c8c6e80e)  
 int [getCoordinatesId](classansys_1_1_project_1_1_run_output_attr.xhtml#a3a414dbc11513402e17c2eafaf240e7e) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a3a414dbc11513402e17c2eafaf240e7e)  
 int [getLocationId](classansys_1_1_project_1_1_run_output_attr.xhtml#a5d22709f5cd0500b1c0e5db416f1b8e4) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a5d22709f5cd0500b1c0e5db416f1b8e4)  
 <a id="a98234a96286c594c628ae5fc66a2daf1" name="a98234a96286c594c628ae5fc66a2daf1"></a>void **setCaseId** (int pValue) Changes the specified variable.   
 <a id="a4dc9c1c940983005c8aa55516c7dd370" name="a4dc9c1c940983005c8aa55516c7dd370"></a>void **setInputSettingsId** (int pValue) Changes the specified variable.   
 <a id="a48ce611d3011e8d85c7508654d10b0b7" name="a48ce611d3011e8d85c7508654d10b0b7"></a>void **setDomainTransformationId** (int pValue) Changes the specified variable.   
 <a id="a144923c544b7f9e25adaa02c4d0fcfb2" name="a144923c544b7f9e25adaa02c4d0fcfb2"></a>void **setPhysicsId** (int pValue) Changes the specified variable.   
 <a id="aff075987d634ddd1bb5cc72885e60476" name="aff075987d634ddd1bb5cc72885e60476"></a>void **setOutputSettingsId** (int pValue) Changes the specified variable.   
 <a id="af6651bd327bccc3154c7a9dff550b780" name="af6651bd327bccc3154c7a9dff550b780"></a>void **setMeshId** (int pValue) Changes the specified variable.   
 <a id="a8952ac3fb7b31862798fef375a37f789" name="a8952ac3fb7b31862798fef375a37f789"></a>void **setTopologyId** (int pValue) Changes the specified variable.   
 <a id="a2e8201893b1ffef4e96758118ac1438c" name="a2e8201893b1ffef4e96758118ac1438c"></a>void **setConnectivityId** (int pValue) Changes the specified variable.   
 <a id="a1f1a501898b6eaf181ef0b3b7a991342" name="a1f1a501898b6eaf181ef0b3b7a991342"></a>void **setCoordinatesId** (int pValue) Changes the specified variable.   
 <a id="ad49c7e9e12f20d93598d744d8c419f5c" name="ad49c7e9e12f20d93598d744d8c419f5c"></a>void **setLocationId** (int pValue) Changes the specified variable.   
 <a id="a47b791d288a9af06d565d5bacd1dd612" name="a47b791d288a9af06d565d5bacd1dd612"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentCaseId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a05cad22c19d74259c554f2f0dc86305a" name="a05cad22c19d74259c554f2f0dc86305a"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentPhysicsId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a67d0800d2ce78055bcd9658b1ea30136" name="a67d0800d2ce78055bcd9658b1ea30136"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentInputSettingsId** () const See getFirstIterator(const std::string&amp;)   
 <a id="adbcf15409dbcf5051cc8fcb3afdf930f" name="adbcf15409dbcf5051cc8fcb3afdf930f"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentDomainTransformationId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a808bda2819d90363f4914bc637969154" name="a808bda2819d90363f4914bc637969154"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentMeshId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a3f53d6fb39644ef6a923d2d79baa0d12" name="a3f53d6fb39644ef6a923d2d79baa0d12"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentTopologyId** () const See getFirstIterator(const std::string&amp;)   
 <a id="ad4aecfe2ed99b6e81a24edcc8699aa42" name="ad4aecfe2ed99b6e81a24edcc8699aa42"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentConnectivityId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a2badf834ba45aa1be083272d66e68cb8" name="a2badf834ba45aa1be083272d66e68cb8"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentCoordinatesId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a9c43c27adee9503eed4f3940ded66ac7" name="a9c43c27adee9503eed4f3940ded66ac7"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentLocationId** () const See getFirstIterator(const std::string&amp;)   
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrent](classansys_1_1_project_1_1_run_output_attr.xhtml#a992b28250638dc51bde6fc49ea336ab4) (const std::string &amp;pVar) const Return the first entry in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), with same variable value. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a992b28250638dc51bde6fc49ea336ab4)  
 <a id="details" name="details"></a>## Detailed Description

Base class for [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."), [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") - provide built-in variable set/get functions.

The mandatory/built-in variables of a run are simple [Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator.") variables. The built-in variable should be accessed through the dedicated set/get API, the get API will ensure to apply inheritance and search the parent objects, when a value is not found at the current level.

For example:

- [setTime()](classansys_1_1_project_1_1_run_output_attr.xhtml#a7223a840d264a500994bc1a424772c19 "Changes the specified variable.") / [getTime()](classansys_1_1_project_1_1_run_output_attr.xhtml#a43a2d325edb0332bd89dd279da60de88 "Returns the transient time value (if available)")
- [setSolverIteration()](classansys_1_1_project_1_1_run_output_attr.xhtml#a5aef7a029fa3a7f830710275035c4bae "Changes the specified variable.") / [getSolverIteration()](classansys_1_1_project_1_1_run_output_attr.xhtml#a9341f80aeb8c06eae7405815daabc2de "Returns the number of solver iterations (if available)")

However the [Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator.") can also be accessed directly, the internal variable names are stored in the RunOutputAttr::sVar\* strings



## Member Function Documentation

<a id="aef3b9200f5924db3428e31e0c8c6e80e" name="aef3b9200f5924db3428e31e0c8c6e80e"></a>## [◆ ](#aef3b9200f5924db3428e31e0c8c6e80e)getConnectivityId()

 int ansys::Project::RunOutputAttr::getConnectivityId  ( )  const

Returns the specified variable (if available)

If not available, will return the mesh-id instead





<a id="a3a414dbc11513402e17c2eafaf240e7e" name="a3a414dbc11513402e17c2eafaf240e7e"></a>## [◆ ](#a3a414dbc11513402e17c2eafaf240e7e)getCoordinatesId()

 int ansys::Project::RunOutputAttr::getCoordinatesId  ( )  const

Returns the specified variable (if available)

If not available, will return the mesh-id instead





<a id="ae1427ae2518b3bf20a72183388307d4e" name="ae1427ae2518b3bf20a72183388307d4e"></a>## [◆ ](#ae1427ae2518b3bf20a72183388307d4e)getDomainTransformationId()

 int ansys::Project::RunOutputAttr::getDomainTransformationId  ( )  const

Returns the specified variable (if available)

If not available, will return the input-settings-id instead





<a id="a992b28250638dc51bde6fc49ea336ab4" name="a992b28250638dc51bde6fc49ea336ab4"></a>## [◆ ](#a992b28250638dc51bde6fc49ea336ab4)getFirstIteratorForCurrent()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::RunOutputAttr::getFirstIteratorForCurrent  ( const std::string &amp;  *pVar*)  const

Return the first entry in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), with same variable value.

Can be used either on a [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") or an [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") iterator.

A [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") contains a sequence of [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."), for the current [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."), will search the first entry in the parent run sequence which has the same variable value.

For example: mesh-id 0,0,1,1,0 the last entry \[4\] is using the same mesh as the two first steps \[0\] and \[1\] the iterator returned would be \[0\]

If this function is called on a [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") iterator, it will return the matching result in the found [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."), with the same data type.





<a id="a267138500fe47e1c74adebc0b3b3082e" name="a267138500fe47e1c74adebc0b3b3082e"></a>## [◆ ](#a267138500fe47e1c74adebc0b3b3082e)getInputSettingsId()

 int ansys::Project::RunOutputAttr::getInputSettingsId  ( )  const

Returns the specified variable (if available)

If not available, will return the case-id instead





<a id="a5d22709f5cd0500b1c0e5db416f1b8e4" name="a5d22709f5cd0500b1c0e5db416f1b8e4"></a>## [◆ ](#a5d22709f5cd0500b1c0e5db416f1b8e4)getLocationId()

 int ansys::Project::RunOutputAttr::getLocationId  ( )  const

Returns the specified variable (if available)

If not available, will return 0





<a id="a212e33422926cc6ce0c06ee08b301f83" name="a212e33422926cc6ce0c06ee08b301f83"></a>## [◆ ](#a212e33422926cc6ce0c06ee08b301f83)getPhysicsId()

 int ansys::Project::RunOutputAttr::getPhysicsId  ( )  const

Returns the specified variable (if available)

If not available, will return the input-settings-id instead





<a id="a2088deca6c0239248d5c7d1d81b6c3a3" name="a2088deca6c0239248d5c7d1d81b6c3a3"></a>## [◆ ](#a2088deca6c0239248d5c7d1d81b6c3a3)getTopologyId()

 int ansys::Project::RunOutputAttr::getTopologyId  ( )  const

Returns the specified variable (if available)

If not available, will return the mesh-id instead