Encyclopaedia Index

Reserved Names of Patches or Variables

Contents

  1. Introduction
  2. Patch names
  3. Variable names
    ABCDEFGHIJKLM
    NOPQRSTUVWXY Z#
  4. Fortran variables used for properties


1. INTRODUCTION

The use of special names for patches or variables is a powerful and flexible technique which users can employ for defining and controlling the flow simulations performed by PHOENICS.

Many such names are employed in the versions of PHOENICS which are delivered to users. They are here called 'reserved names'; and users are warned that, when introducing new variables for their own use, they should always avoid using those which are reserved. In particular, although they may rename any of the first 17 reserved variables, they should not seek to give them any non-standard physical significance. For example, to re-name H1 (first-phase sepcific enthalpy) as EPOT (electric potential) could have undesired consequences.

This Encyclopaedia article provides lists, and brief explanations of the names which have been reserved so far.

Numerous new reserved names of variables have been introduced into PHOENICS in recent years, especially in order to facilitate:

The recently-introduced features are listed in the 'included' COMMON file lbnamer where explanatory comments are to be found.

Click here for reserved variable names
or here for reserved patch names


2. PATCH NAMES

Contents


First character

        . as the first  character. see PHENC entry: DOT-PATCH

        & as the first  character. see PHENC entry: Group 12

        * as the first  character. see PHENC entry: STAR-NAME

        $ as the first  character. see PHENC entry: DOLLAR-NAME

        > as the first  character. see PHENC entry: GT-NAME

        + as the first  character. see PHENC entry: LINK

        - as the first  character. see PHENC entry: none

        + as the second character. see PHENC entry: LINK

        - as the second character. see PHENC entry: LINEAR LINKS

Second character

        % as the second character. followed by:-

        SE as the 2nd and 3rd characters. See PHENC entry: MASK

        SW as the 2nd and 3rd characters. See PHENC entry: MASK

        SH as the 2nd and 3rd characters. See PHENC entry: MASK

        SL as the 2nd and 3rd characters. See PHENC entry: MASK

        WN as the 2nd and 3rd characters. See PHENC entry: MASK

        WH as the 2nd and 3rd characters. See PHENC entry: MASK

        WL as the 2nd and 3rd characters. See PHENC entry: MASK

        EX as the 2nd and 3rd characters. See PHENC entry: MASK

        EY as the 2nd and 3rd characters. See PHENC entry: MASK

        EZ as the 2nd and 3rd characters. See PHENC entry: MASK

        DX as the 2nd and 3rd characters. See PHENC entry: MASK

        PX as the 2nd and 3rd characters. See PHENC entry: MASK

        DY as the 2nd and 3rd characters. See PHENC entry: MASK

        OY as the 2nd and 3rd characters. See PHENC entry: MASK

        DZ as the 2nd and 3rd characters. See PHENC entry: MASK

        OZ as the 2nd and 3rd characters. See PHENC entry: MASK

        NE as the 2nd and 3rd characters

        RAD as the 2nd, 3rd and 4th characters,

                                   see the PHENC entry: STAR-NAME

        POL as the 2nd, 3rd and 4th characters,

        TIM as the 2nd, 3rd and 4th characters, see

First four characters

        BUOY as the 1st, 2nd, 3rd and 4th characters,

        BLIN as the 1st, 2nd, 3rd and 4th characters,

        CHSO as the 1st, 2nd, 3rd and 4th characters,

        CLDA as the 1st, 2nd, 3rd and 4th characters,

        GP12 as the 1st, 2nd, 3rd and 4th characters, see GROUP 12 features

        IBFC as the 1st, 2nd, 3rd and 4th characters,

        IMBL as the 1st, 2nd, 3rd and 4th characters, see IMBAL

        IPST as the 1st, 2nd, 3rd and 4th characters,

        KEDI as the 1st, 2nd, 3rd and 4th characters,

        KESO as the 1st, 2nd, 3rd and 4th characters,

        LATG as the 1st, 2nd, 3rd and 4th characters,

        LESO as the 1st, 2nd, 3rd and 4th characters,

        OUTL as the 1st, 2nd, 3rd and 4th characters,

        PROF as the 1st, 2nd, 3rd and 4th characters,

        RADI as the 1st, 2nd, 3rd and 4th characters,

        ROTA as the 1st, 2nd, 3rd and 4th characters,

        SHSO as the 1st, 2nd, 3rd and 4th characters,

        NOCP as the 1st, 2nd, 3rd and 4th characters,

