## On this page

  

 

 # Run

 Last update: 16.07.2025 

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

<a id="l00002" name="l00002"></a> 2\#define CFFSDK\_PROJECT\_RUN\_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/RunOutputAttr.hpp"

<a id="l00010" name="l00010"></a> 10\#include "Project/Types.hpp"

<a id="l00011" name="l00011"></a> 11 

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

<a id="l00013" name="l00013"></a> 13namespace Project {

<a id="l00014" name="l00014"></a> 14 

<a id="l00015" name="l00015"></a> 15class Metadata;

<a id="l00016" name="l00016"></a> 16 

<a id="l00017" name="l00017"></a>[ 17](classansys_1_1_project_1_1_run.xhtml)class ANSYS_PROJECT_DLL [Run](classansys_1_1_project_1_1_run.xhtml) : public [SimBase](classansys_1_1_project_1_1_sim_base.xhtml), public [RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml)

<a id="l00018" name="l00018"></a> 18{

<a id="l00019" name="l00019"></a> 19public:

<a id="l00020" name="l00020"></a> 20 [Run](classansys_1_1_project_1_1_run.xhtml)([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter);

<a id="l00021" name="l00021"></a> 21 virtual [~Run](classansys_1_1_project_1_1_run.xhtml)() {};

<a id="l00022" name="l00022"></a> 22 

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

<a id="l00024" name="l00024"></a> 24 

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

<a id="l00026" name="l00026"></a> 26 

<a id="l00027" name="l00027"></a> 27 bool addVariable(const std::string&amp; pVar);

<a id="l00028" name="l00028"></a> 28 bool setVariables(const std::vector&lt;std::string&gt;&amp; pVars);

<a id="l00029" name="l00029"></a> 29 bool removeVariable(const std::string&amp; pVar);

<a id="l00030" name="l00030"></a> 30 std::vector&lt;std::string&gt; getVariables() const;

<a id="l00031" name="l00031"></a> 31 std::vector&lt;std::vector&lt;std::string&gt; &gt; getValues(const std::vector&lt;std::string&gt;&amp; pVars) const;

<a id="l00032" name="l00032"></a> 32 

<a id="l00033" name="l00033"></a> 33 bool addOutputVariable(const std::string&amp; pVar);

<a id="l00034" name="l00034"></a> 34 bool setOutputVariables(const std::vector&lt;std::string&gt;&amp; pVars);

<a id="l00035" name="l00035"></a> 35 bool removeOutputVariable(const std::string&amp; pVar);

<a id="l00036" name="l00036"></a> 36 std::vector&lt;std::string&gt; getOutputVariables() const;

<a id="l00037" name="l00037"></a> 37 std::vector&lt;std::string&gt; getAllVariables() const;

<a id="l00038" name="l00038"></a> 38 

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

<a id="l00040" name="l00040"></a> 40 void addVarIndex();

<a id="l00041" name="l00041"></a> 41 void addVarTime();

<a id="l00042" name="l00042"></a> 42 void addVarSolverIteration();

<a id="l00043" name="l00043"></a> 43 void addVarCrankAngle();

<a id="l00044" name="l00044"></a> 44 void addVarMeshId();

<a id="l00045" name="l00045"></a> 45 void addVarDomainTransformationId();

<a id="l00046" name="l00046"></a> 46 void addVarPhysicsId();

<a id="l00047" name="l00047"></a> 47 void addVarTopologyId();

<a id="l00048" name="l00048"></a> 48 void addVarCoordinatesId();

<a id="l00049" name="l00049"></a> 49 void addVarLocationId();

<a id="l00050" name="l00050"></a> 50 void addVarConnectivityId();

<a id="l00051" name="l00051"></a> 51 void addVarCaseId();

<a id="l00052" name="l00052"></a> 52 void addVarInputSettingsId();

<a id="l00053" name="l00053"></a> 53 void addVarOutputSettingsId();

<a id="l00054" name="l00054"></a> 54 

<a id="l00055" name="l00055"></a> 55 [Error](classansys_1_1_project_1_1_error.xhtml) computeIds();

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

<a id="l00057" name="l00057"></a> 57 // Metadata with inheritance (RunGroup)

<a id="l00058" name="l00058"></a> 58 virtual bool hasValue(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00059" name="l00059"></a> 59 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getValueIter(const std::string&amp; pVar) const;

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

<a id="l00061" name="l00061"></a> 61 virtual std::string getValue(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00062" name="l00062"></a> 62 virtual int getValueInt(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00063" name="l00063"></a> 63 virtual double getValueDouble(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00064" name="l00064"></a> 64 virtual MetaVariableType getValueType(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00065" name="l00065"></a> 65 virtual void setValue(const std::string&amp; pVar,const std::string&amp; pValue);

<a id="l00066" name="l00066"></a> 66 virtual void setValueInt(const std::string&amp; pVar,int pValue);

<a id="l00067" name="l00067"></a> 67 virtual void setValueDouble(const std::string&amp; pVar,double pValue);

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

<a id="l00069" name="l00069"></a> 69 // backward compatibility api

<a id="l00070" name="l00070"></a> 70 void setValue(const std::string&amp; pVar,int pValue) { setValueInt(pVar,pValue); };

<a id="l00071" name="l00071"></a> 71 void setValue(const std::string&amp; pVar,double pValue) { setValueDouble(pVar,pValue); };

<a id="l00072" name="l00072"></a> 72 

<a id="l00073" name="l00073"></a> 73 // Simple, Sequence, Parametric, Transient

<a id="l00074" name="l00074"></a> 74 enum RunOutputType { Simple, Sequence, Parametric, Transient, Steady, RO_Other };

<a id="l00075" name="l00075"></a> 75 

<a id="l00076" name="l00076"></a> 76 bool setRunOutputType(RunOutputType pType);

<a id="l00077" name="l00077"></a> 77 RunOutputType getRunOutputType() const;

<a id="l00078" name="l00078"></a> 78 std::string getRunOutputTypeAsString() const;

<a id="l00079" name="l00079"></a> 79 

<a id="l00080" name="l00080"></a> 80 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getCase() const;

<a id="l00081" name="l00081"></a> 81 

<a id="l00082" name="l00082"></a> 82 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) newOutput(std::string pName = "");

<a id="l00083" name="l00083"></a> 83 std::vector&lt;Iterator&gt; getResultIterators(const std::string&amp; pType,

<a id="l00084" name="l00084"></a> 84 const std::string&amp; pSubtype) const;

<a id="l00085" name="l00085"></a> 85 std::vector&lt;Result&gt; getResults(const std::string&amp; pType,

<a id="l00086" name="l00086"></a> 86 const std::string&amp; pSubtype) const;

<a id="l00087" name="l00087"></a> 87 std::vector&lt;Iterator&gt; getOutputIterators() const;

<a id="l00088" name="l00088"></a> 88 std::vector&lt;Output&gt; getOutputs() const;

<a id="l00089" name="l00089"></a> 89 

<a id="l00090" name="l00090"></a> 90 // Shorthand operators for currentOutput

<a id="l00091" name="l00091"></a> 91 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getData();

<a id="l00092" name="l00092"></a> 92 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getResult(const std::string&amp; pDataType);

<a id="l00093" name="l00093"></a> 93 

<a id="l00094" name="l00094"></a> 94 void setCurrentOutput([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pOutput);

<a id="l00095" name="l00095"></a> 95 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getCurrentOutput() const;

<a id="l00096" name="l00096"></a> 96 

<a id="l00097" name="l00097"></a> 97 std::vector&lt;std::string&gt; getResultTypes() const;

<a id="l00098" name="l00098"></a> 98 

<a id="l00100" name="l00100"></a> 100 [Error](classansys_1_1_project_1_1_error.xhtml) getTransientOutputs(const std::string&amp; pResultType,

<a id="l00101" name="l00101"></a> 101 std::vector&lt;Iterator&gt;&amp; pOutIterators,

<a id="l00102" name="l00102"></a> 102 std::vector&lt;double&gt;&amp; pOutTimeval) const;

<a id="l00103" name="l00103"></a> 103 

<a id="l00104" name="l00104"></a> 104 // Sequence query

<a id="l00105" name="l00105"></a> 105 enum OutputSequenceOrder {

<a id="l00106" name="l00106"></a> 106 CreationID,

<a id="l00107" name="l00107"></a> 107 MonotonicIncreasing,

<a id="l00108" name="l00108"></a> 108 Increasing,

<a id="l00109" name="l00109"></a> 109 IncreasingUnique,

<a id="l00110" name="l00110"></a> 110 Decreasing,

<a id="l00111" name="l00111"></a> 111 DecreasingUnique

<a id="l00112" name="l00112"></a> 112 };

<a id="l00113" name="l00113"></a> 113 [Error](classansys_1_1_project_1_1_error.xhtml) getOutputSequence( OutputSequenceOrder pOrder,

<a id="l00114" name="l00114"></a> 114 std::string pVariable,

<a id="l00115" name="l00115"></a> 115 std::vector&lt;Output&gt;&amp; pOutputs) const;

<a id="l00116" name="l00116"></a> 116 

<a id="l00117" name="l00117"></a> 117 enum OutputMatchOperator {

<a id="l00118" name="l00118"></a> 118 Equal,

<a id="l00119" name="l00119"></a> 119 Greater,

<a id="l00120" name="l00120"></a> 120 GreaterEqual,

<a id="l00121" name="l00121"></a> 121 Smaller,

<a id="l00122" name="l00122"></a> 122 SmallerEqual

<a id="l00123" name="l00123"></a> 123 };

<a id="l00124" name="l00124"></a> 124 std::vector&lt;Output&gt; getOutputsMatching ( std::string pVariable,

<a id="l00125" name="l00125"></a> 125 OutputMatchOperator pOperator,

<a id="l00126" name="l00126"></a> 126 double pValue ) const;

<a id="l00127" name="l00127"></a> 127 [Error](classansys_1_1_project_1_1_error.xhtml) removeOutputs(const std::vector&lt;Output&gt;&amp; pOut,bool pEraseFiles);

<a id="l00128" name="l00128"></a> 128 

<a id="l00129" name="l00129"></a> 129 // RunStatus

<a id="l00130" name="l00130"></a> 130 void setRunStatus(RunStatus pStatus);

<a id="l00131" name="l00131"></a> 131 RunStatus getRunStatus() const;

<a id="l00132" name="l00132"></a> 132 

<a id="l00133" name="l00133"></a> 133 static std::string runStatusToString(RunStatus pStatus);

<a id="l00134" name="l00134"></a> 134 static RunStatus stringToRunStatus(const std::string&amp; pStr);

<a id="l00135" name="l00135"></a> 135 

<a id="l00136" name="l00136"></a> 136 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getIterator() const { return [SimBase::getIterator](classansys_1_1_project_1_1_sim_base.xhtml#a16f3c24244ab0ec6587d945785c7718d)(); }

<a id="l00137" name="l00137"></a> 137protected:

<a id="l00138" name="l00138"></a> 138 [Run](classansys_1_1_project_1_1_run.xhtml)([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter,const std::string&amp; pSubclass);

<a id="l00139" name="l00139"></a> 139 

<a id="l00140" name="l00140"></a> 140};

<a id="l00141" name="l00141"></a> 141 

<a id="l00142" name="l00142"></a> 142}

<a id="l00143" name="l00143"></a> 143}

<a id="l00144" name="l00144"></a> 144 

<a id="l00145" name="l00145"></a> 145\#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::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml)

Base class for Run, Output, Result - provide built-in variable set/get functions.

**Definition:** RunOutputAttr.hpp:13



[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::SimBase](classansys_1_1_project_1_1_sim_base.xhtml)

Base class for Run and Simulation - shared functions.

**Definition:** SimBase.hpp:13



[ansys::Project::SimBase::getIterator](classansys_1_1_project_1_1_sim_base.xhtml#a16f3c24244ab0ec6587d945785c7718d)

virtual Iterator getIterator() const

Access the Iterator for this item.

**Definition:** SimBase.cpp:340



[ansys](namespaceansys.xhtml)

**Definition:** API.dox:1