#include "base/cs_defs.h"
#include "base/cs_field.h"

Include dependency graph for cs_field_pointer.h:

Data Structures
struct	cs_field_pointer_array_t

Macros
#define	CS_ENUMF_(e)
	Macro used for scoping of field pointer enums.
#define	CS_F_(e)
	Macro used to return a field pointer by its enumerated value.
#define	CS_FI_(e, i)
	Macro used to return a field pointer by its enumerated value.

Enumerations

enum cs_field_pointer_id_t {
dt , p , pgr , pfr ,
vel , k , eps , rij ,
phi , f_bar , alp_bl , omg ,
nusa , hybrid_blend , mesh_u , void_f ,
vol_f , h , t , t_b ,
e_tot , h_tot , rho , rho_b ,
cp , cv , mu , mu_t ,
lambda , th_diff , poro , if_poro ,
t_poro , t_kelvin , vism , volume_f ,
mass_f , energy_f , pot_t , ntdrp ,
chemistry , fm , fp2m , fsm ,
npm , ygfm , potr , poti ,
potva , ycoel , joulp , radsc ,
elech , curre , curim , laplf ,
magfl , elefl , rad_energy , rad_q ,
radiance , rad_est , rad_ist , rad_abs ,
rad_emi , rad_cak , qinci , qinsp ,
xlam , epa , emissivity , fnet ,
fconv , hconv , fup , fdown ,
rad_ck_up , rad_ck_down , mol_mass , head ,
humid , ym_w , t_l_pack , yh_l_pack ,
y_l_pack , thermal_diff_h , thermal_diff_l , pack_zone_id ,
yf_ncond , qp , qfp , qfpxx ,
qfpxy , qfpxz , qfpyx , qfpyy ,
qfpyz , qfpzx , qfpzy , qfpzz ,
gamma , ia , x2 , d32 ,
drag , ad_mass , wlubr , th_diff_t ,
drho_dp , drho_dh , tau12_t , lift ,
disp_t , surf_tens , sl_corr , fi ,
fj , drift_vel , yplus , vel_mean ,
vel_rel , dt_dp , kindiff , coldiff ,
elast , c_alpha , add_var , user ,
CS_FIELD_N_POINTERS
}

Functions
void	cs_field_pointer_ensure_init (void)
	Ensure field pointer array is initialized.
void	cs_field_pointer_destroy_all (void)
	Free all field pointer data.
void	cs_field_pointer_map (cs_field_pointer_id_t e, cs_field_t *f)
	Map a simple field to an enumerated pointer.
void	cs_field_pointer_map_indexed (cs_field_pointer_id_t e, int index, cs_field_t *f)
	Map a field to an (enumerated pointer, index) couple.
void	cs_field_pointer_map_base (void)
	Map base fields to enumerated pointers.
void	cs_field_pointer_map_boundary (void)
	Map some boundary fields to enumerated pointers.
void	cs_field_pointer_map_atmospheric (int n_chem_species, const int species_f_id[])
	Map base fields to enumerated pointers for atmospheric models.

Variables
struct cs_field_pointer_array_t *	cs_glob_field_pointers

Macro Definition Documentation

◆ CS_ENUMF_

#define CS_ENUMF_ ( e )

Value:

CS_FIELD_POINTER_ ## e

Macro used for scoping of field pointer enums.

This macro replaces CS_ENUMF_ by CS_FIELD_POINTER_ and allows to rebuild a full enumerated field pointer id.

Parameters

[in] e suffix of enumerated field pointer id.

◆ CS_F_

#define CS_F_ ( e )

Value:

cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].f

cs_glob_field_pointers

struct cs_field_pointer_array_t * cs_glob_field_pointers

Definition cs_field_pointer.cpp:130

Macro used to return a field pointer by its enumerated value.

This macro replaces CS_F_ by an access to the global array of field pointers cs_glob_field_pointers using a rebuilt enumerated field pointer id.

Parameters

[in] e suffix of enumerated field pointer id.

◆ CS_FI_

#define CS_FI_	(		e,
			i )

Value:

cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].p[i]

Macro used to return a field pointer by its enumerated value.

This macro replaces CS_FI_ by an access to the global array of field pointers cs_glob_field_pointers using a rebuilt enumerated field pointer id and its field sublist index.

Parameters

[in]	e	suffix of enumerated field pointer id.
[in]	i	field enumerator value.

Enumeration Type Documentation

◆ cs_field_pointer_id_t

enum cs_field_pointer_id_t

Suffixes of enumerated field pointer ids, arguments of the macro CS_F_().

