8.3
general documentation
How to name common local variables?

The following table provides a non-exhaustive list of local variables which are used in the code in a recurring manner.

C code Description
cell_id Cell index
face_id Face index
tr_dim Indicator for tensor perodicity of rotation
i_massflux Mass flux at interior faces
b_massflux Mass flux at boundary faces
i_visc $ \mu_\fij \dfrac{S_\fij}{\ipf \jpf} $
at interior faces for the r.h.s.
b_visc $ \mu_\fib \dfrac{S_\fib}{\ipf \centf} $
at border faces for the r.h.s.
rhs Right hand side $ \vect{Rhs} $

Local naming convention for fields (C)

Rules have been established for local names denoting fields, depending on their nature. The convention is as follows:

  • The first letter of the name indicates the location at which the field values are defined:
    • c for values at the cell centers.
    • i for values at the interior faces.
    • b for values at the boundary faces.
  • The next three letters indicate if the field is a variable (at the current time step or the previous time step) or a property:
    • var for variables at the current time step.
    • vara for variables at the previous time step.
    • pro for properties.
  • An underscore _ follows.

The following examples illustrate this convention:

cvar_pr: Values of the variable pressure field defined at the cell centers, at the current time step.
cvara_pr: Values of the variable pressure field defined at the cell centers, at the previous time step.
cpro_cp: Values of the property specific heat defined field at the cell centers.