![]() |
programmer's documentation
|
#include "cs_defs.h"
Go to the source code of this file.
Data Structures | |
struct | cs_field_pointer_array_t |
union | cs_field_pointer_val_t |
Macros | |
#define | CS_ENUMF_(e) CS_FIELD_POINTER_ ## e |
Macro used for scoping of field pointer enums. More... | |
#define | CS_F_(e) cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].f |
Macro used to return a field pointer by its enumerated value. More... | |
#define | CS_FI_(e, i) cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].a->p[i] |
Macro used to return a field pointer by its enumerated value. More... | |
Enumerations | |
enum | cs_field_pointer_id_t { dt, p, u, k, eps, r11, r22, r33, r12, r23, r13, rij, phi, f_bar, alpha, omg, nusa, mesh_u, void_f, h, t, t_b, energy, rho, rho_b, cp, cv, mu, mu_t, poro, t_poro, t_kelvin, pot_t, totwt, ntdrp, chemistry, fm, fp2m, fsm, npm, ygfm, yfm, yfp2m, coyfp, np, xch, xck, xwt, h2, f1m, f2m, f4m, f5m, f6m, f7m, f8m, f9m, fvp2m, yco2, yhcn, yno, ynh3, hox, potr, poti, potva, ycoel, rad_lumin, rad_q, rad_ets, rad_its, rad_abs, rad_emi, rad_cak, qinci, xlam, epa, emissivity, fnet, fconv, hconv, mol_mass, CS_FIELD_N_POINTERS } |
Functions | |
void | cs_field_pointer_destroy_all (void) |
Free all field pointer data. More... | |
void | cs_field_pointer_map (cs_field_pointer_id_t e, cs_field_t *f) |
Map a simple field to an enumerated pointer. More... | |
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. More... | |
void | cs_field_pointer_map_base (void) |
Map base fields to enumerated pointers. More... | |
void | cs_field_pointer_map_boundary (void) |
Map some boundary fields to enumerated pointers. More... | |
void | cs_field_pointer_map_atmospheric (int n_chem_species, const int species_f_id[]) |
Map base fields to enumerated pointers for atmospheric models. More... | |
void | cs_field_pointer_map_coal_combustion (int n_coals, int n_classes) |
Map base fields to enumerated pointers for coal combustion. More... | |
void | cs_field_pointer_map_compressible (void) |
Map base fields to enumerated pointers for compressible model. More... | |
void | cs_field_pointer_map_gas_mix (void) |
Map base fields to enumerated pointers for gas mix model. More... | |
void | cs_field_pointer_map_electric_arcs (int n_gasses) |
Map base fields to enumerated pointers for electric arcs. More... | |
void | cs_field_pointer_map_gas_combustion (void) |
Map base fields to enumerated pointers for gas combustion. More... | |
void | cs_field_pointer_map_radiation (int n_r_phases) |
Map base fields to enumerated pointers for radiation module. More... | |
Variables | |
union cs_field_pointer_val_t * | cs_glob_field_pointers |
CS_ENUMF_ | ( | e | ) | 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.
[in] | e | suffix of enumerated field pointer id. |
CS_F_ | ( | e | ) | cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].f |
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.
[in] | e | suffix of enumerated field pointer id. |
CS_FI_ | ( | e, | |
i | |||
) | cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].a->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.
[in] | e | suffix of enumerated field pointer id. |
[in] | i | field enumerator value. |
Suffixes of enumerated field pointer ids, arguments of the macro CS_F_().
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.
The associated field pointer may then be retreived using CS_F_(e).
[in] | e | field enumerator value |
[in] | f | pointer to field structure |
void cs_field_pointer_map_atmospheric | ( | int | n_chem_species, |
const int | species_f_id[] | ||
) |
Map base fields to enumerated pointers for atmospheric models.
[in] | n_chem_species | number of chemical species |
[in] | species_f_id | field id for each chemical species |
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_coal_combustion | ( | int | n_coals, |
int | n_classes | ||
) |
Map base fields to enumerated pointers for coal combustion.
[in] | n_coals | number of coals |
[in] | n_classes | number of coal classes |
void cs_field_pointer_map_compressible | ( | void | ) |
Map base fields to enumerated pointers for compressible model.
void cs_field_pointer_map_electric_arcs | ( | int | n_gasses | ) |
Map base fields to enumerated pointers for electric arcs.
[in] | n_gasses | number of gasses |
void cs_field_pointer_map_gas_combustion | ( | void | ) |
Map base fields to enumerated pointers for gas combustion.
void cs_field_pointer_map_gas_mix | ( | void | ) |
Map base fields to enumerated pointers for gas mix model.
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.
This sort of mapping may be used for sets of fields whose size is not known in advance.
The associated field pointer may then be retreived using CS_F_(e, i).
[in] | e | field enumerator value |
[in] | index | field enumerator index |
[in] | f | pointer to field structure |
void cs_field_pointer_map_radiation | ( | int | n_r_phases | ) |
Map base fields to enumerated pointers for radiation module.
[in] | n_r_phases | number of radiating phases: 1 + possibly number of combustible classes (coal, fuel) |
union cs_field_pointer_val_t* cs_glob_field_pointers |