First five characters

        INIPOL as the 1st 5 characters, see

        INIPOL


3. RESERVED NAMES OF SOLVED & STORED VARIABLES

3.1 The first 17 variables: P1......C2

These variables are:
numbernamemeaningtypical units
1 P1 first-phase pressure N/m2
2 P2 second-phase pressureN/m2
3 U1 first-phase x-direction velocity m/s
4 U2 second-phase x-direction velocitym/s
5 V1 first-phase y-direction velocitym/s
6 V2 second-phase y-direction velocitym/s
7 W1 first-phase z-direction velocitym/s
8 W2 second-phase z-direction velocitym/s
9 R1 first-phase volume fractionnone
10R2 second-phase volume fractionnone
11RS second-phase shadow volume fractionnone
12KE kinetic energy of turbulencsJ/kg
13EP dissipation rate ofturbulence energyJ/(kg s)
14H1 first-phase epecific enthalpyJ/kg
15H2 second-phase epecific enthalpyJ/kg
16 C1 first-phase component concentration none
17 C2 first-phase component concentrationnone

3.2 Variables which may be placed in any order

When the command: STORE(reserved name) appears in a Q1 file, the PHOENICS solver module, EARTH, computes, and makes available for printing or graphical display, the corresponding quantity, as explained below.

It should however be understood that the STORE statement may not be sufficient. Thus:

