## On this page

  

 

 # IRockyCFDProperties Struct Reference

 Last update: 16.07.2025 

`#include <<a class="el" href="rocky__cfd_8hpp_source.xhtml">rocky_cfd.hpp</a>>`

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

ROCKY\_FUNCTIONS double [get\_fluid\_density](#ad1b8eb5a0bb1345469d62bcd8429daf8) () const ROCKY\_FUNCTIONS double [get\_fluid\_viscosity](#ace8fe3ed8b6755c7594c337ded2fbe58) () const ROCKY\_FUNCTIONS double [get\_fluid\_temperature](#a9efc8d5c0074cae18fcbcada620ae162) () const ROCKY\_FUNCTIONS double [get\_fluid\_specific\_heat](#a6f7d6f28278bd653921f6dd19b8972f1) () const ROCKY\_FUNCTIONS double [get\_fluid\_thermal\_conductivity](#a2bc489cf137e3010d27ee7165d62f8ef) () const ROCKY\_FUNCTIONS double3 [get\_fluid\_pressure\_gradient](#a50a9b64cedef031bdf38377de0d0665a) () const ROCKY\_FUNCTIONS double3 [compute\_fluid\_vorticity](#a9070705d5011bf627a5ca1e083b28bb7) () const ROCKY\_FUNCTIONS double3 [get\_relative\_velocity](#a891e79c0311177f586f49ead9b9a182f) () const ROCKY\_FUNCTIONS double [get\_reynolds\_number](#a56a3b748ff0a15c3b4870b5fd240bd53) () const ROCKY\_FUNCTIONS double [compute\_vorticity\_reynolds\_number](#a6fd3d1388c1b57c53e0d6a0966ecbd0b) () const ROCKY\_FUNCTIONS double [compute\_relative\_angular\_reynolds\_number](#adc32c375f6f3d377b21cd019c336e8c5) (const double3 &amp;particle\_angular\_velocity) const ROCKY\_FUNCTIONS double [get\_prandtl\_number](#a345be7a5c45f89f292fb864311c36ad6) () const ROCKY\_FUNCTIONS double [get\_solid\_fraction](#af868d4c581ae2e98db27b2785523b688) () const ROCKY\_FUNCTIONS double [get\_cell\_volume](#a07a10f12cf5cb16540107a1272e3cea9) () const ROCKY\_FUNCTIONS [IRockyFluidScalars](structIRockyFluidScalars.xhtml) [get\_scalars](#a995c4c9158aff6f72e0b1fdfe39dac9f) () const ROCKY\_FUNCTIONS double [get\_cfd\_time\_step](#a39fb9991d8c793491701fa07c269de2e) () const <a id="details" name="details"></a>## Detailed Description

`<a class="el" href="structIRockyCFDProperties.xhtml">IRockyCFDProperties</a>` gives access to data and utility methods commonly needed for calculating interaction magnitudes between the fluid flow and a particle. The property values returned by those methods are referred either to a particle, or the CFD cell in which that particle is currently located, or both. In the special case of a 1-way constant coupling mode, as there is no CFD mesh associated, the fluid properties returned are the constant values prescribed through the Rocky UI.



## Member Function Documentation

<a id="a9070705d5011bf627a5ca1e083b28bb7" name="a9070705d5011bf627a5ca1e083b28bb7"></a>## [◆ ](#a9070705d5011bf627a5ca1e083b28bb7)compute\_fluid\_vorticity()

 ROCKY\_FUNCTIONS double3 IRockyCFDProperties::compute\_fluid\_vorticity  ( )  const

ReturnsThe vorticity vector associated to the fluid flow within the CFD cell in which the interacting particle is located. The vorticity is defined as the curl of the fluid velocity. 



<a id="adc32c375f6f3d377b21cd019c336e8c5" name="adc32c375f6f3d377b21cd019c336e8c5"></a>## [◆ ](#adc32c375f6f3d377b21cd019c336e8c5)compute\_relative\_angular\_reynolds\_number()

 ROCKY\_FUNCTIONS double IRockyCFDProperties::compute\_relative\_angular\_reynolds\_number  ( const double3 &amp; *particle\_angular\_velocity*)  const

ReturnsThe Reynolds number value, based on the relative angular velocity and the particle's equivalent diameter. For more details, please refer to the DEM-CFD Coupling Technical Manual regarding this topic. Torque laws are commonly expressed using this Reynolds number. 



<a id="a6fd3d1388c1b57c53e0d6a0966ecbd0b" name="a6fd3d1388c1b57c53e0d6a0966ecbd0b"></a>## [◆ ](#a6fd3d1388c1b57c53e0d6a0966ecbd0b)compute\_vorticity\_reynolds\_number()

 ROCKY\_FUNCTIONS double IRockyCFDProperties::compute\_vorticity\_reynolds\_number  ( )  const

ReturnsThe Reynolds number value, based on the flow vorticity and the particle's equivalent diameter. For more details, please refer to the DEM-CFD Coupling Technical Manual regarding this topic. Lift coefficients are usually expressed as functions of this Reynolds number. 



<a id="a07a10f12cf5cb16540107a1272e3cea9" name="a07a10f12cf5cb16540107a1272e3cea9"></a>## [◆ ](#a07a10f12cf5cb16540107a1272e3cea9)get\_cell\_volume()

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_cell\_volume  ( )  const

ReturnsThe volume of the CFD cell in which the interacting particle is located. Before calling this method, one should enable it by calling the method `<a class="el" href="structIRockyFluidScalarsModel.xhtml#a6f1e21645261447c930050eff3ecb35b">IRockyFluidScalarsModel::enable_storage_cell_volume()</a>` 



<a id="a39fb9991d8c793491701fa07c269de2e" name="a39fb9991d8c793491701fa07c269de2e"></a>## [◆ ](#a39fb9991d8c793491701fa07c269de2e)get\_cfd\_time\_step()

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_cfd\_time\_step  ( )  const

ReturnsThe CFD time step 



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

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_fluid\_density  ( )  const

ReturnsThe value of the fluid density within the CFD cell in which the interacting particle is located. 



<a id="a50a9b64cedef031bdf38377de0d0665a" name="a50a9b64cedef031bdf38377de0d0665a"></a>## [◆ ](#a50a9b64cedef031bdf38377de0d0665a)get\_fluid\_pressure\_gradient()

 ROCKY\_FUNCTIONS double3 IRockyCFDProperties::get\_fluid\_pressure\_gradient  ( )  const

ReturnsThe pressure gradient in the fluid within the CFD cell in which the interacting particle is located, expressed in Cartesian coordinates. 



<a id="a6f7d6f28278bd653921f6dd19b8972f1" name="a6f7d6f28278bd653921f6dd19b8972f1"></a>## [◆ ](#a6f7d6f28278bd653921f6dd19b8972f1)get\_fluid\_specific\_heat()

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_fluid\_specific\_heat  ( )  const

ReturnsThe value of the fluid specific heat within the CFD cell in which the interacting particle is located. 



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

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_fluid\_temperature  ( )  const

ReturnsThe value of the fluid temperature within the CFD cell in which the interacting particle is located. This temperature will be available only if the energy equation is solved in Fluent and/or thermal modeling is enabled in Rocky. 



<a id="a2bc489cf137e3010d27ee7165d62f8ef" name="a2bc489cf137e3010d27ee7165d62f8ef"></a>## [◆ ](#a2bc489cf137e3010d27ee7165d62f8ef)get\_fluid\_thermal\_conductivity()

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_fluid\_thermal\_conductivity  ( )  const

ReturnsThe value of the fluid thermal conductivity within the CFD cell in which the interacting particle is located. 



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

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_fluid\_viscosity  ( )  const

ReturnsThe value of the fluid absolute viscosity within the CFD cell in which the interacting particle is located. 



<a id="a345be7a5c45f89f292fb864311c36ad6" name="a345be7a5c45f89f292fb864311c36ad6"></a>## [◆ ](#a345be7a5c45f89f292fb864311c36ad6)get\_prandtl\_number()

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_prandtl\_number  ( )  const

ReturnsThe Prandtl number value, defined as the ratio of the fluid's momentum diffusivity to its thermal diffusivity. For more details, please refer to the DEM-CFD Coupling Technical Manual regarding this topic. 



<a id="a891e79c0311177f586f49ead9b9a182f" name="a891e79c0311177f586f49ead9b9a182f"></a>## [◆ ](#a891e79c0311177f586f49ead9b9a182f)get\_relative\_velocity()

 ROCKY\_FUNCTIONS double3 IRockyCFDProperties::get\_relative\_velocity  ( )  const

ReturnsThe relative velocity vector in Cartesian coordinates. In this context, the relative velocity is defined as the difference between the fluid velocity and the particle velocity. 



<a id="a56a3b748ff0a15c3b4870b5fd240bd53" name="a56a3b748ff0a15c3b4870b5fd240bd53"></a>## [◆ ](#a56a3b748ff0a15c3b4870b5fd240bd53)get\_reynolds\_number()

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_reynolds\_number  ( )  const

ReturnsThe Reynolds number value, based on the relative velocity and the particle's equivalent diameter. For more details, please refer to the DEM-CFD Coupling Technical Manual regarding this topic. Drag coefficients in most of the drag laws found in the literature are expressed as functions of this Reynolds number. 



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

 ROCKY\_FUNCTIONS [IRockyFluidScalars](structIRockyFluidScalars.xhtml) IRockyCFDProperties::get\_scalars  ( )  const

ReturnsAn `<a class="el" href="structIRockyFluidScalars.xhtml">IRockyFluidScalars</a>` object that gives access to the values of all CFD fluid scalars defined in the project at the CFD cell in which the interacting particle is located. 



<a id="af868d4c581ae2e98db27b2785523b688" name="af868d4c581ae2e98db27b2785523b688"></a>## [◆ ](#af868d4c581ae2e98db27b2785523b688)get\_solid\_fraction()

 ROCKY\_FUNCTIONS double IRockyCFDProperties::get\_solid\_fraction  ( )  const

ReturnsThe solid fraction at the CFD cell in which the interacting particle is located. This parameter is defined as the ratio between the volume of the particles within that cell to the volume of the cell itself. In Fluent Two Way cases, the value of the solid fraction may be altered by a Lagrangian-to-Eulerian mapping procedure. For more details, please refer to the DEM-CFD Coupling Technical Manual.