IRockyCFDModel Struct Reference
Last update: 16.07.2025#include <rocky_cfd_model.h>
Public Member Functions | |
| IRockyFluidScalarsModel | get_fluid_scalars () const |
| ECFDCouplingMode | get_coupling_mode () const |
| bool | is_cfd_coupling_iteration () const |
| bool | is_single_phase () const |
| bool | has_species () const |
| std::vector< std::string > | get_phase_names () |
| std::string | get_primary_phase_name () |
| std::vector< std::string > | get_species_names () |
Detailed Description
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.
Member Function Documentation
◆ get_coupling_mode()
| ECFDCouplingMode IRockyCFDModel::get_coupling_mode | ( | ) | const |
- Returns
- An
ECFDCouplingModeenum which represents the CFD coupling mode. There are 5 coupling modes in Rocky:cfdcNone = 0cfdcOneWay = 1cfdcTwoWay = 2cfdcOneWayConstant = 3cfdcTwoWaySemiResolved = 4
◆ get_fluid_scalars()
| IRockyFluidScalarsModel IRockyCFDModel::get_fluid_scalars | ( | ) | const |
- Returns
- An
IRockyFluidScalarsModelobject, 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.
◆ 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.
◆ 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.
◆ 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.
◆ has_species()
| bool IRockyCFDModel::has_species | ( | ) | const |
- Returns
- This method returns true if Fluent case has species.
◆ is_cfd_coupling_iteration()
| 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.
◆ is_single_phase()
| bool IRockyCFDModel::is_single_phase | ( | ) | const |
- Returns
- This method returns true if Fluent case is single-phase.
