Structure IRockyCFDModel

#include

IRockyCFDModel includes methods that provide basic information about the CFD model. The data associated to an IRockyCFDModel object resides entirely on host memory, consequently, it can be accessed only within hooks executed on the host side.

Members

• get_coupling_mode
• get_fluid_scalars
• get_phase_names
• get_primary_phase_name
• get_species_names
• has_species
• is_cfd_coupling_iteration
• is_single_phase

Public functions

Function get_fluid_scalars

![][const]

IRockyFluidScalarsModel IRockyCFDModel::get_fluid_scalars() const

Returns:

An IRockyFluidScalarsModel 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.

Return type: IRockyFluidScalarsModel

Function get_coupling_mode

![][const]

ECFDCouplingMode IRockyCFDModel::get_coupling_mode() const

Returns:

An 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

Return type: ECFDCouplingMode

Function is_cfd_coupling_iteration

![][const]

bool IRockyCFDModel::is_cfd_coupling_iteration() const

Returns:

On 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.

Return type: bool

Function is_single_phase

![][const]

bool IRockyCFDModel::is_single_phase() const

Returns:

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

Return type: bool

Function has_species

![][const]

bool IRockyCFDModel::has_species() const

Returns:

This method returns true if Fluent case has species.

Return type: bool

Function get_phase_names

std::vector std::string > IRockyCFDModel::get_phase_names()

Returns:

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

Return type: std::vector std::string >

Function get_primary_phase_name

std::string IRockyCFDModel::get_primary_phase_name()

Returns:

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

Return type: std::string

Function get_species_names

std::vector std::string > IRockyCFDModel::get_species_names()

Returns:

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

Return type: std::vector std::string >

[const]: https://img.shields.io/badge/-const-lightblue (const)