## On this page

  

 

 # ansys::Project::Run Class Reference

 Last update: 16.07.2025 

Subfolder of a [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders."), regrouping Output/Result for a step. [More...](classansys_1_1_project_1_1_run.xhtml#details)

`#include "<a class="el" href="_run_8hpp_source.xhtml">Run.hpp</a>"`

Inheritance diagram for ansys::Project::Run:

 ![](/sites/default/files/migrate-content/common_fluids_format_/classansys_1_1_project_1_1_run.png)



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

 [Run](classansys_1_1_project_1_1_run.xhtml#a059d6e7b7a08a691efe82ca41d6e4a21) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter) Constructor from [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.").   
[More...](classansys_1_1_project_1_1_run.xhtml#a059d6e7b7a08a691efe82ca41d6e4a21)  
 <a id="a50461d0ef3487601fd73f740cee85348" name="a50461d0ef3487601fd73f740cee85348"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **isValid** () const Returns error with message if invalid.   
 bool [addVariable](classansys_1_1_project_1_1_run.xhtml#ab4e9f4d0c7f6e9747451330dc698c5bc) (const std::string &amp;pVar) Register an input variable for this run. [More...](classansys_1_1_project_1_1_run.xhtml#ab4e9f4d0c7f6e9747451330dc698c5bc)  
 bool [setVariables](classansys_1_1_project_1_1_run.xhtml#a2e8493f21a92ce378d4bce82d0cb7b3f) (const std::vector&lt; std::string &gt; &amp;pVars) Set/replace the list of variables for this run. [More...](classansys_1_1_project_1_1_run.xhtml#a2e8493f21a92ce378d4bce82d0cb7b3f)  
 bool [removeVariable](classansys_1_1_project_1_1_run.xhtml#a54114201475287073e786d77e3718383) (const std::string &amp;pVar) Remove a variable from the list of inputs. [More...](classansys_1_1_project_1_1_run.xhtml#a54114201475287073e786d77e3718383)  
 <a id="aebee6c00a322bbcccc5659453699d929" name="aebee6c00a322bbcccc5659453699d929"></a>std::vector&lt; std::string &gt; **getVariables** () const Return the list of input variables for this [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.").   
 <a id="a1c1f4337c98f47fa7af2bcc3eba4fe56" name="a1c1f4337c98f47fa7af2bcc3eba4fe56"></a>std::vector&lt; std::vector&lt; std::string &gt; &gt; **getValues** (const std::vector&lt; std::string &gt; &amp;pVars) const Return the list of values -one per output- for a list of variables.   
 bool [addOutputVariable](classansys_1_1_project_1_1_run.xhtml#aa84a2103fc117a256bab7cce5fef9780) (const std::string &amp;pVar) Register an output variable for this run. [More...](classansys_1_1_project_1_1_run.xhtml#aa84a2103fc117a256bab7cce5fef9780)  
 <a id="a1593a20a772c53baf1af273ab63f0a53" name="a1593a20a772c53baf1af273ab63f0a53"></a>bool **setOutputVariables** (const std::vector&lt; std::string &gt; &amp;pVars) Set/replace the list of output variables.   
 <a id="ae3d5f185d577c43e2ed2721f18212c35" name="ae3d5f185d577c43e2ed2721f18212c35"></a>bool **removeOutputVariable** (const std::string &amp;pVar) Remove an output variable.   
 <a id="aa85ce4557dbb6edd648e2e4d68c60ab6" name="aa85ce4557dbb6edd648e2e4d68c60ab6"></a>std::vector&lt; std::string &gt; **getOutputVariables** () const Returns the list of output variables.   
 <a id="ae5c21c8fb9320c241809e969717c4360" name="ae5c21c8fb9320c241809e969717c4360"></a>std::vector&lt; std::string &gt; **getAllVariables** () const Returns the list of all variables ( input and output )   
 <a id="a8ba482e260f6846c1a59cd8848341601" name="a8ba482e260f6846c1a59cd8848341601"></a>void **addVarIndex** () Add the Index variable (not required if mandatory for the run type)   
 <a id="a03c7998829a5b7f7fe8be10be1474e7c" name="a03c7998829a5b7f7fe8be10be1474e7c"></a>void **addVarTime** () Add the Time variable (not required if mandatory for the run type)   
 <a id="a322c24066e5f30512865a58bd7b01c43" name="a322c24066e5f30512865a58bd7b01c43"></a>void **addVarSolverIteration** () Add the SolverIteration variable (not required if mandatory for the run type)   
 <a id="a518fcda2b9be5b8c2278981784e0f574" name="a518fcda2b9be5b8c2278981784e0f574"></a>void **addVarCrankAngle** () Add the built-in variable.   
 <a id="ac89b098f5fe66841a9b538617e7b3f87" name="ac89b098f5fe66841a9b538617e7b3f87"></a>void **addVarMeshId** () Add the MeshId variable - Id should be incremented when the mesh has changed.   
 <a id="af1b52a763e5fc10f7ad5f350767ae945" name="af1b52a763e5fc10f7ad5f350767ae945"></a>void **addVarDomainTransformationId** () Add the DomainTransformationId variable - Id should be incremented when the mesh transformation metadata has changed.   
 <a id="ab2c162b2db99da7a0ae0a33f34fc4ad9" name="ab2c162b2db99da7a0ae0a33f34fc4ad9"></a>void **addVarPhysicsId** () Add the PhysicsId variable - Id should be incremented when the physics settings have changed.   
 <a id="a5bf38019a16ca06c2fc3500e5c9fe0a5" name="a5bf38019a16ca06c2fc3500e5c9fe0a5"></a>void **addVarTopologyId** () Add the TopologyId variable - Id should be incremented when the topology (list of boundaries, domains) has changed.   
 <a id="a32464d38b59f71688e99b311de6ce564" name="a32464d38b59f71688e99b311de6ce564"></a>void **addVarCoordinatesId** () Add the CoordinatesId variable - Id should be incremented when the node locations of a mesh have changed.   
 <a id="a23d9e9667605c6b6b4acac250880363c" name="a23d9e9667605c6b6b4acac250880363c"></a>void **addVarLocationId** () Add the LocationId variable - Id should be incremented when the node locations of a mesh have changed.   
 <a id="a376c18baaecfbce85fa4e637e71c0e5b" name="a376c18baaecfbce85fa4e637e71c0e5b"></a>void **addVarConnectivityId** () Add the ConnectivityId variable - Id should be incremented when the cells of a mesh are changed (number changed, connectivity changed, ...)   
 <a id="a1a825e5d408a51ac0ad6ee804e2e411e" name="a1a825e5d408a51ac0ad6ee804e2e411e"></a>void **addVarCaseId** () Add the CaseId variable - Id is incremented when the case settings are changed.   
 void [addVarInputSettingsId](classansys_1_1_project_1_1_run.xhtml#ad1cb2f559eef2c4960300dc23eb06d14) () Add the InputSettings variable - Id is incremented when the input case settings are changed. [More...](classansys_1_1_project_1_1_run.xhtml#ad1cb2f559eef2c4960300dc23eb06d14)  
 <a id="aebad5a9f951bc07891bef662aed6ada1" name="aebad5a9f951bc07891bef662aed6ada1"></a>void **addVarOutputSettingsId** () Add the OutputSettings variable - Id is incremented when the case output settings are changed.   
 <a id="a21b5000b59ddc0b3e5358a71788b4372" name="a21b5000b59ddc0b3e5358a71788b4372"></a>[Error](classansys_1_1_project_1_1_error.xhtml) **computeIds** () Compute missing ids (CaseId, MeshId, InputSettingsId) from their dependencies.   
 virtual bool [hasValue](classansys_1_1_project_1_1_run.xhtml#a35e08d90534a5657f0143f16eb34dd17) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key. [More...](classansys_1_1_project_1_1_run.xhtml#a35e08d90534a5657f0143f16eb34dd17)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getValueIter](classansys_1_1_project_1_1_run.xhtml#a6135fdcc5bbae0c3585df65567d22d44) (const std::string &amp;pVar) const Search the metadata (local and inherited) for the specified metadata link and return the value as an iterator. [More...](classansys_1_1_project_1_1_run.xhtml#a6135fdcc5bbae0c3585df65567d22d44)  
 virtual std::string [getValue](classansys_1_1_project_1_1_run.xhtml#a962cdcaba827890a9176f8855becdf1d) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key and return the value as string. [More...](classansys_1_1_project_1_1_run.xhtml#a962cdcaba827890a9176f8855becdf1d)  
 virtual int [getValueInt](classansys_1_1_project_1_1_run.xhtml#a0bdeb0b28847ad82bc58ed85324fee7d) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key and return the value as integer. [More...](classansys_1_1_project_1_1_run.xhtml#a0bdeb0b28847ad82bc58ed85324fee7d)  
 virtual double [getValueDouble](classansys_1_1_project_1_1_run.xhtml#a4bce1249dc59e6b03876822c44d9c411) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key and return the value as double. [More...](classansys_1_1_project_1_1_run.xhtml#a4bce1249dc59e6b03876822c44d9c411)  
 virtual MetaVariableType [getValueType](classansys_1_1_project_1_1_run.xhtml#af67830c86d8f3534ad3eafd273133449) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key and return the its data type. [More...](classansys_1_1_project_1_1_run.xhtml#af67830c86d8f3534ad3eafd273133449)  
 <a id="a52c78a77c9e136a085d167696015ef67" name="a52c78a77c9e136a085d167696015ef67"></a>virtual void **setValue** (const std::string &amp;pVar, const std::string &amp;pValue) Sets the local metadata to the specified key/value.   
 <a id="ac6c679b970edcb372074503caf6cf28f" name="ac6c679b970edcb372074503caf6cf28f"></a>virtual void **setValueInt** (const std::string &amp;pVar, int pValue) Sets the local metadata to the specified key/value.   
 <a id="a8680de9348c3c07a2da4a56752fe15b7" name="a8680de9348c3c07a2da4a56752fe15b7"></a>virtual void **setValueDouble** (const std::string &amp;pVar, double pValue) Sets the local metadata to the specified key/value.   
 <a id="aa064a0d1e7ab2c233dabb81058acb8ef" name="aa064a0d1e7ab2c233dabb81058acb8ef"></a>bool **setRunOutputType** (RunOutputType pType) Set the run output type, will add automatically the mandatory variables (if any)   
 <a id="aee0d6fd3d0249f5536d45886bc9ad403" name="aee0d6fd3d0249f5536d45886bc9ad403"></a>RunOutputType **getRunOutputType** () const Return the RunOutputType as the enum.   
 <a id="a77a5212218cb0dde90bccf6597c0d8d4" name="a77a5212218cb0dde90bccf6597c0d8d4"></a>std::string **getRunOutputTypeAsString** () const Return the RunOutputType as a string.   
 <a id="afe453b6378308de553307d3f8ee7c097" name="afe453b6378308de553307d3f8ee7c097"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getCase** () const Returns the case file associated with this run (if any, see [setCase()](classansys_1_1_project_1_1_sim_base.xhtml#a2312d3c69d5f32a7c76bc567c942e945 "Set the case file associated with this item."))   
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [newOutput](classansys_1_1_project_1_1_run.xhtml#aaeb71b843001780a33dfb0fb0431d6ae) (std::string pName="") Create a [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") folder in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folder. [More...](classansys_1_1_project_1_1_run.xhtml#aaeb71b843001780a33dfb0fb0431d6ae)  
 std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; [getResultIterators](classansys_1_1_project_1_1_run.xhtml#a3b316c70fb211a36c97e5e0f476751f9) (const std::string &amp;pType, const std::string &amp;pSubtype) const Return the list of results in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") and [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") subfolders, as vector of [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location."). [More...](classansys_1_1_project_1_1_run.xhtml#a3b316c70fb211a36c97e5e0f476751f9)  
 std::vector&lt; [Result](classansys_1_1_project_1_1_result.xhtml) &gt; [getResults](classansys_1_1_project_1_1_run.xhtml#aa470879c4009c9d1843b175401a49ad3) (const std::string &amp;pType, const std::string &amp;pSubtype) const Return the list of results in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") and [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") subfolders. [More...](classansys_1_1_project_1_1_run.xhtml#aa470879c4009c9d1843b175401a49ad3)  
 <a id="a466b82cf69480314196d394fee869a33" name="a466b82cf69480314196d394fee869a33"></a>std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; **getOutputIterators** () const Return the list of [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), as a vector of [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.").   
 <a id="a14fb8eab76c0f3b774e0a028270b7591" name="a14fb8eab76c0f3b774e0a028270b7591"></a>std::vector&lt; [Output](classansys_1_1_project_1_1_output.xhtml) &gt; **getOutputs** () const Return the list of [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.").   
 <a id="af68c98b0b16bacb99a7c73602dd13c4c" name="af68c98b0b16bacb99a7c73602dd13c4c"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getData** () Returns the default latest data file (from the current output, main data type)   
 <a id="a6414aca871a54080580ae5723711f098" name="a6414aca871a54080580ae5723711f098"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getResult** (const std::string &amp;pDataType) Returns the current data file of specified type.   
 <a id="a70bbc0ae2005537059355ebe78f64f21" name="a70bbc0ae2005537059355ebe78f64f21"></a>void **setCurrentOutput** ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pOutput) Set the current output link for this run, typically the latest output is the current.   
 <a id="a19d68c135b428b5ec11deecab21be799" name="a19d68c135b428b5ec11deecab21be799"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getCurrentOutput** () const Return the current output link for this run, typically the latest output is the current.   
 <a id="ab924882a75ab1102498ac547b2ea6cfa" name="ab924882a75ab1102498ac547b2ea6cfa"></a>std::vector&lt; std::string &gt; **getResultTypes** () const Returns the list of available output types listed in the run Outputs.   
 [Error](classansys_1_1_project_1_1_error.xhtml) [getTransientOutputs](classansys_1_1_project_1_1_run.xhtml#a30aee2a3610ecee9a1bf3c5fa9a47892) (const std::string &amp;pResultType, std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; &amp;pOutIterators, std::vector&lt; double &gt; &amp;pOutTimeval) const For transient runs - return the list of output results and their time values. [More...](classansys_1_1_project_1_1_run.xhtml#a30aee2a3610ecee9a1bf3c5fa9a47892)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [getOutputSequence](classansys_1_1_project_1_1_run.xhtml#a8232142331a440960cd4f4f1d3d27355) (OutputSequenceOrder pOrder, std::string pVariable, std::vector&lt; [Output](classansys_1_1_project_1_1_output.xhtml) &gt; &amp;pOutputs) const Get the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") sequence, ordered by the specified parameter. [More...](classansys_1_1_project_1_1_run.xhtml#a8232142331a440960cd4f4f1d3d27355)  
 std::vector&lt; [Output](classansys_1_1_project_1_1_output.xhtml) &gt; [getOutputsMatching](classansys_1_1_project_1_1_run.xhtml#adb5b2d517a1ef5085027bcf21d521b56) (std::string pVariable, OutputMatchOperator pOperator, double pValue) const Get the list of outputs matching the specified condition. [More...](classansys_1_1_project_1_1_run.xhtml#adb5b2d517a1ef5085027bcf21d521b56)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [removeOutputs](classansys_1_1_project_1_1_run.xhtml#a8ab6c977497324635519ce88960fcba7) (const std::vector&lt; [Output](classansys_1_1_project_1_1_output.xhtml) &gt; &amp;pOut, bool pEraseFiles) Remove the specified list of [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") from the children of this run. [More...](classansys_1_1_project_1_1_run.xhtml#a8ab6c977497324635519ce88960fcba7)  
 void [setRunStatus](classansys_1_1_project_1_1_run.xhtml#ae14a2fd242ce9515baba2542a12fe493) (RunStatus pStatus) Set the RunStatus state for this [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."). [More...](classansys_1_1_project_1_1_run.xhtml#ae14a2fd242ce9515baba2542a12fe493)  
 <a id="a7482f6212a0f951dcb367a98803b33e3" name="a7482f6212a0f951dcb367a98803b33e3"></a>RunStatus **getRunStatus** () const Returns the RunStatus state for this [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."). See [setRunStatus()](classansys_1_1_project_1_1_run.xhtml#ae14a2fd242ce9515baba2542a12fe493 "Set the RunStatus state for this Run.")   
 ![-](/sites/default/files/migrate-content/common_fluids_format_/closed.png) Public Member Functions inherited from [ansys::Project::SimBase](classansys_1_1_project_1_1_sim_base.xhtml)<a id="a8aef8314dfc33a8d25e3963fa3fd07ba" name="a8aef8314dfc33a8d25e3963fa3fd07ba"></a>std::string **getName** () const Returns the object name in the project.   
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [setCase](classansys_1_1_project_1_1_sim_base.xhtml#a2312d3c69d5f32a7c76bc567c942e945) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pCaseFile) Set the case file associated with this item. [More...](classansys_1_1_project_1_1_sim_base.xhtml#a2312d3c69d5f32a7c76bc567c942e945)  
 void [setMainDataType](classansys_1_1_project_1_1_sim_base.xhtml#ac44fe199d4f2c2c7aa8be5d22353740a) (const std::string &amp;pDataType) Set the result type expected as default output for runs. [More...](classansys_1_1_project_1_1_sim_base.xhtml#ac44fe199d4f2c2c7aa8be5d22353740a)  
 <a id="a743bc36e30200c87603dedaafe1d969d" name="a743bc36e30200c87603dedaafe1d969d"></a>std::string **getMainDataType** () const Returns the result type expected as default output for runs (see: [setMainDataType()](classansys_1_1_project_1_1_sim_base.xhtml#ac44fe199d4f2c2c7aa8be5d22353740a "Set the result type expected as default output for runs.") )   
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [copyInput](classansys_1_1_project_1_1_sim_base.xhtml#aeb5ffe7267a10b465dc8c2c825195074) ([Path](classansys_1_1_project_1_1_path.xhtml) pPath, bool pInInputFolder=false) Copy the specified project file into the current folder. [More...](classansys_1_1_project_1_1_sim_base.xhtml#aeb5ffe7267a10b465dc8c2c825195074)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [setInput](classansys_1_1_project_1_1_sim_base.xhtml#a0b6fee750eeb02e8068640758c6d8b0d) ([Path](classansys_1_1_project_1_1_path.xhtml) pPath) Register a files as Input/ to this folder. [More...](classansys_1_1_project_1_1_sim_base.xhtml#a0b6fee750eeb02e8068640758c6d8b0d)  
 std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; [getInputs](classansys_1_1_project_1_1_sim_base.xhtml#a2d532a01d1f99cb76ec85e8f4908d932) ([Error](classansys_1_1_project_1_1_error.xhtml) \*pErrorPtr=0) const Return the list of registered inputs for this simulation. [More...](classansys_1_1_project_1_1_sim_base.xhtml#a2d532a01d1f99cb76ec85e8f4908d932)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getInputByType](classansys_1_1_project_1_1_sim_base.xhtml#a7eb8d0c48e61b171014c593fb63e85c6) (const std::string &amp;pType, std::string pSubtype="") const Search for a -single- input of the specified type (and optionally, subtype) [More...](classansys_1_1_project_1_1_sim_base.xhtml#a7eb8d0c48e61b171014c593fb63e85c6)  
 std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; [getInputsByType](classansys_1_1_project_1_1_sim_base.xhtml#abc3d5315d8f3a3cff217c2112b4581a1) (const std::string &amp;pType, std::string pSubtype="", [Error](classansys_1_1_project_1_1_error.xhtml) \*pErrorPtr=0) const Search for one or multiple input of the specified type (and optionally, subtype) [More...](classansys_1_1_project_1_1_sim_base.xhtml#abc3d5315d8f3a3cff217c2112b4581a1)  
 <a id="a067d578e43cf6085623921adb816d5f4" name="a067d578e43cf6085623921adb816d5f4"></a>[Metadata](classansys_1_1_project_1_1_metadata.xhtml) &amp; **getMeta** () Access the [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") [Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator."), equivalent to [getIterator()](classansys_1_1_project_1_1_sim_base.xhtml#a16f3c24244ab0ec6587d945785c7718d "Access the Iterator for this item.").[getMeta()](classansys_1_1_project_1_1_sim_base.xhtml#a067d578e43cf6085623921adb816d5f4 "Access the Iterator Metadata, equivalent to getIterator().getMeta()")   
 <a id="af6e6bd9bee7a4fe152ff2ac2f51ad8c9" name="af6e6bd9bee7a4fe152ff2ac2f51ad8c9"></a>const [Metadata](classansys_1_1_project_1_1_metadata.xhtml) &amp; **getMeta** () const Access the [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") [Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator."), equivalent to [getIterator()](classansys_1_1_project_1_1_sim_base.xhtml#a16f3c24244ab0ec6587d945785c7718d "Access the Iterator for this item.").[getMeta()](classansys_1_1_project_1_1_sim_base.xhtml#a067d578e43cf6085623921adb816d5f4 "Access the Iterator Metadata, equivalent to getIterator().getMeta()")   
 ![-](/sites/default/files/migrate-content/common_fluids_format_/closed.png) Public Member Functions inherited from [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml)<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

Subfolder of a [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders."), regrouping Output/Result for a step.

Subclass of [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location."), can be constructed from an [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location."), the [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") is ok() only if the provided iterator is of the appropriate subclass.

```
  Iterator it = prj.get("/Sim1/Run1/");
  Run run(it);
    run.ok()
```

 In a [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders."), one or multiple [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") are created, to store the simulation Results, organized in [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") subfolders. The [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") might have Metatada assigned from the settings for this computation ( reference conditions, etc. )

The expected amount of [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") in a run, and the variables expected to be defined for each [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") depends of the RunOutputType.

- Simple : Single [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.")
- Transient : One or more [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."). variable : Time
- Steady : One or more [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."). variable : SolverIteration
- Sequence : One or more [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."). variable : Index
- Parametric : One or more [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."), for a sweep of values across a list of variables.

A variable ([addVariable()](classansys_1_1_project_1_1_run.xhtml#ab4e9f4d0c7f6e9747451330dc698c5bc "Register an input variable for this run."), addVar\*()) enabled in a [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), is expected to be changed across all [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") subfolders. Its related to the input settings, or the context of a result (for example, the solver iteration or time step) Additional variables can be added, in addition to the mandatory variables from the RunOutputType

[Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") variables ([addOutputVariable()](classansys_1_1_project_1_1_run.xhtml#aa84a2103fc117a256bab7cce5fef9780 "Register an output variable for this run.")) are values computed from that result, they might be from monitors or probe points.

```
 Run run(it);
 run.setRunOutputType(Run::Transient);
 // Time is the automatic -mandatory- variable for Transient run type
 run.addOutputVariable("probe-temperature");
 Output o = run.newOutput("")
 o.setTime(0.);
 o.newResult("out.00000001.dat","","Result","fluent-dat");
 o.setValue("probe-temperature",277.64);
 o = run.newOutput("")
 o.setTime(0.1);
 o.newResult("out.00000002.dat","","Result","fluent-dat");
 o.setValue("probe-temperature",278.822);
```

 Variable values assigned to the [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") will be inherited by all underlying [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") and [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") children.



## Constructor &amp; Destructor Documentation

<a id="a059d6e7b7a08a691efe82ca41d6e4a21" name="a059d6e7b7a08a691efe82ca41d6e4a21"></a>## [◆ ](#a059d6e7b7a08a691efe82ca41d6e4a21)Run()

 ansys::Project::Run::Run  ( [Iterator](classansys_1_1_project_1_1_iterator.xhtml)  *pIter*) 

Constructor from [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.").

The input [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") must be of subclass [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") If the subclass is not [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), the [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") object is invalid ( !ok() )





## Member Function Documentation

<a id="aa84a2103fc117a256bab7cce5fef9780" name="aa84a2103fc117a256bab7cce5fef9780"></a>## [◆ ](#aa84a2103fc117a256bab7cce5fef9780)addOutputVariable()

 bool ansys::Project::Run::addOutputVariable  ( const std::string &amp;  *pVar*) 

Register an output variable for this run.

All [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") subfolders should define a specific value for this variable.





<a id="ab4e9f4d0c7f6e9747451330dc698c5bc" name="ab4e9f4d0c7f6e9747451330dc698c5bc"></a>## [◆ ](#ab4e9f4d0c7f6e9747451330dc698c5bc)addVariable()

 bool ansys::Project::Run::addVariable  ( const std::string &amp;  *pVar*) 

Register an input variable for this run.

This registration is not required for automatic variables (Transient=Time, etc.)

All [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") subfolders should define a specific value for this variable.





<a id="ad1cb2f559eef2c4960300dc23eb06d14" name="ad1cb2f559eef2c4960300dc23eb06d14"></a>## [◆ ](#ad1cb2f559eef2c4960300dc23eb06d14)addVarInputSettingsId()

 void ansys::Project::Run::addVarInputSettingsId  ( ) 

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

If provided, this should be incremented when any of the dependent input settings are changed, such as PhysicsId or DomainTransformationId





<a id="a8232142331a440960cd4f4f1d3d27355" name="a8232142331a440960cd4f4f1d3d27355"></a>## [◆ ](#a8232142331a440960cd4f4f1d3d27355)getOutputSequence()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::Run::getOutputSequence  ( OutputSequenceOrder  *pOrder*,    std::string  *pVariable*,    std::vector&lt; [Output](classansys_1_1_project_1_1_output.xhtml) &gt; &amp;  *pOutputs*   )  const

Get the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") sequence, ordered by the specified parameter.

Retrieve the output list, as ordered by a specific recipe and based on the value of a variable.

The default getOutput() will return the outputs as ordered by their creation order. In a simple transient or steady run, this will be sufficient to get the ordered datasets. Transient postprocessing typically assumes a monotonic (increasing, unique values) sequence. Parametric runs might have their dataset generated in any order, and a sorted list of outputs might be desirable.

Parameters pOrcer: Indicate the order of the outputs- CreationID : Order by creation index, the pVariable argument is unused
- MonotonicIncreasing : Strictly increating sequence of values for the specified variable. If the sequence reverts to a prior step, only the newer values are returned. 1,2,\[3,4,5\]{3,4,5,6} -&gt; 1,2,{3,4,5,6}
- Increasing : Outputs are sorted by the specified variable low to high value
- IncreasingUnique : As Increasing, but duplicates are removed in case of duplicate, the newest entry is kept.
- Decreasing : Outputs are sorted by the specified variable high to low value
- DecreasingUnique : As Increasing, but duplicates are removed in case of duplicate, the newest entry is kept.

pVariable: Variable name to use in comparison Must be an integer or floating point property. The variable must be defined for all outputs.[RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml "Base class for Run, Output, Result - provide built-in variable set/get functions.") contains the list of standard variable names See: RunOutputAttr::sVarTime, RunOutputAttr::sVarSolverIteration, etc.

Parameters pOutputs: Array with [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") ordered as specifiedReturns: [Error](classansys_1_1_project_1_1_error.xhtml "The return state / error value of a Project function call.") in case of unknown variable or invalid parameters 



<a id="adb5b2d517a1ef5085027bcf21d521b56" name="adb5b2d517a1ef5085027bcf21d521b56"></a>## [◆ ](#adb5b2d517a1ef5085027bcf21d521b56)getOutputsMatching()

 std::vector&lt; [Output](classansys_1_1_project_1_1_output.xhtml) &gt; ansys::Project::Run::getOutputsMatching  ( std::string  *pVariable*,    OutputMatchOperator  *pOperator*,    double  *pValue*   )  const

Get the list of outputs matching the specified condition.

Returns the subset of outputs matching the specified condition, the outputs will not have any specified order. See also [getOutputSequence()](classansys_1_1_project_1_1_run.xhtml#a8232142331a440960cd4f4f1d3d27355 "Get the Output sequence, ordered by the specified parameter.")

Parameters pVariable: Name of the variable to checkpOperator: Operator to usepValue: Value for comparison 



<a id="a3b316c70fb211a36c97e5e0f476751f9" name="a3b316c70fb211a36c97e5e0f476751f9"></a>## [◆ ](#a3b316c70fb211a36c97e5e0f476751f9)getResultIterators()

 std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; ansys::Project::Run::getResultIterators  ( const std::string &amp;  *pType*,    const std::string &amp;  *pSubtype*   )  const

Return the list of results in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") and [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") subfolders, as vector of [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.").

Parameters pTypeThe type queried. Typically "Result" pSubtypeThe ResultType queried (for example "fluent-dat") 



<a id="aa470879c4009c9d1843b175401a49ad3" name="aa470879c4009c9d1843b175401a49ad3"></a>## [◆ ](#aa470879c4009c9d1843b175401a49ad3)getResults()

 std::vector&lt; [Result](classansys_1_1_project_1_1_result.xhtml) &gt; ansys::Project::Run::getResults  ( const std::string &amp;  *pType*,    const std::string &amp;  *pSubtype*   )  const

Return the list of results in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") and [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") subfolders.

Parameters pTypeThe type queried. Typically "Result" pSubtypeThe ResultType queried (for example "fluent-dat") 



<a id="a30aee2a3610ecee9a1bf3c5fa9a47892" name="a30aee2a3610ecee9a1bf3c5fa9a47892"></a>## [◆ ](#a30aee2a3610ecee9a1bf3c5fa9a47892)getTransientOutputs()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::Run::getTransientOutputs  ( const std::string &amp;  *pResultType*,    std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; &amp;  *pOutIterators*,    std::vector&lt; double &gt; &amp;  *pOutTimeval*   )  const

For transient runs - return the list of output results and their time values.

The output runs are processed to return a monotonic (increasing, unique values) sequence (see [getOutputSequence()](classansys_1_1_project_1_1_run.xhtml#a8232142331a440960cd4f4f1d3d27355 "Get the Output sequence, ordered by the specified parameter.")). For each output of that sequence, if a result of the specified type exist, its returned alongside with the time value.

Parameters pResultTypeFile type (ResultType metadata) of the result querypOutIterators(output) pOutTimeval(output) 



<a id="a962cdcaba827890a9176f8855becdf1d" name="a962cdcaba827890a9176f8855becdf1d"></a>## [◆ ](#a962cdcaba827890a9176f8855becdf1d)getValue()

 std::string ansys::Project::Run::getValue  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key and return the value as string.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="a4bce1249dc59e6b03876822c44d9c411" name="a4bce1249dc59e6b03876822c44d9c411"></a>## [◆ ](#a4bce1249dc59e6b03876822c44d9c411)getValueDouble()

 double ansys::Project::Run::getValueDouble  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key and return the value as double.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="a0bdeb0b28847ad82bc58ed85324fee7d" name="a0bdeb0b28847ad82bc58ed85324fee7d"></a>## [◆ ](#a0bdeb0b28847ad82bc58ed85324fee7d)getValueInt()

 int ansys::Project::Run::getValueInt  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key and return the value as integer.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="a6135fdcc5bbae0c3585df65567d22d44" name="a6135fdcc5bbae0c3585df65567d22d44"></a>## [◆ ](#a6135fdcc5bbae0c3585df65567d22d44)getValueIter()

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

Search the metadata (local and inherited) for the specified metadata link and return the value as an iterator.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally 



<a id="af67830c86d8f3534ad3eafd273133449" name="af67830c86d8f3534ad3eafd273133449"></a>## [◆ ](#af67830c86d8f3534ad3eafd273133449)getValueType()

 MetaVariableType ansys::Project::Run::getValueType  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key and return the its data type.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="a35e08d90534a5657f0143f16eb34dd17" name="a35e08d90534a5657f0143f16eb34dd17"></a>## [◆ ](#a35e08d90534a5657f0143f16eb34dd17)hasValue()

 bool ansys::Project::Run::hasValue  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="aaeb71b843001780a33dfb0fb0431d6ae" name="aaeb71b843001780a33dfb0fb0431d6ae"></a>## [◆ ](#aaeb71b843001780a33dfb0fb0431d6ae)newOutput()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Run::newOutput  ( std::string  *pName* = `""`) 

Create a [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") folder in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folder.

The [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") folder is by default a virtual (project-only) folder and no folder is created in the filesystem. By default, all [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") owned by a Run/Output are stored in the same disk folder, but the [Project](classansys_1_1_project_1_1_project.xhtml "Base class for Project API, also see SimProject.") structure regroup each group of [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") in an [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") block.

Parameters pName: Name of the output folder , use "" to have a default automatic name generated ( o###### ) 



<a id="a8ab6c977497324635519ce88960fcba7" name="a8ab6c977497324635519ce88960fcba7"></a>## [◆ ](#a8ab6c977497324635519ce88960fcba7)removeOutputs()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::Run::removeOutputs  ( const std::vector&lt; [Output](classansys_1_1_project_1_1_output.xhtml) &gt; &amp;  *pOut*,    bool  *pEraseFiles*   ) 

Remove the specified list of [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") from the children of this run.

Parameters pEraseFilesIf true, the associated files to the outputs will be erased 



<a id="a54114201475287073e786d77e3718383" name="a54114201475287073e786d77e3718383"></a>## [◆ ](#a54114201475287073e786d77e3718383)removeVariable()

 bool ansys::Project::Run::removeVariable  ( const std::string &amp;  *pVar*) 

Remove a variable from the list of inputs.

Mandatory variables cannot be removed





<a id="ae14a2fd242ce9515baba2542a12fe493" name="ae14a2fd242ce9515baba2542a12fe493"></a>## [◆ ](#ae14a2fd242ce9515baba2542a12fe493)setRunStatus()

 void ansys::Project::Run::setRunStatus  ( RunStatus  *pStatus*) 

Set the RunStatus state for this [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.").

(Optional API) The run status permits to indicate if a [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") is running, completed, waiting for execution, etc. This status can also be defined at the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") level





<a id="a2e8493f21a92ce378d4bce82d0cb7b3f" name="a2e8493f21a92ce378d4bce82d0cb7b3f"></a>## [◆ ](#a2e8493f21a92ce378d4bce82d0cb7b3f)setVariables()

 bool ansys::Project::Run::setVariables  ( const std::vector&lt; std::string &gt; &amp;  *pVars*) 

Set/replace the list of variables for this run.

The operation will fail if the list of variables does not contain the mandatory variable for the RunOutputType

All [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") subfolders should define a specific value for each variable.