## On this page

  

 

 # IRockyCFDModel Struct Reference

 Last update: 17.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](structIRockyCFDModel.xhtml#a001b18af80c99c01ce4baa357bac4977) () const ECFDCouplingMode [get\_coupling\_mode](structIRockyCFDModel.xhtml#a121e67b3f5efdd1783a32a7fa642080c) () const bool [is\_cfd\_coupling\_iteration](structIRockyCFDModel.xhtml#a733281fb5b40b3cfbf10c29869208343) () const <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="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.