## On this page

  

 

 # RunGroup

 Last update: 16.07.2025 

<a id="l00001" name="l00001"></a> 1\#ifndef CFFSDK\_PROJECT\_RUNGROUP\_H

<a id="l00002" name="l00002"></a> 2\#define CFFSDK\_PROJECT\_RUNGROUP\_H

<a id="l00003" name="l00003"></a> 3 

<a id="l00004" name="l00004"></a> 4\#include "Project/LibraryType.hpp"

<a id="l00005" name="l00005"></a> 5\#include "Project/Iterator.hpp"

<a id="l00006" name="l00006"></a> 6\#include "Project/SimBase.hpp"

<a id="l00007" name="l00007"></a> 7\#include "Project/Result.hpp"

<a id="l00008" name="l00008"></a> 8\#include "Project/Output.hpp"

<a id="l00009" name="l00009"></a> 9\#include "Project/Run.hpp"

<a id="l00010" name="l00010"></a> 10 

<a id="l00011" name="l00011"></a> 11namespace [ansys](namespaceansys.xhtml) {

<a id="l00012" name="l00012"></a> 12namespace Project {

<a id="l00013" name="l00013"></a> 13 

<a id="l00014" name="l00014"></a> 14class Metadata;

<a id="l00015" name="l00015"></a> 15 

<a id="l00016" name="l00016"></a>[ 16](classansys_1_1_project_1_1_run_group.xhtml)class ANSYS_PROJECT_DLL [RunGroup](classansys_1_1_project_1_1_run_group.xhtml) : private [Run](classansys_1_1_project_1_1_run.xhtml)

<a id="l00017" name="l00017"></a> 17{

<a id="l00018" name="l00018"></a> 18public:

<a id="l00019" name="l00019"></a> 19 [RunGroup](classansys_1_1_project_1_1_run_group.xhtml)([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter);

<a id="l00020" name="l00020"></a> 20 virtual [~RunGroup](classansys_1_1_project_1_1_run_group.xhtml)() {};

<a id="l00021" name="l00021"></a> 21 

<a id="l00022" name="l00022"></a> 22 // SimBase provides: ok, getName, Meta and Input 

<a id="l00023" name="l00023"></a> 23 

<a id="l00024" name="l00024"></a> 24 virtual [Error](classansys_1_1_project_1_1_error.xhtml) isValid() const;

<a id="l00025" name="l00025"></a> 25 

<a id="l00026" name="l00026"></a> 26 using Run::getIterator;

<a id="l00027" name="l00027"></a> 27 

<a id="l00028" name="l00028"></a> 28 // Run provides: Variable, OutputVariable, getCase

<a id="l00029" name="l00029"></a> 29 using [Run::addVariable](classansys_1_1_project_1_1_run.xhtml#ab4e9f4d0c7f6e9747451330dc698c5bc);

<a id="l00030" name="l00030"></a> 30 using [Run::setVariables](classansys_1_1_project_1_1_run.xhtml#a2e8493f21a92ce378d4bce82d0cb7b3f);

<a id="l00031" name="l00031"></a> 31 using [Run::removeVariable](classansys_1_1_project_1_1_run.xhtml#a54114201475287073e786d77e3718383);

<a id="l00032" name="l00032"></a> 32 using [Run::getVariables](classansys_1_1_project_1_1_run.xhtml#aebee6c00a322bbcccc5659453699d929);

<a id="l00033" name="l00033"></a> 33 

<a id="l00034" name="l00034"></a> 34 using [Run::addOutputVariable](classansys_1_1_project_1_1_run.xhtml#aa84a2103fc117a256bab7cce5fef9780);

<a id="l00035" name="l00035"></a> 35 using [Run::setOutputVariables](classansys_1_1_project_1_1_run.xhtml#a1593a20a772c53baf1af273ab63f0a53);

<a id="l00036" name="l00036"></a> 36 using [Run::removeOutputVariable](classansys_1_1_project_1_1_run.xhtml#ae3d5f185d577c43e2ed2721f18212c35);

<a id="l00037" name="l00037"></a> 37 using [Run::getOutputVariables](classansys_1_1_project_1_1_run.xhtml#aa85ce4557dbb6edd648e2e4d68c60ab6);

<a id="l00038" name="l00038"></a> 38 using [Run::getAllVariables](classansys_1_1_project_1_1_run.xhtml#ae5c21c8fb9320c241809e969717c4360);

<a id="l00039" name="l00039"></a> 39 

<a id="l00040" name="l00040"></a> 40 using [Run::addVarIndex](classansys_1_1_project_1_1_run.xhtml#a8ba482e260f6846c1a59cd8848341601);

<a id="l00041" name="l00041"></a> 41 using [Run::addVarTime](classansys_1_1_project_1_1_run.xhtml#a03c7998829a5b7f7fe8be10be1474e7c);

<a id="l00042" name="l00042"></a> 42 using [Run::addVarSolverIteration](classansys_1_1_project_1_1_run.xhtml#a322c24066e5f30512865a58bd7b01c43);

<a id="l00043" name="l00043"></a> 43 using [Run::addVarCrankAngle](classansys_1_1_project_1_1_run.xhtml#a518fcda2b9be5b8c2278981784e0f574);

<a id="l00044" name="l00044"></a> 44 using [Run::addVarMeshId](classansys_1_1_project_1_1_run.xhtml#ac89b098f5fe66841a9b538617e7b3f87);

<a id="l00045" name="l00045"></a> 45 using [Run::addVarDomainTransformationId](classansys_1_1_project_1_1_run.xhtml#af1b52a763e5fc10f7ad5f350767ae945);

<a id="l00046" name="l00046"></a> 46 using [Run::addVarPhysicsId](classansys_1_1_project_1_1_run.xhtml#ab2c162b2db99da7a0ae0a33f34fc4ad9);

<a id="l00047" name="l00047"></a> 47 using [Run::addVarTopologyId](classansys_1_1_project_1_1_run.xhtml#a5bf38019a16ca06c2fc3500e5c9fe0a5);

<a id="l00048" name="l00048"></a> 48 using [Run::addVarCoordinatesId](classansys_1_1_project_1_1_run.xhtml#a32464d38b59f71688e99b311de6ce564);

<a id="l00049" name="l00049"></a> 49 using [Run::addVarConnectivityId](classansys_1_1_project_1_1_run.xhtml#a376c18baaecfbce85fa4e637e71c0e5b);

<a id="l00050" name="l00050"></a> 50 using [Run::addVarCaseId](classansys_1_1_project_1_1_run.xhtml#a1a825e5d408a51ac0ad6ee804e2e411e);

<a id="l00051" name="l00051"></a> 51 using [Run::addVarInputSettingsId](classansys_1_1_project_1_1_run.xhtml#ad1cb2f559eef2c4960300dc23eb06d14);

<a id="l00052" name="l00052"></a> 52 using [Run::addVarOutputSettingsId](classansys_1_1_project_1_1_run.xhtml#aebad5a9f951bc07891bef662aed6ada1);

<a id="l00053" name="l00053"></a> 53 

<a id="l00054" name="l00054"></a> 54 using [Run::setRunStatus](classansys_1_1_project_1_1_run.xhtml#ae14a2fd242ce9515baba2542a12fe493);

<a id="l00055" name="l00055"></a> 55 using [Run::getRunStatus](classansys_1_1_project_1_1_run.xhtml#a7482f6212a0f951dcb367a98803b33e3);

<a id="l00056" name="l00056"></a> 56 

<a id="l00057" name="l00057"></a> 57 virtual bool setRunOutputType(Run::RunOutputType pType);

<a id="l00058" name="l00058"></a> 58 using [Run::getRunOutputType](classansys_1_1_project_1_1_run.xhtml#aee0d6fd3d0249f5536d45886bc9ad403);

<a id="l00059" name="l00059"></a> 59 using [Run::getRunOutputTypeAsString](classansys_1_1_project_1_1_run.xhtml#a77a5212218cb0dde90bccf6597c0d8d4);

<a id="l00060" name="l00060"></a> 60 

<a id="l00061" name="l00061"></a> 61 [Error](classansys_1_1_project_1_1_error.xhtml) addRun([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pRun);

<a id="l00062" name="l00062"></a> 62 std::vector&lt;Iterator&gt; getRuns() const;

<a id="l00063" name="l00063"></a> 63 

<a id="l00064" name="l00064"></a> 64};

<a id="l00065" name="l00065"></a> 65 

<a id="l00066" name="l00066"></a> 66}

<a id="l00067" name="l00067"></a> 67}

<a id="l00068" name="l00068"></a> 68 

<a id="l00069" name="l00069"></a> 69\#endif // CFFSDK\_PROJECT\_RUN\_H

[ansys::Project::Error](classansys_1_1_project_1_1_error.xhtml)

The return state / error value of a Project function call.

**Definition:** Error.hpp:11



[ansys::Project::Iterator](classansys_1_1_project_1_1_iterator.xhtml)

Pointer to a project location.

**Definition:** Iterator.hpp:20



[ansys::Project::RunGroup](classansys_1_1_project_1_1_run_group.xhtml)

Optional concept - Virtual folder with a list of Run.

**Definition:** RunGroup.hpp:17



[ansys::Project::Run](classansys_1_1_project_1_1_run.xhtml)

Subfolder of a Simulation, regrouping Output/Result for a step.

**Definition:** Run.hpp:18



[ansys::Project::Run::addVarTime](classansys_1_1_project_1_1_run.xhtml#a03c7998829a5b7f7fe8be10be1474e7c)

void addVarTime()

Add the Time variable (not required if mandatory for the run type)

**Definition:** Run.cpp:615



[ansys::Project::Run::setOutputVariables](classansys_1_1_project_1_1_run.xhtml#a1593a20a772c53baf1af273ab63f0a53)

bool setOutputVariables(const std::vector&lt; std::string &gt; &amp;pVars)

Set/replace the list of output variables.

**Definition:** Run.cpp:375



[ansys::Project::Run::addVarCaseId](classansys_1_1_project_1_1_run.xhtml#a1a825e5d408a51ac0ad6ee804e2e411e)

void addVarCaseId()

Add the CaseId variable - Id is incremented when the case settings are changed.

**Definition:** Run.cpp:698



[ansys::Project::Run::setVariables](classansys_1_1_project_1_1_run.xhtml#a2e8493f21a92ce378d4bce82d0cb7b3f)

bool setVariables(const std::vector&lt; std::string &gt; &amp;pVars)

Set/replace the list of variables for this run.

**Definition:** Run.cpp:265



[ansys::Project::Run::addVarSolverIteration](classansys_1_1_project_1_1_run.xhtml#a322c24066e5f30512865a58bd7b01c43)

void addVarSolverIteration()

Add the SolverIteration variable (not required if mandatory for the run type)

**Definition:** Run.cpp:623



[ansys::Project::Run::addVarCoordinatesId](classansys_1_1_project_1_1_run.xhtml#a32464d38b59f71688e99b311de6ce564)

void addVarCoordinatesId()

Add the CoordinatesId variable - Id should be incremented when the node locations of a mesh have chan...

**Definition:** Run.cpp:672



[ansys::Project::Run::addVarConnectivityId](classansys_1_1_project_1_1_run.xhtml#a376c18baaecfbce85fa4e637e71c0e5b)

void addVarConnectivityId()

Add the ConnectivityId variable - Id should be incremented when the cells of a mesh are changed (numb...

**Definition:** Run.cpp:690



[ansys::Project::Run::addVarCrankAngle](classansys_1_1_project_1_1_run.xhtml#a518fcda2b9be5b8c2278981784e0f574)

void addVarCrankAngle()

Add the built-in variable.

**Definition:** Run.cpp:631



[ansys::Project::Run::removeVariable](classansys_1_1_project_1_1_run.xhtml#a54114201475287073e786d77e3718383)

bool removeVariable(const std::string &amp;pVar)

Remove a variable from the list of inputs.

**Definition:** Run.cpp:293



[ansys::Project::Run::addVarTopologyId](classansys_1_1_project_1_1_run.xhtml#a5bf38019a16ca06c2fc3500e5c9fe0a5)

void addVarTopologyId()

Add the TopologyId variable - Id should be incremented when the topology (list of boundaries,...

**Definition:** Run.cpp:663



[ansys::Project::Run::getRunStatus](classansys_1_1_project_1_1_run.xhtml#a7482f6212a0f951dcb367a98803b33e3)

RunStatus getRunStatus() const

Returns the RunStatus state for this Output. See setRunStatus()

**Definition:** Run.cpp:1258



[ansys::Project::Run::getRunOutputTypeAsString](classansys_1_1_project_1_1_run.xhtml#a77a5212218cb0dde90bccf6597c0d8d4)

std::string getRunOutputTypeAsString() const

Return the RunOutputType as a string.

**Definition:** Run.cpp:455



[ansys::Project::Run::addVarIndex](classansys_1_1_project_1_1_run.xhtml#a8ba482e260f6846c1a59cd8848341601)

void addVarIndex()

Add the Index variable (not required if mandatory for the run type)

**Definition:** Run.cpp:607



[ansys::Project::Run::addOutputVariable](classansys_1_1_project_1_1_run.xhtml#aa84a2103fc117a256bab7cce5fef9780)

bool addOutputVariable(const std::string &amp;pVar)

Register an output variable for this run.

**Definition:** Run.cpp:358



[ansys::Project::Run::getOutputVariables](classansys_1_1_project_1_1_run.xhtml#aa85ce4557dbb6edd648e2e4d68c60ab6)

std::vector&lt; std::string &gt; getOutputVariables() const

Returns the list of output variables.

**Definition:** Run.cpp:402



[ansys::Project::Run::addVarPhysicsId](classansys_1_1_project_1_1_run.xhtml#ab2c162b2db99da7a0ae0a33f34fc4ad9)

void addVarPhysicsId()

Add the PhysicsId variable - Id should be incremented when the physics settings have changed.

**Definition:** Run.cpp:655



[ansys::Project::Run::addVariable](classansys_1_1_project_1_1_run.xhtml#ab4e9f4d0c7f6e9747451330dc698c5bc)

bool addVariable(const std::string &amp;pVar)

Register an input variable for this run.

**Definition:** Run.cpp:243



[ansys::Project::Run::addVarMeshId](classansys_1_1_project_1_1_run.xhtml#ac89b098f5fe66841a9b538617e7b3f87)

void addVarMeshId()

Add the MeshId variable - Id should be incremented when the mesh has changed.

**Definition:** Run.cpp:639



[ansys::Project::Run::addVarInputSettingsId](classansys_1_1_project_1_1_run.xhtml#ad1cb2f559eef2c4960300dc23eb06d14)

void addVarInputSettingsId()

Add the InputSettings variable - Id is incremented when the input case settings are changed.

**Definition:** Run.cpp:709



[ansys::Project::Run::setRunStatus](classansys_1_1_project_1_1_run.xhtml#ae14a2fd242ce9515baba2542a12fe493)

void setRunStatus(RunStatus pStatus)

Set the RunStatus state for this Run.

**Definition:** Run.cpp:1249



[ansys::Project::Run::removeOutputVariable](classansys_1_1_project_1_1_run.xhtml#ae3d5f185d577c43e2ed2721f18212c35)

bool removeOutputVariable(const std::string &amp;pVar)

Remove an output variable.

**Definition:** Run.cpp:384



[ansys::Project::Run::getAllVariables](classansys_1_1_project_1_1_run.xhtml#ae5c21c8fb9320c241809e969717c4360)

std::vector&lt; std::string &gt; getAllVariables() const

Returns the list of all variables ( input and output )

**Definition:** Run.cpp:410



[ansys::Project::Run::addVarOutputSettingsId](classansys_1_1_project_1_1_run.xhtml#aebad5a9f951bc07891bef662aed6ada1)

void addVarOutputSettingsId()

Add the OutputSettings variable - Id is incremented when the case output settings are changed.

**Definition:** Run.cpp:717



[ansys::Project::Run::getVariables](classansys_1_1_project_1_1_run.xhtml#aebee6c00a322bbcccc5659453699d929)

std::vector&lt; std::string &gt; getVariables() const

Return the list of input variables for this Run.

**Definition:** Run.cpp:330



[ansys::Project::Run::getRunOutputType](classansys_1_1_project_1_1_run.xhtml#aee0d6fd3d0249f5536d45886bc9ad403)

RunOutputType getRunOutputType() const

Return the RunOutputType as the enum.

**Definition:** Run.cpp:463



[ansys::Project::Run::addVarDomainTransformationId](classansys_1_1_project_1_1_run.xhtml#af1b52a763e5fc10f7ad5f350767ae945)

void addVarDomainTransformationId()

Add the DomainTransformationId variable - Id should be incremented when the mesh transformation metad...

**Definition:** Run.cpp:647



[ansys](namespaceansys.xhtml)

**Definition:** API.dox:1