ansys::Project::RunOutputAttr Class Reference
Last update: 16.07.2025Base class for Run, Output, Result - provide built-in variable set/get functions. More...
#include "RunOutputAttr.hpp"
Public Member Functions | |
| std::vector< std::string > | getValues (const std::vector< std::string > &pVars, bool pFlagInherited) const |
| Returns the values for a list of variables. | |
| int | getIndex () const |
| Returns the output index (incremental id in a run) - always available. | |
| int | getSolverIteration () const |
| Returns the number of solver iterations (if available) | |
| double | getTime () const |
| Returns the transient time value (if available) | |
| void | setIndex (int pValue) |
| Changes the specified variable. | |
| void | setSolverIteration (int pValue) |
| Changes the specified variable. | |
| void | setTime (double pValue) |
| Changes the specified variable. | |
| double | getCrankAngle () const |
| Returns the specified variable (if available) | |
| void | setCrankAngle (double pValue) |
| Changes the specified variable. | |
| int | getCaseId () const |
| Returns the specified variable (if available) | |
| int | getInputSettingsId () const |
| Returns the specified variable (if available) More... | |
| int | getDomainTransformationId () const |
| Returns the specified variable (if available) More... | |
| int | getPhysicsId () const |
| Returns the specified variable (if available) More... | |
| int | getOutputSettingsId () const |
| Returns the specified variable (if available) | |
| int | getMeshId () const |
| Returns the specified variable (if available) | |
| int | getTopologyId () const |
| Returns the specified variable (if available) More... | |
| int | getConnectivityId () const |
| Returns the specified variable (if available) More... | |
| int | getCoordinatesId () const |
| Returns the specified variable (if available) More... | |
| int | getLocationId () const |
| Returns the specified variable (if available) More... | |
| void | setCaseId (int pValue) |
| Changes the specified variable. | |
| void | setInputSettingsId (int pValue) |
| Changes the specified variable. | |
| void | setDomainTransformationId (int pValue) |
| Changes the specified variable. | |
| void | setPhysicsId (int pValue) |
| Changes the specified variable. | |
| void | setOutputSettingsId (int pValue) |
| Changes the specified variable. | |
| void | setMeshId (int pValue) |
| Changes the specified variable. | |
| void | setTopologyId (int pValue) |
| Changes the specified variable. | |
| void | setConnectivityId (int pValue) |
| Changes the specified variable. | |
| void | setCoordinatesId (int pValue) |
| Changes the specified variable. | |
| void | setLocationId (int pValue) |
| Changes the specified variable. | |
| Iterator | getFirstIteratorForCurrentCaseId () const |
| See getFirstIterator(const std::string&) | |
| Iterator | getFirstIteratorForCurrentPhysicsId () const |
| See getFirstIterator(const std::string&) | |
| Iterator | getFirstIteratorForCurrentInputSettingsId () const |
| See getFirstIterator(const std::string&) | |
| Iterator | getFirstIteratorForCurrentDomainTransformationId () const |
| See getFirstIterator(const std::string&) | |
| Iterator | getFirstIteratorForCurrentMeshId () const |
| See getFirstIterator(const std::string&) | |
| Iterator | getFirstIteratorForCurrentTopologyId () const |
| See getFirstIterator(const std::string&) | |
| Iterator | getFirstIteratorForCurrentConnectivityId () const |
| See getFirstIterator(const std::string&) | |
| Iterator | getFirstIteratorForCurrentCoordinatesId () const |
| See getFirstIterator(const std::string&) | |
| Iterator | getFirstIteratorForCurrentLocationId () const |
| See getFirstIterator(const std::string&) | |
| Iterator | getFirstIteratorForCurrent (const std::string &pVar) const |
| Return the first entry in the current Run, with same variable value. More... | |
Detailed Description
Base class for Run, Output, Result - provide built-in variable set/get functions.
The mandatory/built-in variables of a run are simple Metadata 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:
However the Metadata can also be accessed directly, the internal variable names are stored in the RunOutputAttr::sVar* strings
Member Function Documentation
◆ getConnectivityId()
| int ansys::Project::RunOutputAttr::getConnectivityId | ( | ) | const |
Returns the specified variable (if available)
If not available, will return the mesh-id instead
◆ getCoordinatesId()
| int ansys::Project::RunOutputAttr::getCoordinatesId | ( | ) | const |
Returns the specified variable (if available)
If not available, will return the mesh-id instead
◆ getDomainTransformationId()
| int ansys::Project::RunOutputAttr::getDomainTransformationId | ( | ) | const |
Returns the specified variable (if available)
If not available, will return the input-settings-id instead
◆ getFirstIteratorForCurrent()
| Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrent | ( | const std::string & | pVar | ) | const |
Return the first entry in the current Run, with same variable value.
Can be used either on a Result or an Output iterator.
A Run contains a sequence of Output, for the current Output, 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 iterator, it will return the matching result in the found Output, with the same data type.
◆ getInputSettingsId()
| int ansys::Project::RunOutputAttr::getInputSettingsId | ( | ) | const |
Returns the specified variable (if available)
If not available, will return the case-id instead
◆ getLocationId()
| int ansys::Project::RunOutputAttr::getLocationId | ( | ) | const |
Returns the specified variable (if available)
If not available, will return 0
◆ getPhysicsId()
| int ansys::Project::RunOutputAttr::getPhysicsId | ( | ) | const |
Returns the specified variable (if available)
If not available, will return the input-settings-id instead
◆ getTopologyId()
| int ansys::Project::RunOutputAttr::getTopologyId | ( | ) | const |
Returns the specified variable (if available)
If not available, will return the mesh-id instead
