## On this page

  

 

 # ansys::Project::SimProject Class Reference

 Last update: 16.07.2025 

Main object for [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") based projects. [More...](classansys_1_1_project_1_1_sim_project.xhtml#details)

`#include "SimProject.hpp"`

Inheritance diagram for ansys::Project::SimProject:

 ![](/sites/default/files/migrate-content/common_fluids_format_2024_r2/classansys_1_1_project_1_1_sim_project.png)



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

<a id="a3f922fab8e5b09aae55c41257f05a2de" name="a3f922fab8e5b09aae55c41257f05a2de"></a> **SimProject** () Constructor - See [Project::Project()](classansys_1_1_project_1_1_project.xhtml#ae26ec5c1449c349cc767bdae9deb4339 "Constructor.")   
 <a id="abb78a8446d3f92224e4fa9ab84bd7256" name="abb78a8446d3f92224e4fa9ab84bd7256"></a>virtual **~SimProject** () Constructor - See [Project::~Project()](classansys_1_1_project_1_1_project.xhtml#af534abc0e2d1096eab9228880f007688 "Destructor - Will close the project and release the lock (if any).")   
 [Error](classansys_1_1_project_1_1_error.xhtml) [importMesh](classansys_1_1_project_1_1_sim_project.xhtml#a692692dce4c38537f5dc51d06f034165) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pURL, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pIter, std::string pName="") Import a mesh in a Mesh/ subfolder of the project. [More...](classansys_1_1_project_1_1_sim_project.xhtml#a692692dce4c38537f5dc51d06f034165)  
 <a id="a9b5bbd714641b81f5bb636599cc1756f" name="a9b5bbd714641b81f5bb636599cc1756f"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getMesh** (const std::string &amp;pName) const Retrieve Mesh iterator from Mesh/ folder, by name.   
 <a id="a9b541a3a08b20005c01b3838f4599736" name="a9b541a3a08b20005c01b3838f4599736"></a>std::vector&lt; std::string &gt; **getMeshes** () const Retrieve all mesh names from Mesh/ folder.   
 [Error](classansys_1_1_project_1_1_error.xhtml) [importGeometry](classansys_1_1_project_1_1_sim_project.xhtml#ac3d9e9f2012f9f7e232b80bffeeb0bd9) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pURL, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pIter, std::string pName="") Import a CAD in a Geo/ subfolder of the project. [More...](classansys_1_1_project_1_1_sim_project.xhtml#ac3d9e9f2012f9f7e232b80bffeeb0bd9)  
 <a id="af88b8c71345a8ecdc56d0568ca0a84cd" name="af88b8c71345a8ecdc56d0568ca0a84cd"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getGeometry** (const std::string &amp;pName) const Retrieve Geometry iterator from Geometry/ folder, by name.   
 <a id="a3fc6747c70b590316b24ab5825faf8b4" name="a3fc6747c70b590316b24ab5825faf8b4"></a>std::vector&lt; std::string &gt; **getGeometries** () const Retrieve all geometry file names from Geometry/ folder.   
 [Error](classansys_1_1_project_1_1_error.xhtml) [importItem](classansys_1_1_project_1_1_sim_project.xhtml#a2a16bd7c5fc760e068129a1a0561897c) (const std::string &amp;pCategory, const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pURL, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pIter, std::string pName="") Import a file of any type in the Type/ subfolder of the project. [More...](classansys_1_1_project_1_1_sim_project.xhtml#a2a16bd7c5fc760e068129a1a0561897c)  
 <a id="a9a791ab40e74721fe999e3c9321c5d71" name="a9a791ab40e74721fe999e3c9321c5d71"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getItem** (const std::string &amp;pCategory, const std::string &amp;pName) const Retrieve Item iterator from Category/ folder, by name.   
 <a id="a2837737e7e257a82c6d646e126010f08" name="a2837737e7e257a82c6d646e126010f08"></a>std::vector&lt; std::string &gt; **getItems** (const std::string &amp;pCategory) const Retrieve all item names from from Category/ folder.   
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [newSimulation](classansys_1_1_project_1_1_sim_project.xhtml#acc4e7086a02d22785934b3f5e2a0039c) (const std::string &amp;pName, const std::string &amp;pType) Create a new [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") folder in the [SimProject](classansys_1_1_project_1_1_sim_project.xhtml "Main object for Simulation based projects."). [More...](classansys_1_1_project_1_1_sim_project.xhtml#acc4e7086a02d22785934b3f5e2a0039c)  
 <a id="acb62ea25eef0ff2ff2c41750a4353202" name="acb62ea25eef0ff2ff2c41750a4353202"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getSimulation** (const std::string &amp;pName) const Retrieve a [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") in the [SimProject](classansys_1_1_project_1_1_sim_project.xhtml "Main object for Simulation based projects."), by name.   
 <a id="ae8f0751aa1f3e286ed2397666856f984" name="ae8f0751aa1f3e286ed2397666856f984"></a>std::vector&lt; std::string &gt; **getSimulations** () const Retrieve the list of [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") names in the [SimProject](classansys_1_1_project_1_1_sim_project.xhtml "Main object for Simulation based projects.").   
 [Error](classansys_1_1_project_1_1_error.xhtml) [removeSimulation](classansys_1_1_project_1_1_sim_project.xhtml#a4756ec52234c2f0f0e6609f4a10510ab) (const std::string &amp;pName, bool pFlagErase) Remove a named simulation from the project. [More...](classansys_1_1_project_1_1_sim_project.xhtml#a4756ec52234c2f0f0e6609f4a10510ab)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [duplicateSimulation](classansys_1_1_project_1_1_sim_project.xhtml#aa3d626edc79bb7a9b3428dfea5fe3809) (const std::string &amp;pOld, const std::string &amp;pNew) Duplicate a simulation to a new name. [More...](classansys_1_1_project_1_1_sim_project.xhtml#aa3d626edc79bb7a9b3428dfea5fe3809)  
 void [setCurrentSimulation](classansys_1_1_project_1_1_sim_project.xhtml#ade8761d99b01d5fe7e75a68f944c4fa3) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pSim) Set the current simulation link - i.e. the 'default' simulation. [More...](classansys_1_1_project_1_1_sim_project.xhtml#ade8761d99b01d5fe7e75a68f944c4fa3)  
 <a id="a297140351ca2b01c66ec8e0d2d0b43ad" name="a297140351ca2b01c66ec8e0d2d0b43ad"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getCurrentSimulation** () const Returns the current simulation link - if any.   
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [checkProject](classansys_1_1_project_1_1_sim_project.xhtml#a9d89fa7443d65f1e2ad3befee9da068d) ([CheckProjectInfo](structansys_1_1_project_1_1_project_1_1_check_project_info.xhtml) &amp;pInfo) const Check the currently loaded project for validity. [More...](classansys_1_1_project_1_1_sim_project.xhtml#a9d89fa7443d65f1e2ad3befee9da068d)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [upgradeProject](classansys_1_1_project_1_1_sim_project.xhtml#a4f6fa68a1de203d8ee8c306f03977422) () Upgrade project to current version. [More...](classansys_1_1_project_1_1_sim_project.xhtml#a4f6fa68a1de203d8ee8c306f03977422)  
 <a id="a93f249fd03b7932c1ba5c83865f1c1b4" name="a93f249fd03b7932c1ba5c83865f1c1b4"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **copyMetadata** (const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pSource, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pTarget) const Copy metadata between two project items.   
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [getInheritedMetadata](classansys_1_1_project_1_1_sim_project.xhtml#af0007299e8f3e397ef30c8736a12d873) (const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pIter, [MetadataConst](classansys_1_1_project_1_1_metadata_const.xhtml) &amp;pMeta) Return the metadata for the current iterator and include relevant data from parent iterators. [More...](classansys_1_1_project_1_1_sim_project.xhtml#af0007299e8f3e397ef30c8736a12d873)  
 ![-](/sites/default/files/migrate-content/common_fluids_format_2024_r2/closed.png) Public Member Functions inherited from [ansys::Project::Project](classansys_1_1_project_1_1_project.xhtml) [Project](classansys_1_1_project_1_1_project.xhtml#ae26ec5c1449c349cc767bdae9deb4339) () Constructor. [More...](classansys_1_1_project_1_1_project.xhtml#ae26ec5c1449c349cc767bdae9deb4339)  
 <a id="af534abc0e2d1096eab9228880f007688" name="af534abc0e2d1096eab9228880f007688"></a>virtual **~Project** () Destructor - Will close the project and release the lock (if any).   
 <a id="a191c8a3067fcd15685409d5102c6f3b0" name="a191c8a3067fcd15685409d5102c6f3b0"></a>bool **isLoaded** () const Indicates if a project is currrently opened (or newly created with success).   
 <a id="a1c91ce45672d515fa7c6f424506a3435" name="a1c91ce45672d515fa7c6f424506a3435"></a>virtual bool **isProject** (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pLocation) Check if a filename is a project file (fast read, not entirely checked)   
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [newProject](classansys_1_1_project_1_1_project.xhtml#a747d6326df2792b9830c54daf538071b) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pLocation) Create a project at the specified [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format."). [More...](classansys_1_1_project_1_1_project.xhtml#a747d6326df2792b9830c54daf538071b)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [openProject](classansys_1_1_project_1_1_project.xhtml#a20e00fbfad7b9823356b635a18a701b3) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pLocation, bool pReadOnly=false) Open a project at the specified [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format."). [More...](classansys_1_1_project_1_1_project.xhtml#a20e00fbfad7b9823356b635a18a701b3)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [openProjectFromString](classansys_1_1_project_1_1_project.xhtml#a100dd4edabdd2f988cd4b7921ba597e5) (const std::string &amp;pData, const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pProjectLocation, bool pReadOnly=false) Open a project by reading its data from a string. [More...](classansys_1_1_project_1_1_project.xhtml#a100dd4edabdd2f988cd4b7921ba597e5)  
 <a id="a5c10d316ae316b4e77b77707986115d5" name="a5c10d316ae316b4e77b77707986115d5"></a>[Error](classansys_1_1_project_1_1_error.xhtml) **saveProject** () Save the currently opened project.   
 <a id="aff3afe814f2bc3189971d237f31b8543" name="aff3afe814f2bc3189971d237f31b8543"></a>[Error](classansys_1_1_project_1_1_error.xhtml) **saveProjectToString** (std::string &amp;pString) Save the currently opened project to an XML string.   
 [Error](classansys_1_1_project_1_1_error.xhtml) [saveAsProject](classansys_1_1_project_1_1_project.xhtml#a5030299e80c55a495dc39dc31ccc6692) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pLocation, bool pFlagCopyFiles=false, bool pFlagCopyExternal=false) Save the project index file to a new location. [More...](classansys_1_1_project_1_1_project.xhtml#a5030299e80c55a495dc39dc31ccc6692)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [exportProject](classansys_1_1_project_1_1_project.xhtml#af431224de932d828ab1d824978d4caa0) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pLocation, bool pFlagCopyExternal=true, bool pFlagEnforceStructure=false) Export the project to a new location (keeping current project opened and unchanged). [More...](classansys_1_1_project_1_1_project.xhtml#af431224de932d828ab1d824978d4caa0)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [archiveProject](classansys_1_1_project_1_1_project.xhtml#a0c8749326d29338aac4be6c06a49570f) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pTargetArchive) const Compress the project to an archive (keeping current project opened and unchanged) [More...](classansys_1_1_project_1_1_project.xhtml#a0c8749326d29338aac4be6c06a49570f)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [archiveProject](classansys_1_1_project_1_1_project.xhtml#a2f486b3e690db9742eab5a2775d0b74d) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pTargetArchive, const std::vector&lt; std::string &gt; &amp;pListIgnore) const Compress the project to an archive (keeping current project opened and unchanged) [More...](classansys_1_1_project_1_1_project.xhtml#a2f486b3e690db9742eab5a2775d0b74d)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [forkProject](classansys_1_1_project_1_1_project.xhtml#ac3f62102beca5155952fcf14114ef98c) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pIter, const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pNewProjectFilename, [Project](classansys_1_1_project_1_1_project.xhtml) \*&amp;pProject) Split the project at the specified location to a subproject. [More...](classansys_1_1_project_1_1_project.xhtml#ac3f62102beca5155952fcf14114ef98c)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [loadSubProject](classansys_1_1_project_1_1_project.xhtml#a95f212b1ae0044de8b53d21a08e2ee0e) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pIter) Load the specified subproject. [More...](classansys_1_1_project_1_1_project.xhtml#a95f212b1ae0044de8b53d21a08e2ee0e)  
 <a id="acd6ec65e720da76f11e297f60a74e3bc" name="acd6ec65e720da76f11e297f60a74e3bc"></a>std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; **getSubProjects** () Return the list of subprojects stored in the project.   
 <a id="aa954c845eaa067de83e84a20e349e3b3" name="aa954c845eaa067de83e84a20e349e3b3"></a>[Error](classansys_1_1_project_1_1_error.xhtml) **loadAllSubProjects** () Load all subprojects stored in the project.   
 <a id="a3ebf27d2961a0be568411e4681e8be95" name="a3ebf27d2961a0be568411e4681e8be95"></a>[Error](classansys_1_1_project_1_1_error.xhtml) **join** ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter) Join the subproject back to the master project.   
 [Error](classansys_1_1_project_1_1_error.xhtml) [getProjectLockInfo](classansys_1_1_project_1_1_project.xhtml#a1551943e6a65f018080a31a4bcdf1b80) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pLocation, std::string &amp;pLockInfo) Indicates if the specified project is locked and retrieve the lock information. [More...](classansys_1_1_project_1_1_project.xhtml#a1551943e6a65f018080a31a4bcdf1b80)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [eraseProjectLock](classansys_1_1_project_1_1_project.xhtml#a37831e1a7dc4360781de4a9c44b88d5b) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pLocation) Erase the project lock. [More...](classansys_1_1_project_1_1_project.xhtml#a37831e1a7dc4360781de4a9c44b88d5b)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [copyItemTo](classansys_1_1_project_1_1_project.xhtml#a1c8960088174c3f898449c35d492367c) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pSource, [Project](classansys_1_1_project_1_1_project.xhtml) &amp;pTarget, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) pTargetFolder=[Iterator](classansys_1_1_project_1_1_iterator.xhtml)(), bool pRecursive=false) Copy the [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") item to the target project. [More...](classansys_1_1_project_1_1_project.xhtml#a1c8960088174c3f898449c35d492367c)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [closeProject](classansys_1_1_project_1_1_project.xhtml#a940472a5df9b1275453c6880c68fb156) () Close the project and release the lock. [More...](classansys_1_1_project_1_1_project.xhtml#a940472a5df9b1275453c6880c68fb156)  
 <a id="a68e78169e875091055df1ea930bb1ac9" name="a68e78169e875091055df1ea930bb1ac9"></a>const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp; **getProjectLocation** () const Get the [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.") of the project file with path.   
 <a id="aa27f007a5fbbd5fd099cb681b6f3f186" name="aa27f007a5fbbd5fd099cb681b6f3f186"></a>[URL](classansys_1_1_project_1_1_u_r_l.xhtml) **getProjectFolder** () const Get the [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.") of the project folder, if enabled by policy.   
 <a id="a554127e81daa6f0836dffcf33d17988c" name="a554127e81daa6f0836dffcf33d17988c"></a>[ProjectStoragePolicy](classansys_1_1_project_1_1_project_storage_policy.xhtml) &amp; **getStoragePolicy** () Return the StoragePolicy for the current project or to configure before [newProject()](classansys_1_1_project_1_1_project.xhtml#a747d6326df2792b9830c54daf538071b "Create a project at the specified URL.").   
 <a id="a2dd72e4e00fc697566aa919c184b038e" name="a2dd72e4e00fc697566aa919c184b038e"></a>bool **isLocalToProject** (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pURL) const Indicates if the specified absolute [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.") is inside the project folder.   
 <a id="a46877c6320f47a155a75169d36238949" name="a46877c6320f47a155a75169d36238949"></a>bool **isOwnedByProject** (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pURL) const If the specified [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.") is a file in the project folder, and registered, returns true.   
 <a id="af7698dfb8ecc0eedf251d8f0f30abb70" name="af7698dfb8ecc0eedf251d8f0f30abb70"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getIteratorForURL** (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pURL) const If the specified [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.") is a file in the project folder, and registered, returns the [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.").   
 <a id="a718a7912d243d9ec683e0006f161dd72" name="a718a7912d243d9ec683e0006f161dd72"></a>[URL](classansys_1_1_project_1_1_u_r_l.xhtml) **getRelativePathToFile** (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pURL) const Future feature - Not available.   
 bool [registerCallback](classansys_1_1_project_1_1_project.xhtml#a5aabe52873c70c358b5676d7a040a9d5) (const std::string &amp;pOwner, const std::string &amp;pCallbackName, BaseCallback \*pCallback) Register a function callback to a project event. [More...](classansys_1_1_project_1_1_project.xhtml#a5aabe52873c70c358b5676d7a040a9d5)  
 <a id="ad29b2f43e54a442e3c2aae16bfde9c05" name="ad29b2f43e54a442e3c2aae16bfde9c05"></a>[Error](classansys_1_1_project_1_1_error.xhtml) **executeCallback** (const std::string &amp;pCallbackName, CallbackParams &amp;pParams) Trigger any registered callback for this callback ID.   
 <a id="a6abcade6d718d29916f6daabe1f3d6ea" name="a6abcade6d718d29916f6daabe1f3d6ea"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **copyRuntimeMetadata** (const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pSource, [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;pTarget) const Copy all runtime metadata values from source to target iterator.   
 <a id="a4d37d37587ca061d9cd7a4e10d0fc099" name="a4d37d37587ca061d9cd7a4e10d0fc099"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **root** () const Return the iterator to the project root folder.   
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [get](classansys_1_1_project_1_1_project.xhtml#a7e8b3e5b9ea8fcf583b9bff9e887dc09) (const [Path](classansys_1_1_project_1_1_path.xhtml) &amp;pPath) const For a project [Path](classansys_1_1_project_1_1_path.xhtml "Paths used for internal Project filesystem."), return the associated [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location."). [More...](classansys_1_1_project_1_1_project.xhtml#a7e8b3e5b9ea8fcf583b9bff9e887dc09)  
 <a id="a551f309b90cf9f495420ea02848cbf4d" name="a551f309b90cf9f495420ea02848cbf4d"></a>int **getProjectId** () const Return a project id, which will be the same as in the matching [Iterator::getProjectId()](classansys_1_1_project_1_1_iterator.xhtml#aab5adc1caad321f18f6f2cdb2d7eb6e2 "Return the unique project ID for this iterator.").   
 ## <a id="pro-methods" name="pro-methods"></a>Protected Member Functions

<a id="a865af56735c74ddbb95132c8e68e7d31" name="a865af56735c74ddbb95132c8e68e7d31"></a>virtual [Project](classansys_1_1_project_1_1_project.xhtml) \* **projectObjectFactory** () const Create a new object of the current effective project type.   
 ![-](/sites/default/files/migrate-content/common_fluids_format_2024_r2/closed.png) Protected Member Functions inherited from [ansys::Project::Project](classansys_1_1_project_1_1_project.xhtml)virtual [Error](classansys_1_1_project_1_1_error.xhtml) [copyProjectContent](classansys_1_1_project_1_1_project.xhtml#afe6dccd1d416c6e84967a68107af8515) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pFolder, const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pSourceFolder, const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pTargetFolder, std::map&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml), [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &gt; &amp;pURLChanges, bool pCopyExternalFiles, bool pEnforceStructure) Internal function - Copy a folder iterator content files from a source directory to target. [More...](classansys_1_1_project_1_1_project.xhtml#afe6dccd1d416c6e84967a68107af8515)  
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/common_fluids_format_2024_r2/closed.png) Static Public Member Functions inherited from [ansys::Project::Project](classansys_1_1_project_1_1_project.xhtml)static [Error](classansys_1_1_project_1_1_error.xhtml) [unarchiveProject](classansys_1_1_project_1_1_project.xhtml#a336ac0d006d6a24a08f1894c66e33940) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pArchive, const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pTargetFolder) Extract the project to an from an archive,. [More...](classansys_1_1_project_1_1_project.xhtml#a336ac0d006d6a24a08f1894c66e33940)  
 <a id="details" name="details"></a>## Detailed Description

Main object for [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") based projects.

The [SimProject](classansys_1_1_project_1_1_sim_project.xhtml "Main object for Simulation based projects.") manages the .flprj index file, and (if enabled) the .cffdb folder. The project contains the global storage settings, and contains [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") subfolders.

The project concept is detailed in [Project API](_project_a_p_i.xhtml)



## Member Function Documentation

<a id="a9d89fa7443d65f1e2ad3befee9da068d" name="a9d89fa7443d65f1e2ad3befee9da068d"></a>## [◆ ](#a9d89fa7443d65f1e2ad3befee9da068d)checkProject()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::SimProject::checkProject  ( [CheckProjectInfo](structansys_1_1_project_1_1_project_1_1_check_project_info.xhtml) &amp;  *pInfo*)  const  virtual 

Check the currently loaded project for validity.

[Project::checkProject()](classansys_1_1_project_1_1_project.xhtml#a9926355c9f869546253870307d4c3f2a "Check if a Project is valid.") will only check files and folders, while [SimProject::checkProject()](classansys_1_1_project_1_1_sim_project.xhtml#a9d89fa7443d65f1e2ad3befee9da068d "Check the currently loaded project for validity.") will check the [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") and their files for consistency and project syntax compliance.

Parameters pInfoCheckProjectInfo structure used to specify check project settings and return the results. Reimplemented from [ansys::Project::Project](classansys_1_1_project_1_1_project.xhtml#a9926355c9f869546253870307d4c3f2a).





<a id="aa3d626edc79bb7a9b3428dfea5fe3809" name="aa3d626edc79bb7a9b3428dfea5fe3809"></a>## [◆ ](#aa3d626edc79bb7a9b3428dfea5fe3809)duplicateSimulation()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::SimProject::duplicateSimulation  ( const std::string &amp;  *pOld*,    const std::string &amp;  *pNew*   ) 

Duplicate a simulation to a new name.

[Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator.") is copied Input files stored in the source simulation are copied over and linked to the new location. Input files referencing files outside of the simulation are kept as such.

Returns[Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") of the newly created run 



<a id="af0007299e8f3e397ef30c8736a12d873" name="af0007299e8f3e397ef30c8736a12d873"></a>## [◆ ](#af0007299e8f3e397ef30c8736a12d873)getInheritedMetadata()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::SimProject::getInheritedMetadata  ( const [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;  *pIter*,    [MetadataConst](classansys_1_1_project_1_1_metadata_const.xhtml) &amp;  *pMeta*   )   virtual 

Return the metadata for the current iterator and include relevant data from parent iterators.

In [Project](classansys_1_1_project_1_1_project.xhtml "Base class for Project API, also see SimProject.") this only returns the metadata for the current iterator, unless the parent item is a Transparent item, the data is then also included. Used in some UI elements.

Reimplemented from [ansys::Project::Project](classansys_1_1_project_1_1_project.xhtml#a1de046a523c12e7e7c50aba05ba74e1e).





<a id="ac3d9e9f2012f9f7e232b80bffeeb0bd9" name="ac3d9e9f2012f9f7e232b80bffeeb0bd9"></a>## [◆ ](#ac3d9e9f2012f9f7e232b80bffeeb0bd9)importGeometry()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::SimProject::importGeometry  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pURL*,    [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;  *pIter*,    std::string  *pName* = `""`   ) 

Import a CAD in a Geo/ subfolder of the project.

Parameters pURLFile location of the file to copy pInfoReturned [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") of the newly imported file pNameName of the new project entry in Geo/Returns[Error](classansys_1_1_project_1_1_error.xhtml "The return state / error value of a Project function call.") state 



<a id="a2a16bd7c5fc760e068129a1a0561897c" name="a2a16bd7c5fc760e068129a1a0561897c"></a>## [◆ ](#a2a16bd7c5fc760e068129a1a0561897c)importItem()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::SimProject::importItem  ( const std::string &amp;  *pCategory*,    const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pURL*,    [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;  *pIter*,    std::string  *pName* = `""`   ) 

Import a file of any type in the Type/ subfolder of the project.

Parameters pCategoryFile type - will also be assigned as DataType of the file pURLFile location of the file to copy pInfoReturned [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") of the newly imported file pNameName of the new project entry in Type/Returns[Error](classansys_1_1_project_1_1_error.xhtml "The return state / error value of a Project function call.") state 



<a id="a692692dce4c38537f5dc51d06f034165" name="a692692dce4c38537f5dc51d06f034165"></a>## [◆ ](#a692692dce4c38537f5dc51d06f034165)importMesh()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::SimProject::importMesh  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pURL*,    [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &amp;  *pIter*,    std::string  *pName* = `""`   ) 

Import a mesh in a Mesh/ subfolder of the project.

Parameters pURLFile location of the file to copy pInfoReturned [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") of the newly imported file pNameName of the new project entry in Mesh/Returns[Error](classansys_1_1_project_1_1_error.xhtml "The return state / error value of a Project function call.") state 



<a id="acc4e7086a02d22785934b3f5e2a0039c" name="acc4e7086a02d22785934b3f5e2a0039c"></a>## [◆ ](#acc4e7086a02d22785934b3f5e2a0039c)newSimulation()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::SimProject::newSimulation  ( const std::string &amp;  *pName*,    const std::string &amp;  *pType*   ) 

Create a new [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") folder in the [SimProject](classansys_1_1_project_1_1_sim_project.xhtml "Main object for Simulation based projects.").

Parameters pNameName of the new simulation, must be unique pTypeSolver type of the simulation (ex: ANSYS\_FLUENT) 



<a id="a4756ec52234c2f0f0e6609f4a10510ab" name="a4756ec52234c2f0f0e6609f4a10510ab"></a>## [◆ ](#a4756ec52234c2f0f0e6609f4a10510ab)removeSimulation()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::SimProject::removeSimulation  ( const std::string &amp;  *pName*,    bool  *pFlagErase*   ) 

Remove a named simulation from the project.

Parameters pNameName of the simulation pFlagEraseEnable to erase all files and subfolders 



<a id="ade8761d99b01d5fe7e75a68f944c4fa3" name="ade8761d99b01d5fe7e75a68f944c4fa3"></a>## [◆ ](#ade8761d99b01d5fe7e75a68f944c4fa3)setCurrentSimulation()

 void ansys::Project::SimProject::setCurrentSimulation  ( [Iterator](classansys_1_1_project_1_1_iterator.xhtml)  *pSim*) 

Set the current simulation link - i.e. the 'default' simulation.

The current simulation link is set automatically to any newly created simulation, and can be changed afterwards.





<a id="a4f6fa68a1de203d8ee8c306f03977422" name="a4f6fa68a1de203d8ee8c306f03977422"></a>## [◆ ](#a4f6fa68a1de203d8ee8c306f03977422)upgradeProject()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::SimProject::upgradeProject  ( )   virtual 

Upgrade project to current version.

See [Project::upgradeProject()](classansys_1_1_project_1_1_project.xhtml#aeeb9331e9e1324ba6fa24e84515df312 "Upgrade project to current version.") The [SimProject](classansys_1_1_project_1_1_sim_project.xhtml "Main object for Simulation based projects.") version will upgrade the [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") and related concepts to the latest project file format.

Reimplemented from [ansys::Project::Project](classansys_1_1_project_1_1_project.xhtml#aeeb9331e9e1324ba6fa24e84515df312).