## On this page

  

 

 # IRockyCFDModel Struct Reference

 Last update: 16.07.2025 

`#include <<a class="el" href="rocky__cfd__model_8h_source.xhtml">rocky_cfd_model.h</a>>`

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

[IRockyFluidScalarsModel](structIRockyFluidScalarsModel.xhtml) [get\_fluid\_scalars](#a001b18af80c99c01ce4baa357bac4977) () const ECFDCouplingMode [get\_coupling\_mode](#a121e67b3f5efdd1783a32a7fa642080c) () const bool [is\_cfd\_coupling\_iteration](#a733281fb5b40b3cfbf10c29869208343) () const bool [is\_single\_phase](#a0eaf07fa0aa63473b83a633dad1e8f25) () const bool [has\_species](#a4ac3f8164add3366c5f08f4f819a79fd) () const std::vector&lt; std::string &gt; [get\_phase\_names](#a6bc367fb97d56786d71d89351957a2a1) () std::string [get\_primary\_phase\_name](#a83c9a597793b791d1e42e0756ddddb06) () std::vector&lt; std::string &gt; [get\_species\_names](#aac7f217cdfc15f0dd301dfd99127a194) () <a id="details" name="details"></a>## Detailed Description

`<a class="el" href="structIRockyCFDModel.xhtml">IRockyCFDModel</a>` includes methods that provide basic information about the CFD model. The data associated to an `<a class="el" href="structIRockyCFDModel.xhtml">IRockyCFDModel</a>` object resides entirely on host memory, consequently, it can be accessed only within hooks executed on the host side.



## Member Function Documentation

<a id="a121e67b3f5efdd1783a32a7fa642080c" name="a121e67b3f5efdd1783a32a7fa642080c"></a>## [◆ ](#a121e67b3f5efdd1783a32a7fa642080c)get\_coupling\_mode()

 ECFDCouplingMode IRockyCFDModel::get\_coupling\_mode  ( )  const

ReturnsAn `ECFDCouplingMode` enum which represents the CFD coupling mode. There are 5 coupling modes in Rocky:  
`cfdcNone = 0`  
`cfdcOneWay = 1`  
`cfdcTwoWay = 2`  
`cfdcOneWayConstant = 3`  
`cfdcTwoWaySemiResolved = 4` 



<a id="a001b18af80c99c01ce4baa357bac4977" name="a001b18af80c99c01ce4baa357bac4977"></a>## [◆ ](#a001b18af80c99c01ce4baa357bac4977)get\_fluid\_scalars()

 [IRockyFluidScalarsModel](structIRockyFluidScalarsModel.xhtml) IRockyCFDModel::get\_fluid\_scalars  ( )  const

ReturnsAn `<a class="el" href="structIRockyFluidScalarsModel.xhtml">IRockyFluidScalarsModel</a>` object, which allows users to add new fluid scalars during a setup of a module. Fluid scalars are special variables attached to CFD cell elements that are able to store values that are preserved between time iterations. 



<a id="a6bc367fb97d56786d71d89351957a2a1" name="a6bc367fb97d56786d71d89351957a2a1"></a>## [◆ ](#a6bc367fb97d56786d71d89351957a2a1)get\_phase\_names()

 std::vector&lt; std::string &gt; IRockyCFDModel::get\_phase\_names  ( ) 

ReturnsThis method returns a vector with phase names. It returns an empty vector for single-phase cases. 



<a id="a83c9a597793b791d1e42e0756ddddb06" name="a83c9a597793b791d1e42e0756ddddb06"></a>## [◆ ](#a83c9a597793b791d1e42e0756ddddb06)get\_primary\_phase\_name()

 std::string IRockyCFDModel::get\_primary\_phase\_name  ( ) 

ReturnsThis method returns the primary phase name defined in Fluent. It return a empty string for single-phase cases. 



<a id="aac7f217cdfc15f0dd301dfd99127a194" name="aac7f217cdfc15f0dd301dfd99127a194"></a>## [◆ ](#aac7f217cdfc15f0dd301dfd99127a194)get\_species\_names()

 std::vector&lt; std::string &gt; IRockyCFDModel::get\_species\_names  ( ) 

ReturnsThis method returns a vector with species names. It returns an empty vector for cases without species. 



<a id="a4ac3f8164add3366c5f08f4f819a79fd" name="a4ac3f8164add3366c5f08f4f819a79fd"></a>## [◆ ](#a4ac3f8164add3366c5f08f4f819a79fd)has\_species()

 bool IRockyCFDModel::has\_species  ( )  const

ReturnsThis method returns true if Fluent case has species. 



<a id="a733281fb5b40b3cfbf10c29869208343" name="a733281fb5b40b3cfbf10c29869208343"></a>## [◆ ](#a733281fb5b40b3cfbf10c29869208343)is\_cfd\_coupling\_iteration()

 bool IRockyCFDModel::is\_cfd\_coupling\_iteration  ( )  const

ReturnsOn simulations with CFD 1-way or 2-way coupling, this methods returns true if, in the current solver iteration, Rocky will communicate with Fluent (2-way) or read Fluent transient data (1-way). Both operations happen at the end of the iteration, after all Rocky steps. It return false in all other scenarios. 



<a id="a0eaf07fa0aa63473b83a633dad1e8f25" name="a0eaf07fa0aa63473b83a633dad1e8f25"></a>## [◆ ](#a0eaf07fa0aa63473b83a633dad1e8f25)is\_single\_phase()

 bool IRockyCFDModel::is\_single\_phase  ( )  const

ReturnsThis method returns true if Fluent case is single-phase.