8.0
general documentation
Examples of data settings for source terms with scalar in a channel

Additional right-hand side source terms for scalar equations (user scalars and specific physics scalars) with the cs_user_source_terms user-defined function.

Local variables and initialization

/* field structure */
const cs_field_t *f = cs_field_by_id(f_id);
/* local number of mesh cells */
const cs_lnum_t n_cells = cs_glob_mesh->n_cells;
/* mesh quantities */
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
cs_field_t * cs_field_by_id(int id)
Return a pointer to a field based on its id.
Definition: cs_field.c:2316
cs_mesh_t * cs_glob_mesh
cs_mesh_quantities_t * cs_glob_mesh_quantities
double precision, dimension(:), pointer cell_f_vol
fluid volume of each cell
Definition: mesh.f90:156
Field descriptor.
Definition: cs_field.h:130
cs_real_t * cell_vol
Definition: cs_mesh_quantities.h:97
cs_lnum_t n_cells
Definition: cs_mesh.h:97

Only apply to thermal scalar

return;
cs_field_t * cs_thermal_model_field(void)
Definition: cs_thermal_model.c:179

Function body

Map required fields

/* velocity */
const cs_real_3_t *cvar_vel = (const cs_real_3_t *)(CS_F_(vel)->val);
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:332
@ vel
Definition: cs_field_pointer.h:68
#define CS_F_(e)
Macro used to return a field pointer by its enumerated value.
Definition: cs_field_pointer.h:51

Compute bulk mean velocity

/* bulk mean velocity (x component) */
cs_real_t ubulk = 0;
for (cs_lnum_t i = 0; i < n_cells; i++)
ubulk += cvar_vel[i][0] * cell_f_vol[i];
cs_parall_sum(1, CS_DOUBLE, &ubulk); /* sum across processes if needed */
@ CS_DOUBLE
Definition: cs_defs.h:277
static void cs_parall_sum(int n, cs_datatype_t datatype, void *val)
Sum values of a given datatype on all default communicator processes.
Definition: cs_parall.h:160
cs_real_t tot_vol
Definition: cs_mesh_quantities.h:151

Compute source terms; we want to impose a total flux of 1 Watt.

/* Flux x Total surface / (rho Cp) */
cs_real_t tot_flux = 1.;
for (cs_lnum_t i = 0; i < n_cells; i++) {
st_imp[i] = 0.;
st_exp[i] = cell_f_vol[i] * cvar_vel[i][0] * tot_flux / ubulk;
}