7.0
general documentation
Variables
Field keywords

Variables

char * label
 
int coupled
 
int moment_id
 
int time_extrapolated
 
int limiter_choice
 
int scalar_id
 
cs_equation_param_t * var_cal_opt
 
cs_solving_info_t * solving_info
 
char * restart_file
 
int diffusivity_id
 
double diffusivity_ref
 

Detailed Description

Variable Documentation

◆ coupled

coupled

If > 0, this variable is coupled using the internal coupling mechanism.

Restricted to fields with CS_FIELD_VARIABLE type.

◆ diffusivity_id

diffusivity_id

Field if of the matching molecular diffusivity for a scalar. Negative value if the field has constant diffusivity.

If set to 0, a matching field will be created and its value reset automatically to that field's id. If set directly to a value > 0, it is assumed that the matching diffusivity field has already been defined and is associated with this scalar. This allows both creating an associated field automatically or in more advanced cases, sharing a diffusivity field between several scalars.

◆ diffusivity_ref

diffusivity_ref

Reference molecular diffusivity for a scalar ( $kg.m^{-1}.s^{-1}$). Negative value if not initialized or used.

Warning
: for a temperature, the diffusivity is defined as $\lambda/C_p$ where $\lambda$ and $C_p$ are the conductivity and specific heat. When using the Graphical Interface, $\lambda$ and $C_p$ are specified separately, and the matching molecular diffusivity is computed automatically.
With the compressible module, diffusivity_ref (given in uscfx2) is directly the thermal conductivity $W.m^{-1}.K^{-1}$.
With gas or coal combustion, the molecular diffusivity of the enthalpy ( $kg.m^{-1}.s^{-1}$) must be specified by the user in the variable ppthch::diftl0 "diftl0"(cs_user_combustion).
With the electric module, for the Joule effect, the diffusivity is specified by the user in cs_user_physical_properties.c (even if it is constant). For the electric arcs, it is calculated from the thermochemical data file.

◆ label

label

Optional label associated to the field; if NULL, name will be used instead.

◆ limiter_choice

limiter_choice

Integer corresponding to the type of Roe-Sweby Limiter:

  • 1: minmod
  • 2: Van-Leer
  • 3: Van-Albada
  • 4: superbee

Restricted to fields with CS_FIELD_VARIABLE type.

◆ moment_id

moment_id

If > -1, refers to the field if of which the current field is a time moment (see cs_time_moment.h). If < 0, the current field is not a time moment.

Restricted to fields with both CS_FIELD_VARIABLE and CS_FIELD_POSTPROCESS type.

◆ restart_file

restart_file

Indicates in which restart file the associated info may be found.

If NULL, default rules apply.

◆ scalar_id

scalar_id

Matching scalar id (inverse Fortran isca(iscal) ), or -1 if the field does not represent a solved scalar type variable.

◆ solving_info

solving_info

Structure containing the solving info of the field variables (used for log, not setup, so set NULL setup logging function)

Restricted to fields with CS_FIELD_VARIABLE type.

◆ time_extrapolated

time_extrapolated

Is the field time-extrapolated?

  • -1: default automatic value
  • 0: "standard" first-order: the value calculated at the beginning of the current time step (from the variables known at the end of the previous time step) is used
  • 1: second-order: the physical property $\phi$ is extrapolated according to the formula $\phi^{n+\theta}=[(1+\theta)\phi^n-\theta \phi^{n-1}]$, $\theta$ being given by the value of 0.5
  • 2: first-order: the physical property $\phi$ is extrapolated at $n+1$ according to the same formula as when = 1 but with $\theta$ = 1

◆ var_cal_opt

var_cal_opt

Structure containing the equation parameters of a solved variable.

Restricted to fields with CS_FIELD_VARIABLE type.