## 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 "Run.hpp"`

Inheritance diagram for ansys::Project::Run:

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



## <a id="pub-types" name="pub-types"></a>Public Types

enum [RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) {   
 [Simple](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092ad3c7bfa5c0f8f3d0d281a54607215a38), [Sequence](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092ad8be5910edf9e2e9d5e80c360705eeb0), [Parametric](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092aa4307cae31ee174df91b2604e5d3ccac), [Transient](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092a5b5302bf1e3502dfb80a5f9be3fdb6ec),   
 [Steady](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092a581345abab9602dc3a5e9991f90d4e04), [RO\_Other](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092a47fab94a5543d693d361deb368e14aeb)  
 } enum [OutputSequenceOrder](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041) {   
 [CreationID](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041ac33e264a565ddf6dfe2aad216bae556c), [MonotonicIncreasing](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041ad3d20eb4d5b1878db79cde173a126b9d), [Increasing](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041a2f156cb9029be01b4e275e451eb19259), [IncreasingUnique](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041a990831c6364d519073f2255d9f11bc5a),   
 [Decreasing](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041ae7766c0a42456edb0ff06da5b00e8ca3), [DecreasingUnique](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041a53e4f7bed3476433e99a6160b1d785d8)  
 } enum [OutputMatchOperator](classansys_1_1_project_1_1_run.xhtml#ab2fbdaed6b5ec4a4a5ff52df8a64b86d) {   
 [Equal](classansys_1_1_project_1_1_run.xhtml#ab2fbdaed6b5ec4a4a5ff52df8a64b86da5f560b124e16e1056c8a7c5bbc553b1a), [Greater](classansys_1_1_project_1_1_run.xhtml#ab2fbdaed6b5ec4a4a5ff52df8a64b86da1e5f7fe4930da6d15dae25ab401d483f), [GreaterEqual](classansys_1_1_project_1_1_run.xhtml#ab2fbdaed6b5ec4a4a5ff52df8a64b86dabd84e383b095837450c4d17eeb10e66a), [Smaller](classansys_1_1_project_1_1_run.xhtml#ab2fbdaed6b5ec4a4a5ff52df8a64b86dab0ec762d5365514edb27f28dd4c9d46f),   
 [SmallerEqual](classansys_1_1_project_1_1_run.xhtml#ab2fbdaed6b5ec4a4a5ff52df8a64b86da55f71554265fa2b739c33e46cf5bd26e)  
 } ## <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)  
 virtual [~Run](classansys_1_1_project_1_1_run.xhtml#abb309286a6b97932221d6d69e6c9b508) () virtual [Error](classansys_1_1_project_1_1_error.xhtml) [isValid](classansys_1_1_project_1_1_run.xhtml#a50461d0ef3487601fd73f740cee85348) () const Returns error with message if invalid. [More...](classansys_1_1_project_1_1_run.xhtml#a50461d0ef3487601fd73f740cee85348)  
 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)  
 std::vector&lt; std::string &gt; [getVariables](classansys_1_1_project_1_1_run.xhtml#aebee6c00a322bbcccc5659453699d929) () 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."). [More...](classansys_1_1_project_1_1_run.xhtml#aebee6c00a322bbcccc5659453699d929)  
 std::vector&lt; std::vector&lt; std::string &gt; &gt; [getValues](classansys_1_1_project_1_1_run.xhtml#a1c1f4337c98f47fa7af2bcc3eba4fe56) (const std::vector&lt; std::string &gt; &amp;pVars) const Return the list of values -one per output- for a list of variables. [More...](classansys_1_1_project_1_1_run.xhtml#a1c1f4337c98f47fa7af2bcc3eba4fe56)  
 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)  
 bool [setOutputVariables](classansys_1_1_project_1_1_run.xhtml#a1593a20a772c53baf1af273ab63f0a53) (const std::vector&lt; std::string &gt; &amp;pVars) Set/replace the list of output variables. [More...](classansys_1_1_project_1_1_run.xhtml#a1593a20a772c53baf1af273ab63f0a53)  
 bool [removeOutputVariable](classansys_1_1_project_1_1_run.xhtml#ae3d5f185d577c43e2ed2721f18212c35) (const std::string &amp;pVar) Remove an output variable. [More...](classansys_1_1_project_1_1_run.xhtml#ae3d5f185d577c43e2ed2721f18212c35)  
 std::vector&lt; std::string &gt; [getOutputVariables](classansys_1_1_project_1_1_run.xhtml#aa85ce4557dbb6edd648e2e4d68c60ab6) () const Returns the list of output variables. [More...](classansys_1_1_project_1_1_run.xhtml#aa85ce4557dbb6edd648e2e4d68c60ab6)  
 std::vector&lt; std::string &gt; [getAllVariables](classansys_1_1_project_1_1_run.xhtml#ae5c21c8fb9320c241809e969717c4360) () const Returns the list of all variables ( input and output ) [More...](classansys_1_1_project_1_1_run.xhtml#ae5c21c8fb9320c241809e969717c4360)  
 void [addVarIndex](classansys_1_1_project_1_1_run.xhtml#a8ba482e260f6846c1a59cd8848341601) () Add the Index variable (not required if mandatory for the run type) [More...](classansys_1_1_project_1_1_run.xhtml#a8ba482e260f6846c1a59cd8848341601)  
 void [addVarTime](classansys_1_1_project_1_1_run.xhtml#a03c7998829a5b7f7fe8be10be1474e7c) () Add the Time variable (not required if mandatory for the run type) [More...](classansys_1_1_project_1_1_run.xhtml#a03c7998829a5b7f7fe8be10be1474e7c)  
 void [addVarSolverIteration](classansys_1_1_project_1_1_run.xhtml#a322c24066e5f30512865a58bd7b01c43) () Add the SolverIteration variable (not required if mandatory for the run type) [More...](classansys_1_1_project_1_1_run.xhtml#a322c24066e5f30512865a58bd7b01c43)  
 void [addVarCrankAngle](classansys_1_1_project_1_1_run.xhtml#a518fcda2b9be5b8c2278981784e0f574) () Add the built-in variable. [More...](classansys_1_1_project_1_1_run.xhtml#a518fcda2b9be5b8c2278981784e0f574)  
 void [addVarMeshId](classansys_1_1_project_1_1_run.xhtml#ac89b098f5fe66841a9b538617e7b3f87) () Add the MeshId variable - Id should be incremented when the mesh has changed. [More...](classansys_1_1_project_1_1_run.xhtml#ac89b098f5fe66841a9b538617e7b3f87)  
 void [addVarDomainTransformationId](classansys_1_1_project_1_1_run.xhtml#af1b52a763e5fc10f7ad5f350767ae945) () Add the DomainTransformationId variable - Id should be incremented when the mesh transformation metadata has changed. [More...](classansys_1_1_project_1_1_run.xhtml#af1b52a763e5fc10f7ad5f350767ae945)  
 void [addVarPhysicsId](classansys_1_1_project_1_1_run.xhtml#ab2c162b2db99da7a0ae0a33f34fc4ad9) () Add the PhysicsId variable - Id should be incremented when the physics settings have changed. [More...](classansys_1_1_project_1_1_run.xhtml#ab2c162b2db99da7a0ae0a33f34fc4ad9)  
 void [addVarTopologyId](classansys_1_1_project_1_1_run.xhtml#a5bf38019a16ca06c2fc3500e5c9fe0a5) () Add the TopologyId variable - Id should be incremented when the topology (list of boundaries, domains) has changed. [More...](classansys_1_1_project_1_1_run.xhtml#a5bf38019a16ca06c2fc3500e5c9fe0a5)  
 void [addVarCoordinatesId](classansys_1_1_project_1_1_run.xhtml#a32464d38b59f71688e99b311de6ce564) () Add the CoordinatesId variable - Id should be incremented when the node locations of a mesh have changed. [More...](classansys_1_1_project_1_1_run.xhtml#a32464d38b59f71688e99b311de6ce564)  
 void [addVarLocationId](classansys_1_1_project_1_1_run.xhtml#a23d9e9667605c6b6b4acac250880363c) () Add the LocationId variable - Id should be incremented when the node locations of a mesh have changed. [More...](classansys_1_1_project_1_1_run.xhtml#a23d9e9667605c6b6b4acac250880363c)  
 void [addVarConnectivityId](classansys_1_1_project_1_1_run.xhtml#a376c18baaecfbce85fa4e637e71c0e5b) () Add the ConnectivityId variable - Id should be incremented when the cells of a mesh are changed (number changed, connectivity changed, ...) [More...](classansys_1_1_project_1_1_run.xhtml#a376c18baaecfbce85fa4e637e71c0e5b)  
 void [addVarCaseId](classansys_1_1_project_1_1_run.xhtml#a1a825e5d408a51ac0ad6ee804e2e411e) () Add the CaseId variable - Id is incremented when the case settings are changed. [More...](classansys_1_1_project_1_1_run.xhtml#a1a825e5d408a51ac0ad6ee804e2e411e)  
 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)  
 void [addVarOutputSettingsId](classansys_1_1_project_1_1_run.xhtml#aebad5a9f951bc07891bef662aed6ada1) () Add the OutputSettings variable - Id is incremented when the case output settings are changed. [More...](classansys_1_1_project_1_1_run.xhtml#aebad5a9f951bc07891bef662aed6ada1)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [computeIds](classansys_1_1_project_1_1_run.xhtml#a21b5000b59ddc0b3e5358a71788b4372) () Compute missing ids (CaseId, MeshId, InputSettingsId) from their dependencies. [More...](classansys_1_1_project_1_1_run.xhtml#a21b5000b59ddc0b3e5358a71788b4372)  
 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)  
 virtual void [setValue](classansys_1_1_project_1_1_run.xhtml#a52c78a77c9e136a085d167696015ef67) (const std::string &amp;pVar, const std::string &amp;pValue) Sets the local metadata to the specified key/value. [More...](classansys_1_1_project_1_1_run.xhtml#a52c78a77c9e136a085d167696015ef67)  
 virtual void [setValueInt](classansys_1_1_project_1_1_run.xhtml#ac6c679b970edcb372074503caf6cf28f) (const std::string &amp;pVar, int pValue) Sets the local metadata to the specified key/value. [More...](classansys_1_1_project_1_1_run.xhtml#ac6c679b970edcb372074503caf6cf28f)  
 virtual void [setValueDouble](classansys_1_1_project_1_1_run.xhtml#a8680de9348c3c07a2da4a56752fe15b7) (const std::string &amp;pVar, double pValue) Sets the local metadata to the specified key/value. [More...](classansys_1_1_project_1_1_run.xhtml#a8680de9348c3c07a2da4a56752fe15b7)  
 void [setValue](classansys_1_1_project_1_1_run.xhtml#a0fffd5def2534f6301b8a51e28cb26c7) (const std::string &amp;pVar, int pValue) void [setValue](classansys_1_1_project_1_1_run.xhtml#ac83d3a1b9dff7af27d7431966cd33b58) (const std::string &amp;pVar, double pValue) bool [setRunOutputType](classansys_1_1_project_1_1_run.xhtml#aa064a0d1e7ab2c233dabb81058acb8ef) ([RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) pType) Set the run output type, will add automatically the mandatory variables (if any) [More...](classansys_1_1_project_1_1_run.xhtml#aa064a0d1e7ab2c233dabb81058acb8ef)  
 [RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) [getRunOutputType](classansys_1_1_project_1_1_run.xhtml#aee0d6fd3d0249f5536d45886bc9ad403) () const Return the RunOutputType as the enum. [More...](classansys_1_1_project_1_1_run.xhtml#aee0d6fd3d0249f5536d45886bc9ad403)  
 std::string [getRunOutputTypeAsString](classansys_1_1_project_1_1_run.xhtml#a77a5212218cb0dde90bccf6597c0d8d4) () const Return the RunOutputType as a string. [More...](classansys_1_1_project_1_1_run.xhtml#a77a5212218cb0dde90bccf6597c0d8d4)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getCase](classansys_1_1_project_1_1_run.xhtml#afe453b6378308de553307d3f8ee7c097) () 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.")) [More...](classansys_1_1_project_1_1_run.xhtml#afe453b6378308de553307d3f8ee7c097)  
 [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)  
 std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; [getOutputIterators](classansys_1_1_project_1_1_run.xhtml#a466b82cf69480314196d394fee869a33) () 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."). [More...](classansys_1_1_project_1_1_run.xhtml#a466b82cf69480314196d394fee869a33)  
 std::vector&lt; [Output](classansys_1_1_project_1_1_output.xhtml) &gt; [getOutputs](classansys_1_1_project_1_1_run.xhtml#a14fb8eab76c0f3b774e0a028270b7591) () 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."). [More...](classansys_1_1_project_1_1_run.xhtml#a14fb8eab76c0f3b774e0a028270b7591)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getData](classansys_1_1_project_1_1_run.xhtml#af68c98b0b16bacb99a7c73602dd13c4c) () Returns the default latest data file (from the current output, main data type) [More...](classansys_1_1_project_1_1_run.xhtml#af68c98b0b16bacb99a7c73602dd13c4c)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getResult](classansys_1_1_project_1_1_run.xhtml#a6414aca871a54080580ae5723711f098) (const std::string &amp;pDataType) Returns the current data file of specified type. [More...](classansys_1_1_project_1_1_run.xhtml#a6414aca871a54080580ae5723711f098)  
 void [setCurrentOutput](classansys_1_1_project_1_1_run.xhtml#a70bbc0ae2005537059355ebe78f64f21) ([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. [More...](classansys_1_1_project_1_1_run.xhtml#a70bbc0ae2005537059355ebe78f64f21)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getCurrentOutput](classansys_1_1_project_1_1_run.xhtml#a19d68c135b428b5ec11deecab21be799) () const Return the current output link for this run, typically the latest output is the current. [More...](classansys_1_1_project_1_1_run.xhtml#a19d68c135b428b5ec11deecab21be799)  
 std::vector&lt; std::string &gt; [getResultTypes](classansys_1_1_project_1_1_run.xhtml#ab924882a75ab1102498ac547b2ea6cfa) () const Returns the list of available output types listed in the run Outputs. [More...](classansys_1_1_project_1_1_run.xhtml#ab924882a75ab1102498ac547b2ea6cfa)  
 [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](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041) 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](classansys_1_1_project_1_1_run.xhtml#ab2fbdaed6b5ec4a4a5ff52df8a64b86d) 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)  
 RunStatus [getRunStatus](classansys_1_1_project_1_1_run.xhtml#a7482f6212a0f951dcb367a98803b33e3) () 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.") [More...](classansys_1_1_project_1_1_run.xhtml#a7482f6212a0f951dcb367a98803b33e3)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getIterator](classansys_1_1_project_1_1_run.xhtml#a6b797638d34347e6801b88c0e69e05ce) () const ![-](/sites/default/files/migrate-content/common_fluids_format_2025_r2_1/closed.png) Public Member Functions inherited from [ansys::Project::SimBase](classansys_1_1_project_1_1_sim_base.xhtml)bool [ok](classansys_1_1_project_1_1_sim_base.xhtml#a006186f7ee51c0d5548bd6cad367b032) () const std::string [getName](classansys_1_1_project_1_1_sim_base.xhtml#a8aef8314dfc33a8d25e3963fa3fd07ba) () const Returns the object name in the project. [More...](classansys_1_1_project_1_1_sim_base.xhtml#a8aef8314dfc33a8d25e3963fa3fd07ba)  
 [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)  
 std::string [getMainDataType](classansys_1_1_project_1_1_sim_base.xhtml#a743bc36e30200c87603dedaafe1d969d) () 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.") ) [More...](classansys_1_1_project_1_1_sim_base.xhtml#a743bc36e30200c87603dedaafe1d969d)  
 [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)  
 [Metadata](classansys_1_1_project_1_1_metadata.xhtml) &amp; [getMeta](classansys_1_1_project_1_1_sim_base.xhtml#a067d578e43cf6085623921adb816d5f4) () 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()") [More...](classansys_1_1_project_1_1_sim_base.xhtml#a067d578e43cf6085623921adb816d5f4)  
 const [Metadata](classansys_1_1_project_1_1_metadata.xhtml) &amp; [getMeta](classansys_1_1_project_1_1_sim_base.xhtml#af6e6bd9bee7a4fe152ff2ac2f51ad8c9) () 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()") [More...](classansys_1_1_project_1_1_sim_base.xhtml#af6e6bd9bee7a4fe152ff2ac2f51ad8c9)  
  [operator Iterator](classansys_1_1_project_1_1_sim_base.xhtml#a0625d859da2633b26505821aaf569602) () const ![-](/sites/default/files/migrate-content/common_fluids_format_2025_r2_1/closed.png) Public Member Functions inherited from [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml)virtual [~RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml#a65a0b1def1d611ef99d59910a627c6e4) () std::vector&lt; std::string &gt; [getValues](classansys_1_1_project_1_1_run_output_attr.xhtml#a3552775077206a3eb84c63548b1dce8f) (const std::vector&lt; std::string &gt; &amp;pVars, bool pFlagInherited) const Returns the values for a list of variables. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a3552775077206a3eb84c63548b1dce8f)  
 int [getIndex](classansys_1_1_project_1_1_run_output_attr.xhtml#afd9f573f991216d001360be85a476827) () const Returns the output index (incremental id in a run) - always available. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#afd9f573f991216d001360be85a476827)  
 int [getSolverIteration](classansys_1_1_project_1_1_run_output_attr.xhtml#a9341f80aeb8c06eae7405815daabc2de) () const Returns the number of solver iterations (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a9341f80aeb8c06eae7405815daabc2de)  
 double [getTime](classansys_1_1_project_1_1_run_output_attr.xhtml#a43a2d325edb0332bd89dd279da60de88) () const Returns the transient time value (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a43a2d325edb0332bd89dd279da60de88)  
 void [setIndex](classansys_1_1_project_1_1_run_output_attr.xhtml#a8e79b641bdf6cd9fa3132839b2314cfa) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a8e79b641bdf6cd9fa3132839b2314cfa)  
 void [setSolverIteration](classansys_1_1_project_1_1_run_output_attr.xhtml#a5aef7a029fa3a7f830710275035c4bae) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a5aef7a029fa3a7f830710275035c4bae)  
 void [setTime](classansys_1_1_project_1_1_run_output_attr.xhtml#a7223a840d264a500994bc1a424772c19) (double pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a7223a840d264a500994bc1a424772c19)  
 double [getCrankAngle](classansys_1_1_project_1_1_run_output_attr.xhtml#a2722c5a61bdf6ae862f77277cb799dae) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a2722c5a61bdf6ae862f77277cb799dae)  
 void [setCrankAngle](classansys_1_1_project_1_1_run_output_attr.xhtml#a399cfa854a08df9c39ed9c7324651012) (double pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a399cfa854a08df9c39ed9c7324651012)  
 int [getCaseId](classansys_1_1_project_1_1_run_output_attr.xhtml#a3c9c4e3b8a1901e526c252b9beda9580) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a3c9c4e3b8a1901e526c252b9beda9580)  
 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)  
 int [getOutputSettingsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a5b718ea67c8d4abcec38f3968ffe71f6) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a5b718ea67c8d4abcec38f3968ffe71f6)  
 int [getMeshId](classansys_1_1_project_1_1_run_output_attr.xhtml#a9b573f92ba0532e9af0181634727d876) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a9b573f92ba0532e9af0181634727d876)  
 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)  
 void [setCaseId](classansys_1_1_project_1_1_run_output_attr.xhtml#a98234a96286c594c628ae5fc66a2daf1) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a98234a96286c594c628ae5fc66a2daf1)  
 void [setInputSettingsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a4dc9c1c940983005c8aa55516c7dd370) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a4dc9c1c940983005c8aa55516c7dd370)  
 void [setDomainTransformationId](classansys_1_1_project_1_1_run_output_attr.xhtml#a48ce611d3011e8d85c7508654d10b0b7) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a48ce611d3011e8d85c7508654d10b0b7)  
 void [setPhysicsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a144923c544b7f9e25adaa02c4d0fcfb2) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a144923c544b7f9e25adaa02c4d0fcfb2)  
 void [setOutputSettingsId](classansys_1_1_project_1_1_run_output_attr.xhtml#aff075987d634ddd1bb5cc72885e60476) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#aff075987d634ddd1bb5cc72885e60476)  
 void [setMeshId](classansys_1_1_project_1_1_run_output_attr.xhtml#af6651bd327bccc3154c7a9dff550b780) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#af6651bd327bccc3154c7a9dff550b780)  
 void [setTopologyId](classansys_1_1_project_1_1_run_output_attr.xhtml#a8952ac3fb7b31862798fef375a37f789) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a8952ac3fb7b31862798fef375a37f789)  
 void [setConnectivityId](classansys_1_1_project_1_1_run_output_attr.xhtml#a2e8201893b1ffef4e96758118ac1438c) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a2e8201893b1ffef4e96758118ac1438c)  
 void [setCoordinatesId](classansys_1_1_project_1_1_run_output_attr.xhtml#a1f1a501898b6eaf181ef0b3b7a991342) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a1f1a501898b6eaf181ef0b3b7a991342)  
 void [setLocationId](classansys_1_1_project_1_1_run_output_attr.xhtml#ad49c7e9e12f20d93598d744d8c419f5c) (int pValue) Changes the specified variable. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#ad49c7e9e12f20d93598d744d8c419f5c)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrentCaseId](classansys_1_1_project_1_1_run_output_attr.xhtml#a47b791d288a9af06d565d5bacd1dd612) () const See getFirstIterator(const std::string&amp;) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a47b791d288a9af06d565d5bacd1dd612)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrentPhysicsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a05cad22c19d74259c554f2f0dc86305a) () const See getFirstIterator(const std::string&amp;) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a05cad22c19d74259c554f2f0dc86305a)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrentInputSettingsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a67d0800d2ce78055bcd9658b1ea30136) () const See getFirstIterator(const std::string&amp;) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a67d0800d2ce78055bcd9658b1ea30136)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrentDomainTransformationId](classansys_1_1_project_1_1_run_output_attr.xhtml#adbcf15409dbcf5051cc8fcb3afdf930f) () const See getFirstIterator(const std::string&amp;) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#adbcf15409dbcf5051cc8fcb3afdf930f)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrentMeshId](classansys_1_1_project_1_1_run_output_attr.xhtml#a808bda2819d90363f4914bc637969154) () const See getFirstIterator(const std::string&amp;) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a808bda2819d90363f4914bc637969154)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrentTopologyId](classansys_1_1_project_1_1_run_output_attr.xhtml#a3f53d6fb39644ef6a923d2d79baa0d12) () const See getFirstIterator(const std::string&amp;) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a3f53d6fb39644ef6a923d2d79baa0d12)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrentConnectivityId](classansys_1_1_project_1_1_run_output_attr.xhtml#ad4aecfe2ed99b6e81a24edcc8699aa42) () const See getFirstIterator(const std::string&amp;) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#ad4aecfe2ed99b6e81a24edcc8699aa42)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrentCoordinatesId](classansys_1_1_project_1_1_run_output_attr.xhtml#a2badf834ba45aa1be083272d66e68cb8) () const See getFirstIterator(const std::string&amp;) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a2badf834ba45aa1be083272d66e68cb8)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrentLocationId](classansys_1_1_project_1_1_run_output_attr.xhtml#a9c43c27adee9503eed4f3940ded66ac7) () const See getFirstIterator(const std::string&amp;) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a9c43c27adee9503eed4f3940ded66ac7)  
 [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="pub-static-methods" name="pub-static-methods"></a>Static Public Member Functions

static std::string [runStatusToString](classansys_1_1_project_1_1_run.xhtml#a004b5a97849f111dd65e68feb6a21874) (RunStatus pStatus) static RunStatus [stringToRunStatus](classansys_1_1_project_1_1_run.xhtml#ae621836b9f23de5353a3cc87afa0a899) (const std::string &amp;pStr) ## <a id="pro-methods" name="pro-methods"></a>Protected Member Functions

 [Run](classansys_1_1_project_1_1_run.xhtml#a0534e575974be1649e6990c6d5415978) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter, const std::string &amp;pSubclass) ![-](/sites/default/files/migrate-content/common_fluids_format_2025_r2_1/closed.png) Protected Member Functions inherited from [ansys::Project::SimBase](classansys_1_1_project_1_1_sim_base.xhtml) [SimBase](classansys_1_1_project_1_1_sim_base.xhtml#a818fb26085d036e187d4363696c37804) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter) virtual [~SimBase](classansys_1_1_project_1_1_sim_base.xhtml#a5f50eff2ae40bad165b140399d9143e1) () [Error](classansys_1_1_project_1_1_error.xhtml) [copyDatafileMeta](classansys_1_1_project_1_1_sim_base.xhtml#a511aa7d1e5b9a422a7bec1812b1b2851) (const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pInput, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pOutput) ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/common_fluids_format_2025_r2_1/closed.png) Static Public Attributes inherited from [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml)static const std::string [sVarTime](classansys_1_1_project_1_1_run_output_attr.xhtml#a216010dc2b5c1190a68513b1d9617af4) static const std::string [sVarSolverIteration](classansys_1_1_project_1_1_run_output_attr.xhtml#a116b763a8622a5d731756e59b90416a0) static const std::string [sVarIndex](classansys_1_1_project_1_1_run_output_attr.xhtml#accb529227d0a8af8ea6234c678172a81) static const std::string [sVarCrankAngle](classansys_1_1_project_1_1_run_output_attr.xhtml#a758d823643e8d2995709c4cd5b92bb45) static const std::string [sVarCaseId](classansys_1_1_project_1_1_run_output_attr.xhtml#a0262e064b66ae42c08b689721c25f76a) static const std::string [sVarInputSettingsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a1378a2dcbd4528f171f8e9c3aef6504f) static const std::string [sVarDomainTransformationId](classansys_1_1_project_1_1_run_output_attr.xhtml#af2a3f9fcbd8b5eb86a666d04b4b0a1ee) static const std::string [sVarPhysicsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a1bd650ac5ff709a40039f5af2448409d) static const std::string [sVarOutputSettingsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a57055413a8762182cd616134e1ebaae9) static const std::string [sVarMeshId](classansys_1_1_project_1_1_run_output_attr.xhtml#aedb3ba68ad3e7475b8691c0826cce629) static const std::string [sVarTopologyId](classansys_1_1_project_1_1_run_output_attr.xhtml#a6c7cab7452904746f93245318cb91ddd) static const std::string [sVarConnectivityId](classansys_1_1_project_1_1_run_output_attr.xhtml#a8a5a7c0fbf131833584035fb3e15e152) static const std::string [sVarCoordinatesId](classansys_1_1_project_1_1_run_output_attr.xhtml#a66a534af6f39ffe20a1a594006c8e31f) static const std::string [sVarLocationId](classansys_1_1_project_1_1_run_output_attr.xhtml#a5e75ed2d5bb13aac00fcf41087bdce22) ![-](/sites/default/files/migrate-content/common_fluids_format_2025_r2_1/closed.png) Protected Attributes inherited from [ansys::Project::SimBase](classansys_1_1_project_1_1_sim_base.xhtml)[Iterator](classansys_1_1_project_1_1_iterator.xhtml) [aIter](classansys_1_1_project_1_1_sim_base.xhtml#ae97b15e35c30f6eda557fc6dfaec2b5f) <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()](classansys_1_1_project_1_1_sim_base.xhtml#a006186f7ee51c0d5548bd6cad367b032) 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.



## Member Enumeration Documentation

<a id="ab2fbdaed6b5ec4a4a5ff52df8a64b86d" name="ab2fbdaed6b5ec4a4a5ff52df8a64b86d"></a>## [◆ ](#ab2fbdaed6b5ec4a4a5ff52df8a64b86d)OutputMatchOperator

 enum [ansys::Project::Run::OutputMatchOperator](classansys_1_1_project_1_1_run.xhtml#ab2fbdaed6b5ec4a4a5ff52df8a64b86d)

Enumerator<a id="ab2fbdaed6b5ec4a4a5ff52df8a64b86da5f560b124e16e1056c8a7c5bbc553b1a" name="ab2fbdaed6b5ec4a4a5ff52df8a64b86da5f560b124e16e1056c8a7c5bbc553b1a"></a>Equal <a id="ab2fbdaed6b5ec4a4a5ff52df8a64b86da1e5f7fe4930da6d15dae25ab401d483f" name="ab2fbdaed6b5ec4a4a5ff52df8a64b86da1e5f7fe4930da6d15dae25ab401d483f"></a>Greater <a id="ab2fbdaed6b5ec4a4a5ff52df8a64b86dabd84e383b095837450c4d17eeb10e66a" name="ab2fbdaed6b5ec4a4a5ff52df8a64b86dabd84e383b095837450c4d17eeb10e66a"></a>GreaterEqual <a id="ab2fbdaed6b5ec4a4a5ff52df8a64b86dab0ec762d5365514edb27f28dd4c9d46f" name="ab2fbdaed6b5ec4a4a5ff52df8a64b86dab0ec762d5365514edb27f28dd4c9d46f"></a>Smaller <a id="ab2fbdaed6b5ec4a4a5ff52df8a64b86da55f71554265fa2b739c33e46cf5bd26e" name="ab2fbdaed6b5ec4a4a5ff52df8a64b86da55f71554265fa2b739c33e46cf5bd26e"></a>SmallerEqual 



<a id="a6520889cda1d3d1382fc1a5992a89041" name="a6520889cda1d3d1382fc1a5992a89041"></a>## [◆ ](#a6520889cda1d3d1382fc1a5992a89041)OutputSequenceOrder

 enum [ansys::Project::Run::OutputSequenceOrder](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041)

Enumerator<a id="a6520889cda1d3d1382fc1a5992a89041ac33e264a565ddf6dfe2aad216bae556c" name="a6520889cda1d3d1382fc1a5992a89041ac33e264a565ddf6dfe2aad216bae556c"></a>CreationID <a id="a6520889cda1d3d1382fc1a5992a89041ad3d20eb4d5b1878db79cde173a126b9d" name="a6520889cda1d3d1382fc1a5992a89041ad3d20eb4d5b1878db79cde173a126b9d"></a>MonotonicIncreasing <a id="a6520889cda1d3d1382fc1a5992a89041a2f156cb9029be01b4e275e451eb19259" name="a6520889cda1d3d1382fc1a5992a89041a2f156cb9029be01b4e275e451eb19259"></a>Increasing <a id="a6520889cda1d3d1382fc1a5992a89041a990831c6364d519073f2255d9f11bc5a" name="a6520889cda1d3d1382fc1a5992a89041a990831c6364d519073f2255d9f11bc5a"></a>IncreasingUnique <a id="a6520889cda1d3d1382fc1a5992a89041ae7766c0a42456edb0ff06da5b00e8ca3" name="a6520889cda1d3d1382fc1a5992a89041ae7766c0a42456edb0ff06da5b00e8ca3"></a>Decreasing <a id="a6520889cda1d3d1382fc1a5992a89041a53e4f7bed3476433e99a6160b1d785d8" name="a6520889cda1d3d1382fc1a5992a89041a53e4f7bed3476433e99a6160b1d785d8"></a>DecreasingUnique 



<a id="a730f2ea4aef8f22f0886f12109c17092" name="a730f2ea4aef8f22f0886f12109c17092"></a>## [◆ ](#a730f2ea4aef8f22f0886f12109c17092)RunOutputType

 enum [ansys::Project::Run::RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092)

Enumerator<a id="a730f2ea4aef8f22f0886f12109c17092ad3c7bfa5c0f8f3d0d281a54607215a38" name="a730f2ea4aef8f22f0886f12109c17092ad3c7bfa5c0f8f3d0d281a54607215a38"></a>Simple <a id="a730f2ea4aef8f22f0886f12109c17092ad8be5910edf9e2e9d5e80c360705eeb0" name="a730f2ea4aef8f22f0886f12109c17092ad8be5910edf9e2e9d5e80c360705eeb0"></a>Sequence <a id="a730f2ea4aef8f22f0886f12109c17092aa4307cae31ee174df91b2604e5d3ccac" name="a730f2ea4aef8f22f0886f12109c17092aa4307cae31ee174df91b2604e5d3ccac"></a>Parametric <a id="a730f2ea4aef8f22f0886f12109c17092a5b5302bf1e3502dfb80a5f9be3fdb6ec" name="a730f2ea4aef8f22f0886f12109c17092a5b5302bf1e3502dfb80a5f9be3fdb6ec"></a>Transient <a id="a730f2ea4aef8f22f0886f12109c17092a581345abab9602dc3a5e9991f90d4e04" name="a730f2ea4aef8f22f0886f12109c17092a581345abab9602dc3a5e9991f90d4e04"></a>Steady <a id="a730f2ea4aef8f22f0886f12109c17092a47fab94a5543d693d361deb368e14aeb" name="a730f2ea4aef8f22f0886f12109c17092a47fab94a5543d693d361deb368e14aeb"></a>RO\_Other 



## Constructor &amp; Destructor Documentation

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

 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() )





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

 virtual ansys::Project::Run::~Run  ( )   inlinevirtual 





<a id="a0534e575974be1649e6990c6d5415978" name="a0534e575974be1649e6990c6d5415978"></a>## [◆ ](#a0534e575974be1649e6990c6d5415978)Run() \[2/2\]

 ansys::Project::Run::Run  ( [Iterator](classansys_1_1_project_1_1_iterator.xhtml)  *pIter*,    const std::string &amp;  *pSubclass*   )   protected 





## 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="a1a825e5d408a51ac0ad6ee804e2e411e" name="a1a825e5d408a51ac0ad6ee804e2e411e"></a>## [◆ ](#a1a825e5d408a51ac0ad6ee804e2e411e)addVarCaseId()

 void ansys::Project::Run::addVarCaseId  ( ) 

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





<a id="a376c18baaecfbce85fa4e637e71c0e5b" name="a376c18baaecfbce85fa4e637e71c0e5b"></a>## [◆ ](#a376c18baaecfbce85fa4e637e71c0e5b)addVarConnectivityId()

 void ansys::Project::Run::addVarConnectivityId  ( ) 

Add the ConnectivityId variable - Id should be incremented when the cells of a mesh are changed (number changed, connectivity changed, ...)





<a id="a32464d38b59f71688e99b311de6ce564" name="a32464d38b59f71688e99b311de6ce564"></a>## [◆ ](#a32464d38b59f71688e99b311de6ce564)addVarCoordinatesId()

 void ansys::Project::Run::addVarCoordinatesId  ( ) 

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





<a id="a518fcda2b9be5b8c2278981784e0f574" name="a518fcda2b9be5b8c2278981784e0f574"></a>## [◆ ](#a518fcda2b9be5b8c2278981784e0f574)addVarCrankAngle()

 void ansys::Project::Run::addVarCrankAngle  ( ) 

Add the built-in variable.





<a id="af1b52a763e5fc10f7ad5f350767ae945" name="af1b52a763e5fc10f7ad5f350767ae945"></a>## [◆ ](#af1b52a763e5fc10f7ad5f350767ae945)addVarDomainTransformationId()

 void ansys::Project::Run::addVarDomainTransformationId  ( ) 

Add the DomainTransformationId variable - Id should be incremented when the mesh transformation metadata has changed.





<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="a8ba482e260f6846c1a59cd8848341601" name="a8ba482e260f6846c1a59cd8848341601"></a>## [◆ ](#a8ba482e260f6846c1a59cd8848341601)addVarIndex()

 void ansys::Project::Run::addVarIndex  ( ) 

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





<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="a23d9e9667605c6b6b4acac250880363c" name="a23d9e9667605c6b6b4acac250880363c"></a>## [◆ ](#a23d9e9667605c6b6b4acac250880363c)addVarLocationId()

 void ansys::Project::Run::addVarLocationId  ( ) 

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





<a id="ac89b098f5fe66841a9b538617e7b3f87" name="ac89b098f5fe66841a9b538617e7b3f87"></a>## [◆ ](#ac89b098f5fe66841a9b538617e7b3f87)addVarMeshId()

 void ansys::Project::Run::addVarMeshId  ( ) 

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





<a id="aebad5a9f951bc07891bef662aed6ada1" name="aebad5a9f951bc07891bef662aed6ada1"></a>## [◆ ](#aebad5a9f951bc07891bef662aed6ada1)addVarOutputSettingsId()

 void ansys::Project::Run::addVarOutputSettingsId  ( ) 

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





<a id="ab2c162b2db99da7a0ae0a33f34fc4ad9" name="ab2c162b2db99da7a0ae0a33f34fc4ad9"></a>## [◆ ](#ab2c162b2db99da7a0ae0a33f34fc4ad9)addVarPhysicsId()

 void ansys::Project::Run::addVarPhysicsId  ( ) 

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





<a id="a322c24066e5f30512865a58bd7b01c43" name="a322c24066e5f30512865a58bd7b01c43"></a>## [◆ ](#a322c24066e5f30512865a58bd7b01c43)addVarSolverIteration()

 void ansys::Project::Run::addVarSolverIteration  ( ) 

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





<a id="a03c7998829a5b7f7fe8be10be1474e7c" name="a03c7998829a5b7f7fe8be10be1474e7c"></a>## [◆ ](#a03c7998829a5b7f7fe8be10be1474e7c)addVarTime()

 void ansys::Project::Run::addVarTime  ( ) 

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





<a id="a5bf38019a16ca06c2fc3500e5c9fe0a5" name="a5bf38019a16ca06c2fc3500e5c9fe0a5"></a>## [◆ ](#a5bf38019a16ca06c2fc3500e5c9fe0a5)addVarTopologyId()

 void ansys::Project::Run::addVarTopologyId  ( ) 

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





<a id="a21b5000b59ddc0b3e5358a71788b4372" name="a21b5000b59ddc0b3e5358a71788b4372"></a>## [◆ ](#a21b5000b59ddc0b3e5358a71788b4372)computeIds()

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

Compute missing ids (CaseId, MeshId, InputSettingsId) from their dependencies.





<a id="ae5c21c8fb9320c241809e969717c4360" name="ae5c21c8fb9320c241809e969717c4360"></a>## [◆ ](#ae5c21c8fb9320c241809e969717c4360)getAllVariables()

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

Returns the list of all variables ( input and output )





<a id="afe453b6378308de553307d3f8ee7c097" name="afe453b6378308de553307d3f8ee7c097"></a>## [◆ ](#afe453b6378308de553307d3f8ee7c097)getCase()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Run::getCase  ( )  const  virtual 

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."))

Reimplemented from [ansys::Project::SimBase](classansys_1_1_project_1_1_sim_base.xhtml#a1fb985412b84a850718aa3aae6e03147).





<a id="a19d68c135b428b5ec11deecab21be799" name="a19d68c135b428b5ec11deecab21be799"></a>## [◆ ](#a19d68c135b428b5ec11deecab21be799)getCurrentOutput()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Run::getCurrentOutput  ( )  const

Return the current output link for this run, typically the latest output is the current.





<a id="af68c98b0b16bacb99a7c73602dd13c4c" name="af68c98b0b16bacb99a7c73602dd13c4c"></a>## [◆ ](#af68c98b0b16bacb99a7c73602dd13c4c)getData()

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

Returns the default latest data file (from the current output, main data type)





<a id="a6b797638d34347e6801b88c0e69e05ce" name="a6b797638d34347e6801b88c0e69e05ce"></a>## [◆ ](#a6b797638d34347e6801b88c0e69e05ce)getIterator()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Run::getIterator  ( )  const  inlinevirtual 

Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml#a6bc544ed688df70fc57237a5a5601e73).

Reimplemented in [ansys::Project::RunGroup](classansys_1_1_project_1_1_run_group.xhtml#a6b797638d34347e6801b88c0e69e05ce).





<a id="a466b82cf69480314196d394fee869a33" name="a466b82cf69480314196d394fee869a33"></a>## [◆ ](#a466b82cf69480314196d394fee869a33)getOutputIterators()

 std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; ansys::Project::Run::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>## [◆ ](#a14fb8eab76c0f3b774e0a028270b7591)getOutputs()

 std::vector&lt; [Output](classansys_1_1_project_1_1_output.xhtml) &gt; ansys::Project::Run::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="a8232142331a440960cd4f4f1d3d27355" name="a8232142331a440960cd4f4f1d3d27355"></a>## [◆ ](#a8232142331a440960cd4f4f1d3d27355)getOutputSequence()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::Run::getOutputSequence  ( [OutputSequenceOrder](classansys_1_1_project_1_1_run.xhtml#a6520889cda1d3d1382fc1a5992a89041)  *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](classansys_1_1_project_1_1_run_output_attr.xhtml#a216010dc2b5c1190a68513b1d9617af4), [RunOutputAttr::sVarSolverIteration](classansys_1_1_project_1_1_run_output_attr.xhtml#a116b763a8622a5d731756e59b90416a0), 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](classansys_1_1_project_1_1_run.xhtml#ab2fbdaed6b5ec4a4a5ff52df8a64b86d)  *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="aa85ce4557dbb6edd648e2e4d68c60ab6" name="aa85ce4557dbb6edd648e2e4d68c60ab6"></a>## [◆ ](#aa85ce4557dbb6edd648e2e4d68c60ab6)getOutputVariables()

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

Returns the list of output variables.





<a id="a6414aca871a54080580ae5723711f098" name="a6414aca871a54080580ae5723711f098"></a>## [◆ ](#a6414aca871a54080580ae5723711f098)getResult()

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

Returns the current data file of specified type.





<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="ab924882a75ab1102498ac547b2ea6cfa" name="ab924882a75ab1102498ac547b2ea6cfa"></a>## [◆ ](#ab924882a75ab1102498ac547b2ea6cfa)getResultTypes()

 std::vector&lt; std::string &gt; ansys::Project::Run::getResultTypes  ( )  const

Returns the list of available output types listed in the run Outputs.





<a id="aee0d6fd3d0249f5536d45886bc9ad403" name="aee0d6fd3d0249f5536d45886bc9ad403"></a>## [◆ ](#aee0d6fd3d0249f5536d45886bc9ad403)getRunOutputType()

 [Run::RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) ansys::Project::Run::getRunOutputType  ( )  const

Return the RunOutputType as the enum.





<a id="a77a5212218cb0dde90bccf6597c0d8d4" name="a77a5212218cb0dde90bccf6597c0d8d4"></a>## [◆ ](#a77a5212218cb0dde90bccf6597c0d8d4)getRunOutputTypeAsString()

 std::string ansys::Project::Run::getRunOutputTypeAsString  ( )  const

Return the RunOutputType as a string.





<a id="a7482f6212a0f951dcb367a98803b33e3" name="a7482f6212a0f951dcb367a98803b33e3"></a>## [◆ ](#a7482f6212a0f951dcb367a98803b33e3)getRunStatus()

 RunStatus ansys::Project::Run::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.")





<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#a77b9663f5a89b1a0f34fb51e8561bd59).





<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#a403042318aa17d920be19cb3062e63aa).





<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#ab071e4ff3568754cc9e0dc1f6c6f20f7).





<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="a1c1f4337c98f47fa7af2bcc3eba4fe56" name="a1c1f4337c98f47fa7af2bcc3eba4fe56"></a>## [◆ ](#a1c1f4337c98f47fa7af2bcc3eba4fe56)getValues()

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

Return the list of values -one per output- for a list of variables.





<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#a160bf20b163631c67ceb8fbd0f05d81c).





<a id="aebee6c00a322bbcccc5659453699d929" name="aebee6c00a322bbcccc5659453699d929"></a>## [◆ ](#aebee6c00a322bbcccc5659453699d929)getVariables()

 std::vector&lt; std::string &gt; ansys::Project::Run::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="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#a81a3387403060a40ad820acfcd465247).





<a id="a50461d0ef3487601fd73f740cee85348" name="a50461d0ef3487601fd73f740cee85348"></a>## [◆ ](#a50461d0ef3487601fd73f740cee85348)isValid()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::Run::isValid  ( )  const  virtual 

Returns error with message if invalid.

Implements [ansys::Project::SimBase](classansys_1_1_project_1_1_sim_base.xhtml#a3c713318a297544df6164b21df42454d).

Reimplemented in [ansys::Project::RunGroup](classansys_1_1_project_1_1_run_group.xhtml#a3e9c11403f6ecd0abfeee7e05706631c).





<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="ae3d5f185d577c43e2ed2721f18212c35" name="ae3d5f185d577c43e2ed2721f18212c35"></a>## [◆ ](#ae3d5f185d577c43e2ed2721f18212c35)removeOutputVariable()

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

Remove an output variable.





<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="a004b5a97849f111dd65e68feb6a21874" name="a004b5a97849f111dd65e68feb6a21874"></a>## [◆ ](#a004b5a97849f111dd65e68feb6a21874)runStatusToString()

 std::string ansys::Project::Run::runStatusToString  ( RunStatus  *pStatus*)   static 





<a id="a70bbc0ae2005537059355ebe78f64f21" name="a70bbc0ae2005537059355ebe78f64f21"></a>## [◆ ](#a70bbc0ae2005537059355ebe78f64f21)setCurrentOutput()

 void ansys::Project::Run::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="a1593a20a772c53baf1af273ab63f0a53" name="a1593a20a772c53baf1af273ab63f0a53"></a>## [◆ ](#a1593a20a772c53baf1af273ab63f0a53)setOutputVariables()

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

Set/replace the list of output variables.





<a id="aa064a0d1e7ab2c233dabb81058acb8ef" name="aa064a0d1e7ab2c233dabb81058acb8ef"></a>## [◆ ](#aa064a0d1e7ab2c233dabb81058acb8ef)setRunOutputType()

 bool ansys::Project::Run::setRunOutputType  ( [RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092)  *pType*) 

Set the run output type, will add automatically the mandatory variables (if any)





<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="a52c78a77c9e136a085d167696015ef67" name="a52c78a77c9e136a085d167696015ef67"></a>## [◆ ](#a52c78a77c9e136a085d167696015ef67)setValue() \[1/3\]

 void ansys::Project::Run::setValue  ( const std::string &amp;  *pVar*,    const std::string &amp;  *pValue*   )   virtual 

Sets the local metadata to the specified key/value.

Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml#a9dc92e98bb7324c86192441ead647996).





<a id="ac83d3a1b9dff7af27d7431966cd33b58" name="ac83d3a1b9dff7af27d7431966cd33b58"></a>## [◆ ](#ac83d3a1b9dff7af27d7431966cd33b58)setValue() \[2/3\]

 void ansys::Project::Run::setValue  ( const std::string &amp;  *pVar*,    double  *pValue*   )   inline 





<a id="a0fffd5def2534f6301b8a51e28cb26c7" name="a0fffd5def2534f6301b8a51e28cb26c7"></a>## [◆ ](#a0fffd5def2534f6301b8a51e28cb26c7)setValue() \[3/3\]

 void ansys::Project::Run::setValue  ( const std::string &amp;  *pVar*,    int  *pValue*   )   inline 





<a id="a8680de9348c3c07a2da4a56752fe15b7" name="a8680de9348c3c07a2da4a56752fe15b7"></a>## [◆ ](#a8680de9348c3c07a2da4a56752fe15b7)setValueDouble()

 void ansys::Project::Run::setValueDouble  ( const std::string &amp;  *pVar*,    double  *pValue*   )   virtual 

Sets the local metadata to the specified key/value.

Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml#a3659d02ece965df37d5b09a27776b645).





<a id="ac6c679b970edcb372074503caf6cf28f" name="ac6c679b970edcb372074503caf6cf28f"></a>## [◆ ](#ac6c679b970edcb372074503caf6cf28f)setValueInt()

 void ansys::Project::Run::setValueInt  ( const std::string &amp;  *pVar*,    int  *pValue*   )   virtual 

Sets the local metadata to the specified key/value.

Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml#aec45f664a9284184f247462cdebef7a7).





<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.





<a id="ae621836b9f23de5353a3cc87afa0a899" name="ae621836b9f23de5353a3cc87afa0a899"></a>## [◆ ](#ae621836b9f23de5353a3cc87afa0a899)stringToRunStatus()

 RunStatus ansys::Project::Run::stringToRunStatus  ( const std::string &amp;  *pStr*)   static