Enumerator
dt	local time step
p	pressure
pgr	granular pressure
pfr	frictional pressure
vel	velocity
k	turbulent kinetic energy
eps	turbulent dissipation $\varepsilon$
rij	Reynolds stress tensor $R_{ij}$
phi	$\phi$ for $\phi-f_b$ model
f_bar	for $\phi-f_b$ model
alp_bl	$\alpha$ for or EBRSM model
omg	$\omega$ for $k-\omega$ SST model
nusa	$\widetilde{\nu}_T$ for Spalart- Allmaras
hybrid_blend	Blending factor for DDES
mesh_u	mesh velocity
void_f	void fraction
vol_f	volume fraction
h	enthalpy
t	temperature
t_b	temperature (at boundary faces)
e_tot	total energy
h_tot	total enthalpy
rho	density (at cells)
rho_b	density (at boundary faces)
cp	isobaric specific heat
cv	isochoric specific heat
mu	molecular viscosity
mu_t	turbulent dynamic viscosity
lambda	Thermal conductivity
th_diff	Dynamic thermal diffusivity
poro	porosity
if_poro	internal faces porosity
t_poro	tensorial porosity
t_kelvin	temperature, in Kelvin
vism	mesh viscosity
volume_f	homogeneous model volume fraction
mass_f	homogeneous model mass fraction
energy_f	homogeneous model energy fraction
pot_t	potential temperature
ntdrp	total number of droplets
chemistry	chemistry species (indexed)
fm	mixture fraction
fp2m	mixture fraction variance
fsm	soot mass fraction
npm	soot precursor number
ygfm	fresh gas fraction
potr	Electric potential, real part
poti	Electric potential, imaginary part
potva	Vector potential
ycoel	Constituent mass fraction
joulp	Joule power
radsc	radiation source
elech	electric charge
curre	current real
curim	current imaginary
laplf	laplace forces
magfl	magnetic field
elefl	electric field
rad_energy	Radiative energy
rad_q	Radiative flux
radiance	(spectral) radiance field
rad_est	Radiative flux explicit source term
rad_ist	Radiative flux implicit source term
rad_abs	Radiative absorption
rad_emi	Radiative emission
rad_cak	Radiative absorption coefficient
qinci	Radiative incident radiative flux density
qinsp	Spectral radiative incident flux
xlam	Wall thermal conductivity
epa	Wall thickness
emissivity	Wall emissivity
fnet	Boundary radiative flux
fconv	Boundary radiative convective flux
hconv	radiative exchange coefficient
fup	Spectral upward radiative flux
fdown	Spectral downward radiative flux
rad_ck_up	Spectral upward Radiative absorption coefficient
rad_ck_down	Spectral downward Radiative absorption coefficient
mol_mass	gas mix molar max
head	hydraulic head
humid	Humidity
ym_w	Mass fraction of dry air in humid air
t_l_pack	Injected liquid water temperature
yh_l_pack	Injected liquid water enthalpy
y_l_pack	Mass of liquid per unit volume of cell
thermal_diff_h	Humid air thermal diffusivity
thermal_diff_l	Injected liquid water thermal diffusivity
pack_zone_id	Id of the packing zone
yf_ncond	non-condensable mass fraction
qp	Turbulent Kinetic Energy q2
qfp	Covariance q12
qfpxx	XX component of qfp
qfpxy	XY component of qfp
qfpxz	XZ component of qfp
qfpyx	YX component of qfp
qfpyy	YY component of qfp
qfpyz	YZ component of qfp
qfpzx	ZX component of qfp
qfpzy	ZY component of qfp
qfpzz	ZZ component of qfp
gamma	Interfacial mass transfer
ia	Interfacial area
x2	x2 for droplets
d32	Sauter diameter
drag	Phases drag
ad_mass	Added mass
wlubr	Wall lubrication
th_diff_t	Turbulent thermal diffusivity
drho_dp	drho over dp
drho_dh	drho over dh
tau12_t	turbulent tau12
lift	Lift coefficient
disp_t	Turbulent dispersion
surf_tens	Surface tension
sl_corr	Free surface correction weight for GLIM
fi	field_a vol_f weight for GLIM
fj	field_b vol_f weight for GLIM
drift_vel	Particles drift velocity
yplus	Wall distance: y+
vel_mean	Mean velocity (for dispersed phases)
vel_rel	Relative velocity (for dispersed phases)
dt_dp	dtemp/dpress derivative
kindiff	Particles kinetic diffusivity
coldiff	Particles collisional diffusivity
elast	Particles restitution coefficient
c_alpha	Weighting coefficient for GEMMA model
add_var	User added variables
user
CS_FIELD_N_POINTERS