## On this page # ansys::Project::Simulation Class Reference Last update: 24.03.2026 Subfolder of a [Project](classansys_1_1_project_1_1_project.xhtml "Base class for Project API, also see SimProject."), regrouping input files and [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") subfolders. [More...](classansys_1_1_project_1_1_simulation.xhtml#details) `#include "Simulation.hpp"` Inheritance diagram for ansys::Project::Simulation: ![](/sites/default/files/migrate-content/common_fluids_format_2026_r1_1/classansys_1_1_project_1_1_simulation.png) ## Public Member Functions [Simulation](classansys_1_1_project_1_1_simulation.xhtml#a1353fad4a75cc2abe9ca84c4d307c3c4) ([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_simulation.xhtml#a1353fad4a75cc2abe9ca84c4d307c3c4) virtual [~Simulation](classansys_1_1_project_1_1_simulation.xhtml#a39c89becbccfc91f156103066588507b) () virtual [Error](classansys_1_1_project_1_1_error.xhtml) [isValid](classansys_1_1_project_1_1_simulation.xhtml#ab8c7167e09e88042db12724531150af7) () const Returns error with message if invalid. [More...](classansys_1_1_project_1_1_simulation.xhtml#ab8c7167e09e88042db12724531150af7) [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getData](classansys_1_1_project_1_1_simulation.xhtml#a08e4de6f33b578b6edbb8127fb398c25) () Return the current Data for the simulation. [More...](classansys_1_1_project_1_1_simulation.xhtml#a08e4de6f33b578b6edbb8127fb398c25) [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getResult](classansys_1_1_project_1_1_simulation.xhtml#a34c022fa77e348bd7287a76c0d7871b8) (const std::string &pDataType) Returns the latest result of the specified type, 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_simulation.xhtml#a34c022fa77e348bd7287a76c0d7871b8) [Run](classansys_1_1_project_1_1_run.xhtml) [newRun](classansys_1_1_project_1_1_simulation.xhtml#a4eb433d9185e539d85307aa6b869c291) (std::string pName, [Run::RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) pType) Create a [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folder in the current [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders."). [More...](classansys_1_1_project_1_1_simulation.xhtml#a4eb433d9185e539d85307aa6b869c291) [Run](classansys_1_1_project_1_1_run.xhtml) [newRunInFolder](classansys_1_1_project_1_1_simulation.xhtml#af9cd129be20c02c3be763952a6a8bba3) (std::string pName, [Run::RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) pType, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) pFolder) Create a [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folder in the current [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") subfolder. [More...](classansys_1_1_project_1_1_simulation.xhtml#af9cd129be20c02c3be763952a6a8bba3) [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getRun](classansys_1_1_project_1_1_simulation.xhtml#abf2669d8f42be00cdf588e7443caf598) (const std::string &pName) const Returns [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") to the children [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") with the given name. [More...](classansys_1_1_project_1_1_simulation.xhtml#abf2669d8f42be00cdf588e7443caf598) std::vector< std::string > [getRuns](classansys_1_1_project_1_1_simulation.xhtml#a38cc991a7916643a66a0268fb2f755ad) () const Returns list of children [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folders, as vector of their names (see: [getRun()](classansys_1_1_project_1_1_simulation.xhtml#abf2669d8f42be00cdf588e7443caf598 "Returns Iterator to the children Run with the given name.") ) [More...](classansys_1_1_project_1_1_simulation.xhtml#a38cc991a7916643a66a0268fb2f755ad) [Error](classansys_1_1_project_1_1_error.xhtml) [removeRun](classansys_1_1_project_1_1_simulation.xhtml#a1d4061c3e84cb66b722de5e751feeee1) (const std::string &pName, bool pFlagErase) Remove the specified run from the simulation. [More...](classansys_1_1_project_1_1_simulation.xhtml#a1d4061c3e84cb66b722de5e751feeee1) [RunGroup](classansys_1_1_project_1_1_run_group.xhtml) [newRunGroup](classansys_1_1_project_1_1_simulation.xhtml#a3c4e9b6a70403ddafdb2dbd93c027aab) (std::string pName, [Run::RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) pType) Create a new [RunGroup](classansys_1_1_project_1_1_run_group.xhtml "Optional concept - Virtual folder with a list of Run.") - a virtual group of separate runs, can be assigned a type. [More...](classansys_1_1_project_1_1_simulation.xhtml#a3c4e9b6a70403ddafdb2dbd93c027aab) [RunGroup](classansys_1_1_project_1_1_run_group.xhtml) [getRunGroup](classansys_1_1_project_1_1_simulation.xhtml#abe2f341b876cdaeaa82737df9eaf428a) (const std::string &pName) const Return the [RunGroup](classansys_1_1_project_1_1_run_group.xhtml "Optional concept - Virtual folder with a list of Run.") by this name, in the current [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders."). [More...](classansys_1_1_project_1_1_simulation.xhtml#abe2f341b876cdaeaa82737df9eaf428a) std::vector< std::string > [getRunGroups](classansys_1_1_project_1_1_simulation.xhtml#a284554c45e7a609f560f4980ad969e72) () const Return the list of RunGroups, by name, in this simulation. [More...](classansys_1_1_project_1_1_simulation.xhtml#a284554c45e7a609f560f4980ad969e72) [Error](classansys_1_1_project_1_1_error.xhtml) [removeRunGroup](classansys_1_1_project_1_1_simulation.xhtml#a7194248adaf93042eee0e5e60711877b) (const std::string &pName, bool pFlagEraseRuns) void [newLink](classansys_1_1_project_1_1_simulation.xhtml#a41ced84b196ab472305df137411131d9) (const std::string pKey, const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &pIter) [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getLink](classansys_1_1_project_1_1_simulation.xhtml#af283d54a6e0ec70ed64ce6bacc4cd192) (const std::string pKey) bool [hasLink](classansys_1_1_project_1_1_simulation.xhtml#a2983aaea7346fd047121f263f4c81670) (const std::string pKey) void [setCurrentRun](classansys_1_1_project_1_1_simulation.xhtml#a607c98713399c26357da6ae6a92b21ec) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pRun) Set the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") in the simulation. [More...](classansys_1_1_project_1_1_simulation.xhtml#a607c98713399c26357da6ae6a92b21ec) [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getCurrentRun](classansys_1_1_project_1_1_simulation.xhtml#aa53437d21b9d65376405d5302733b271) () const Return the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") in the simulation - see [setCurrentRun()](classansys_1_1_project_1_1_simulation.xhtml#a607c98713399c26357da6ae6a92b21ec "Set the current Run in the simulation.") [More...](classansys_1_1_project_1_1_simulation.xhtml#aa53437d21b9d65376405d5302733b271) ![-](/sites/default/files/migrate-content/common_fluids_format_2026_r1_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) virtual [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getCase](classansys_1_1_project_1_1_sim_base.xhtml#a1fb985412b84a850718aa3aae6e03147) () const Returns the case file associated with this folder. [More...](classansys_1_1_project_1_1_sim_base.xhtml#a1fb985412b84a850718aa3aae6e03147) [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 &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< [Iterator](classansys_1_1_project_1_1_iterator.xhtml) > [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 &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< [Iterator](classansys_1_1_project_1_1_iterator.xhtml) > [getInputsByType](classansys_1_1_project_1_1_sim_base.xhtml#abc3d5315d8f3a3cff217c2112b4581a1) (const std::string &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) & [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) & [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) virtual [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getIterator](classansys_1_1_project_1_1_sim_base.xhtml#a16f3c24244ab0ec6587d945785c7718d) () const Access the [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") for this item. [More...](classansys_1_1_project_1_1_sim_base.xhtml#a16f3c24244ab0ec6587d945785c7718d) [operator Iterator](classansys_1_1_project_1_1_sim_base.xhtml#a0625d859da2633b26505821aaf569602) () const ## Static Public Member Functions static bool [isSimulation](classansys_1_1_project_1_1_simulation.xhtml#a9a500df90203b2a296d5185232dbbc17) (const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &pIter) ## Protected Member Functions std::vector< std::string > [getListOfSubclass](classansys_1_1_project_1_1_simulation.xhtml#aa623d14ca07c68e510f518a6c51e8951) (const std::string &pSubclass) const Search child hierarchy for items of the specified subclass. [More...](classansys_1_1_project_1_1_simulation.xhtml#aa623d14ca07c68e510f518a6c51e8951) ![-](/sites/default/files/migrate-content/common_fluids_format_2026_r1_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) &pInput, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &pOutput) ## Additional Inherited Members ![-](/sites/default/files/migrate-content/common_fluids_format_2026_r1_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) ## Detailed Description Subfolder of a [Project](classansys_1_1_project_1_1_project.xhtml "Base class for Project API, also see SimProject."), regrouping input files and [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") subfolders. 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 [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") 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/"); Simulation sim(it); sim.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 [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") might have settings ([Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator.")) related to the solver settings, or common to all results in this folder hiearchy. ## Constructor & Destructor Documentation ## [◆ ](#a1353fad4a75cc2abe9ca84c4d307c3c4)Simulation() ansys::Project::Simulation::Simulation ( [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 [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") If the subclass is not [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders."), the [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") object is invalid ( !ok() ) ## [◆ ](#a39c89becbccfc91f156103066588507b)~Simulation() virtual ansys::Project::Simulation::~Simulation ( ) inlinevirtual ## Member Function Documentation ## [◆ ](#aa53437d21b9d65376405d5302733b271)getCurrentRun() [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Simulation::getCurrentRun ( ) const Return the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") in the simulation - see [setCurrentRun()](classansys_1_1_project_1_1_simulation.xhtml#a607c98713399c26357da6ae6a92b21ec "Set the current Run in the simulation.") ## [◆ ](#a08e4de6f33b578b6edbb8127fb398c25)getData() [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Simulation::getData ( ) Return the current Data for the simulation. The current data is the latest [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run."), of the main data type, for the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."). ## [◆ ](#af283d54a6e0ec70ed64ce6bacc4cd192)getLink() [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Simulation::getLink ( const std::string *pKey*) ## [◆ ](#aa623d14ca07c68e510f518a6c51e8951)getListOfSubclass() std::vector< std::string > ansys::Project::Simulation::getListOfSubclass ( const std::string & *pSubclass*) const protected Search child hierarchy for items of the specified subclass. ## [◆ ](#a34c022fa77e348bd7287a76c0d7871b8)getResult() [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Simulation::getResult ( const std::string & *pDataType*) Returns the latest result of the specified type, in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."). ## [◆ ](#abf2669d8f42be00cdf588e7443caf598)getRun() [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Simulation::getRun ( const std::string & *pName*) const Returns [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") to the children [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") with the given name. ## [◆ ](#abe2f341b876cdaeaa82737df9eaf428a)getRunGroup() [RunGroup](classansys_1_1_project_1_1_run_group.xhtml) ansys::Project::Simulation::getRunGroup ( const std::string & *pName*) const Return the [RunGroup](classansys_1_1_project_1_1_run_group.xhtml "Optional concept - Virtual folder with a list of Run.") by this name, in the current [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders."). If the rungroup is in a subfolder the path to it is expected (same path type returned by [getRunGroups()](classansys_1_1_project_1_1_simulation.xhtml#a284554c45e7a609f560f4980ad969e72 "Return the list of RunGroups, by name, in this simulation.") ) Simulation/RunGroup -> [RunGroup](classansys_1_1_project_1_1_run_group.xhtml "Optional concept - Virtual folder with a list of Run.") Simulation/folder/RunGroup -> folder/RunGroup ## [◆ ](#a284554c45e7a609f560f4980ad969e72)getRunGroups() std::vector< std::string > ansys::Project::Simulation::getRunGroups ( ) const Return the list of RunGroups, by name, in this simulation. If the rungroup is in a subfolder the relative path to it is included Simulation/RunGroup -> [RunGroup](classansys_1_1_project_1_1_run_group.xhtml "Optional concept - Virtual folder with a list of Run.") Simulation/folder/RunGroup -> folder/RunGroup ## [◆ ](#a38cc991a7916643a66a0268fb2f755ad)getRuns() std::vector< std::string > ansys::Project::Simulation::getRuns ( ) const Returns list of children [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folders, as vector of their names (see: [getRun()](classansys_1_1_project_1_1_simulation.xhtml#abf2669d8f42be00cdf588e7443caf598 "Returns Iterator to the children Run with the given name.") ) If the run is in a subfolder the relative path to it is included Simulation/Run -> [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") Simulation/folder/Run -> folder/Run ## [◆ ](#a2983aaea7346fd047121f263f4c81670)hasLink() bool ansys::Project::Simulation::hasLink ( const std::string *pKey*) ## [◆ ](#a9a500df90203b2a296d5185232dbbc17)isSimulation() bool ansys::Project::Simulation::isSimulation ( const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) & *pIter*) static ## [◆ ](#ab8c7167e09e88042db12724531150af7)isValid() [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::Simulation::isValid ( ) const virtual Returns error with message if invalid. Implements [ansys::Project::SimBase](classansys_1_1_project_1_1_sim_base.xhtml#a3c713318a297544df6164b21df42454d). ## [◆ ](#a41ced84b196ab472305df137411131d9)newLink() void ansys::Project::Simulation::newLink ( const std::string *pKey*, const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) & *pIter* ) ## [◆ ](#a4eb433d9185e539d85307aa6b869c291)newRun() [Run](classansys_1_1_project_1_1_run.xhtml) ansys::Project::Simulation::newRun ( std::string *pName*, [Run::RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) *pType* ) Create a [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folder in the current [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders."). The [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folder is physical or virtual, depending of the project [ProjectStoragePolicy](classansys_1_1_project_1_1_project_storage_policy.xhtml "Project storage settings, control folder management, folder names, etc.") The new run is given a name, and a type. Parameters pName: Name of the new [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), must be unique in the simulation pTypeType of the new run (Transient, Steady, etc.) see [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") ## [◆ ](#a3c4e9b6a70403ddafdb2dbd93c027aab)newRunGroup() [RunGroup](classansys_1_1_project_1_1_run_group.xhtml) ansys::Project::Simulation::newRunGroup ( std::string *pName*, [Run::RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) *pType* ) Create a new [RunGroup](classansys_1_1_project_1_1_run_group.xhtml "Optional concept - Virtual folder with a list of Run.") - a virtual group of separate runs, can be assigned a type. From the type, the mandatory and automatic variable constraints will apply to the RunGroup->[Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") association, as it would normally for Run->[Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."). A [RunGroup](classansys_1_1_project_1_1_run_group.xhtml "Optional concept - Virtual folder with a list of Run.") permits to define multiple levels of run type, for example a parametric [RunGroup](classansys_1_1_project_1_1_run_group.xhtml "Optional concept - Virtual folder with a list of Run.") would contain transient Runs. The design point parameters are then assigned at the [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") level, while the varying time values at the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") level. Parameters pName: Name of the new [RunGroup](classansys_1_1_project_1_1_run_group.xhtml "Optional concept - Virtual folder with a list of Run."), must be unique in the simulation pTypeType of the new group (Transient, Steady, etc.) see [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") . ## [◆ ](#af9cd129be20c02c3be763952a6a8bba3)newRunInFolder() [Run](classansys_1_1_project_1_1_run.xhtml) ansys::Project::Simulation::newRunInFolder ( std::string *pName*, [Run::RunOutputType](classansys_1_1_project_1_1_run.xhtml#a730f2ea4aef8f22f0886f12109c17092) *pType*, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) *pFolder* ) Create a [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folder in the current [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") subfolder. The [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folder is physical or virtual, depending of the project [ProjectStoragePolicy](classansys_1_1_project_1_1_project_storage_policy.xhtml "Project storage settings, control folder management, folder names, etc.") The new run is given a name, and a type. Parameters pName: Name of the new [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), must be unique in the simulation pTypeType of the new run (Transient, Steady, etc.) see [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") ## [◆ ](#a1d4061c3e84cb66b722de5e751feeee1)removeRun() [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::Simulation::removeRun ( const std::string & *pName*, bool *pFlagErase* ) Remove the specified run from the simulation. Parameters pFlagEraseIf enabled, will erase the run folder and its data ## [◆ ](#a7194248adaf93042eee0e5e60711877b)removeRunGroup() [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::Simulation::removeRunGroup ( const std::string & *pName*, bool *pFlagEraseRuns* ) ## [◆ ](#a607c98713399c26357da6ae6a92b21ec)setCurrentRun() void ansys::Project::Simulation::setCurrentRun ( [Iterator](classansys_1_1_project_1_1_iterator.xhtml) *pRun*) Set the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") in the simulation. The current run is the 'default' run to use for post-processing, or to load the latest results. Its automatically set to the latest [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") created Parameters pRun[Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") to the existing run to mark as current