The discussion deals with complete names first and partial names second.

  1. Complete names

    the name : the corresponding quantity
      • APRJ : projected area of particles per unit volume in an inter-phase-friction model
      • AREE : east cell-face area
      • AREN : north cell-face area
      • AREH : high cell-face area
      • ARRT : flame-arrival time
      • BLOK
      • BTAU : quantity used in the Bingham model of Non-Newtonian fluids
      • CD : non-dimensional drag coefficient in an inter-phase-friction model
      • CFIP : inter-phase friction coefficient
      • CHAR
      • CMDO : mass-transfer rate from phase 2 to phase 2 for the cell
      • CMI1 : mass of phase 1 entering the cell from outside the domain MIN1, divided by the pressure difference which drives it
      • CMI2 : mass of phase 2 entering the cell from outside the domain MIN2, divided by the pressure difference which drives it
      • CNE1 : outward convection flux (kg/s) of phase 1 through east cell face
      • CNE2 : outward convection flux (kg/s) of phase 2 through east cell face
      • CNN1 : outward convection flux (kg/s) of phase 1 through north cell face
      • CNN2 : outward convection flux (kg/s) of phase 2 through north cell face
      • CNH1 : outward convection flux (kg/s) of phase 1 through high cell face
      • CNH2 : outward convection flux (kg/s) of phase 2 through high cell face
      • CONI : as for CNE1 for (possibly moving) body-fitted coordinates
      • CONJ : as for CNN1 for (possibly moving) body-fitted coordinates
      • CONK : as for CNH1 for (possibly moving) body-fitted coordinates
      • CP1 : phase-1 specific-heat at constant pressure
      • CP2 : phase-2 specific-heat at constant pressure
      • CTI1 : inward convection flux (kg/s) of phase 1 through 'time face'
      • CTI2 : inward convection flux (kg/s) of phase 2 through 'time face'
      • CTO1 : outward convection flux (kg/s) of phase 1 through 'time face'
      • CTO2 : outward convection flux (kg/s) of phase 2 through 'time face'
      • CUTC : indicator of whether a cell has 'cut-cell' status
      • DEN1 : phase-1 density
      • DEN2 : : phase-2 density
      • DIAM : diameter of particle in various two-phase models
      • DILA
      • DP1X : X-direction pressure correction difference
      • DP1Y : Y-direction pressure correction difference
      • DP1Z : Z-direction pressure correction difference
      • DRH1 : rate of change of log(phase-1 density) with pressure
      • DRH2 : rate of change of log(phase-1 density) with pressure
      • DU1P : rate of change of U1 with pressure difference
      • DV1P : rate of change of V1 with pressure difference
      • DVO1 : rate of change of log(phase-1 specific volume) with temperature
      • DVO2 : rate of change of log(phase-2 specific volume) with temperature
      • DW1P : rate of change of W1 with pressure difference
      • DU2P: rate of change of U2 with pressure difference
      • DV2P: rate of change of V2 with pressure difference
      • DW2P: rate of change of W2 with pressure difference
      • EFEH:
      • EFNE:
      • EFNH:
      • EL1 : mixing-length of turbulence, for phase 1
      • EL2 : mixing-length of turbulence, for phase 2
      • EMIS: emissivity (also absorptivity) of radiant energy per unit volume
      • ENUL: laminar viscosity
      • ENUT : turbulent contribution to the effective viscosity
      • EOTV: Eotvos number used in Ellipsoidal-Bubble "Clean-water" Drag correlation
      • EPKE: dissipation rate of turbulence energy per unit volume, epsilon, divided by turbulence energy, k
      • EPOT: potential - no convection or transient terms, no turbulent diffusion
      • FONE: Damping function in Lam-Bremhorst Low-Reynolds Number turbulence model
      • FSQ : root-mean square of composition variable F in Presumed-PDF combustion model.
      • FTWO: as FONE
      • FMU : as FONE
      • FOMG: multiplier FW in MMK turbulence model
      • FUEL : mass fraction of unburned fuel in a simple chemically-reacting system (SCRS)
      • FWD : Mass fraction Wood derivative
      • FC : Carbon content for wood combustion model
      • FH : Hydrogen content for wood combustion model
      • FO : Oxygen content for wood combustion model
      • FN : Nitrogen content for wood combustion model
      • GEN1: sum of squares of phase-1 velocity gradients
      • GEN2: sum of squares of phase-2 velocity gradients
      • GENK: effective viscosity times GEN1
      • GNK2: effective viscosity times GEN2
      • H0_1: enthalpy of phase 1 at zero temperature
      • H0_2: enthalpy of phase 2 at zero temperature
      • HTCO: heat-transfer coefficient derived from wall function
      • HFLX: heat flux
      • INTF: as for CFIP
      • INTM: as for CMDO
      • ISVR : for debugging cut cell masking
      • No variables starting 'J' at present.
      • KOND: the thermal conductivity (for phase 1)
      • KND2: the thermal conductivity for phase 2
      • LEN1: as for EL1
      • LEN2: as for EL2
      • LIMB: similar to object-identifier, OBID; used for MOFOR
      • LTLS: variable solved in order to deduce values of WDIS and WGAP
      • MACH: MACH Number of phase 1 fluid
      • MACZ: MACH Number based on Z velocity used for parabolic option IPARAB=5.
      • MAC2: Mach Number of phase 2 fluid
      • MARK: variable used in InForm to 'mark' cells
      • MAS1: mass of phase 1 in the cell
      • MAS2: mass of phase 2 in the cell
      • MDOT: as for CMDO
      • MIXF: 'mixture fraction', i.e. mass fraction of (burned or unburned) material emanating from the fuel-bearing stream in a Simple Chemically-Reacting System.
      • MIN1: mass of phase 1 entering the cell from outside the domain
      • MIN2: mass of phase 2 entering the cell from outside the domain
      • MXF1 - MXF7: mass fraction of material from inlet 1 - 7 in wood combustion model (7 gasses)
      • OBID: object identifier, used for MOFOR
      • OXID: oxidant mass fraction when a Simple Chemically Reacting System is being modelled
      • PDCX: cell-to-cell pressure decrement in x-direction
      • PDCY: cell-to-cell pressure decrement in y-direction
      • PDCZ: cell-to-cell pressure decrement in z-direction
      • PHDE: phase 2 diffusion flux in X direction
      • PHDN: phase 2 diffusion flux in X direction
      • PHDH: phase 2 diffusion flux in X direction
      • POT : velocity potential
      • PROD: product mass fraction when a Simple Chemically Reacting System is being modelled
      • PRPS: material marker
      • PRL : Prandtl Number for variables with PRNDTL(phi)=GRND1
      • PSOX: x-direction momentum source resulting from the pressure gradient
      • PSOY: y-direction momentum source resulting from the pressure gradient
      • PSOZ: z-direction momentum source resulting from the pressure gradient
      • PTOT: total pressure (P1+0.5*DEN1*VABS^2) based on phase 1 velocity. Requires MACH to be STOREd
      • PTO2 : total pressure based on phase 2 velocity. Requires MAC2 to be STOREd
      • QDX : x-direction diffusive/conductive heat flux derived from gradients of TEM1 or H1
      • QDY : y-direction diffusive/conductive heat flux derived from gradients of TEM1 or H1
      • QDZ : z-direction diffusive/conductive heat flux derived from gradients of TEM1 or H1
      • QRX : x-direction radiation flux computed by immersol
      • QRY : y-direction radiation flux computed by immersol
      • QRZ : z-direction radiation flux computed by immersol
      • RADX: net X-direction radiative heat flux for 6-Flux model
      • RADY: net Y-direction radiative heat flux for 6-Flux model
      • RADZ: net Z-direction radiative heat flux for 6-Flux model
      • REYD: Reynolds Number based on interphase slip velocity used in interphase drag laws
      • REYN: Reynolds Number in Lam-Bremhorst Low- Reynolds Number turbulence model
      • REYT: Reynolds Number in Lam-Bremhorst Low- Reynolds Number turbulence model
      • RHO1: as for DEN1
      • RHO2: as for DEN2
      • SCAT: scattering coefficient of radiant energy per unit volume
      • SHRX: X-direction friction force from wall functions
      • SHRY: Y-direction friction force from wall functions
      • SHRZ: Z-direction friction force from wall functions
      • SIZE: particle/droplet diameter in twophase flow
      • SKIN: skin friction coefficient
      • SLPU: interphase slip velocity in X direction (U1-U2)
      • SLPV: interphase slip velocity in Y direction (V1-V2)
      • SLPW: interphase slip velocity in Z direction (W1-W2)
      • SPH1: as for CP1
      • SPH2: as for CP2
      • STAN: Stanton Number, i.e. dimensionless heat-transfer coefficient
      • STRS: Wall shear stress divided by the local density
      • T3 : radiation temperature, used in IMMERSOL radiation model
      • TEMP: phase-1 temperature, when enthalpy is computed directly
      • TEM1: phase-1 temperature, when computed directly
      • TEM2: phase-2 temperature, when computed directly
      • TMP1: phase-1 temperature, when enthalpy is computed directly
      • U1AD: the addition to U1 resulting from pressure correction
      • U1SL: U1 after solution but before pressure correction
      • U2AD: the addition to U2 resulting from pressure correction
      • U2SL: U2 after solution but before pressure correction
      • U2CM: x-direction phase 2 velocity component for BFC
      • U2CR: x-direction cartesian phase 2 velocity component for BFC
      • UCMP: x-direction velocity component for BFC
      • UCRT: x-direction cartesian velocity component for BFC
      • V1AD: the addition to Vl resulting from pressure correction
      • V1SL: V1 after solution but before pressure correction
      • V2AD: the addition to V2 resulting from pressure correction
      • V2CM: y-direction phase 2 velocity component for BFC
      • V2CR: y-direction cartesian phase 2velocity component for BFC
      • V2SL: V2 after solution but before pressure correction
      • VABS: Absolute velocity of phase 1
      • VAB2: Absolute velocity of phase 2
      • VCMP: y-direction velocity component for BFC
      • VCRT: y-direction cartesian velocity component for BFC
      • VFOL: volume fraction of liquid in free-surface problems, solved with SEM or HOL
      • VISL: as for ENUL
      • VIST: as for ENUT
      • VLSQ: sum of squares of phase 1 velocities, i.e. twice the kinetic energy
      • VOLU: cell volume
      • VOXY: vorticity in XY plane
      • VOYZ: vorticity in YZ
      • VREL: relative absolute velocity between the two phases when ONEPHS=F
      • W1AD: the addition to W1 resulting from pressure correction
      • W1SL: W1 after solution but before pressure correction
      • W2AD: the addition to absolute velocity resulting from pressure correction
      • W2CM: z-direction phase 2 velocity component for BFC
      • W2CR: z-direction cartesian phase 2velocity component for BFC
      • W2SL: W2 after solution but before pressure correction
      • WAVE:
      • WCMP: z-direction velocity component for BFC
      • WCRT: z-direction cartesian velocity component for BFC:
      • WDIS: distance from the wall, calculated by the LTLS method
      • WEB :
      • WGAP: distance between walls, calculated by the LTLS method
      • XCEN: x-direction cartesian coordinate of cell centre in a BFC grid
      • YCEN: y-direction cartesian coordinate of cell centre in a BFC grid
      • YPLS: 'y plus', the non-dimensional wall distance
      • ZCEN: z-direction cartesian coordinate of cell centre in a BFC grid

    1. hash-name variables

      For a reason explained under 'partial names' below, many reserved names have # as the first character.

      The following allow the 'status' of the cells in the domain to be recorded, for printing or graphical display, in 3D-variable manner.

      They correspond to the names of logical variables which users who engage in the addition of Fortran programming to PHOENICS can exploit.

      • #EBO, indicating that the East boundary is either a domain boundary or adjoins a VAC cell or a zero face porosity
      • #EF , indicating that the East face is a phase boundary
      • #EF0 which East face is blocked by zero face porosity;
      • #EWP, indicating that the East wall type patch is present
      • #HBO, indicating that the High boundary is either a domain boundary or adjoins a VAC cell or a zero face porosity
      • #HF , indicating that the High face is a phase boundary
      • #HF0, indicating that the High face is blocked by zero face porosity;
      • #HWP, indicating that the High wall type patch is present
      • #LBO, indicating that the Low boundary is either a domain boundary or adjoins a VAC cell or a zero face porosity
      • #LF , indicating that the Low face is a phase boundary
      • #LF0, indicating that the Low face is blocked by zero face porosity;
      • #LWP, indicating that the Low wall type patch is present
      • #MSFP, indicating that the that there is a mass-flow patch present in a cell;
      • #NBO, indicating that the Low boundary is either a domain boundary or adjoins a VAC cell or a zero face porosity
      • #NF, indicating that the North face is a phase boundary
      • #NF0, indicating that the North face is blocked by zero face porosity;
      • #NWP, indicating that the North wall type patch is present
      • #POR, indicating that the there is a non-participating solid with friction;
      • #SBO, indicating that the North boundary is either a domain boundary or adjoins a VAC cell or a zero face porosity
      • #SF, indicating that the South face is a phase boundary
      • #SF0, indicating that the South face is blocked by zero face porosity;
      • #SLD which SLD means the cell is occupied by a solid material;
      • #SWP, indicating that the South wall type patch is present
      • #WBO, indicating that the West boundary is either a domain boundary or adjoins a VAC cell or a zero face porosity
      • #WF0, indicating that the West boundary is either a domain boundary or adjoins a VAC cell or a zero face porosity
      • #WF, indicating that the West face is blocked by zero face porosity;
      • #WWP, indicating that the West wall type patch is present
      • #VAC, indicating that the cell is empty, or 'vacant', and therefore plays no part in the flow simulation.

  2. Partial names.

    Additionally, significance is attached to certain characters when they appear in particular positions in the names of variables, as follows:

    1. # as the first character of the name will prevent EARTH from automatically setting its value to zero within cells occupied by solids, as is done for all variables except: R1, R2, RS, H1, H2, TEM1, TEM2, T3,EPOR, NPOR, HPOR, BLOK, and PRPS.

    2. % as the fourth character allows the RESIDUALS of a solved-for variable to be stored and printed. However the In-Form 'RESI' feature does the same job more neatly.

    3. C as the fourth character allows the values of the 'corrections' of a solved-for variable to be stored and printed. However the In-Form 'CORR' feature does the same job more neatly.

4. FORTRAN VARIABLES USED FOR PROPERTIES

PHOENICS users who make use of the Ground-coding facility should also be aware of the integer variables used for accessing material properties, namely those contained in COMMON/IPROPS/ to be found in the file prpcmn in D_INCLUD.

They are:



      COMMON/IPROPS/DENST1,CMPRS1,DENST2,CMPRS2,VISTRB,VISCLM,PRNLAM,

     1              INTVL1,INTVL2,TEMPR1,TEMPR2,MIXLN1,MIXLN2,SPEHT1,

     1              SPEHT2,THRME1,THRME2,EMISSV,SCATTR,NAMSP3,INTFCO,

     1              INTMTR,INTRC1,INTRC2,IVRMCO,NAMSP4(5)

The meanings of all of these quantities are best understood by reading comments at the top of the Fortran file gxprutil.htm ,

as follows

It should be noted that each has a prescribed value, which should on no account be changed.