Back to main contents

Appendix 2. The list of In-Form statements

The following paragraphs contain the format and brief description of In-Form statements.

[ ] - designation of a dispensable element of a statement.

In most cases PatchName can stand for the name of a VR object as well as a PATCH

  • (SOUR[CE] of Var at PatchName is Formula [with Options])

    sets a source by Formula calculated for Var variable at region described by PATCH command with PatchName name. Var is 3D-stored solved variable. The "with Options" element contains options which specify the action of statement:

    FIXFLU (by default) - fixed source,
    FIXVAL - fixed value,
    ONLYMS - value convected in by associated mass source,
    LAMWALL - laminar wall condition,
    BLASIUS - turbulent wall condition using Blasius wall-function,
    LOGLAW - turbulent wall condition using logarithmic wall-function,
    LINE - linearised source,
    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition.

  • (INIT[IAL] of Var [at PatchName] is Formula [with Options])

    sets a initialization of Var variable at region described by PATCH command with PatchName name by Formula calculated. Var is any 3D-stored variable. The "with Options" element contains options which specify the action of statement:

    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition.

  • (STOR[ED] of Var [at PatchName] is Formula [with Options])

    sets a account of Var variable at region described by PATCH command with PatchName name by Formula calculated. Var is any 3D-stored variable. If Var is single user reals then other format should be used

    (STORE1 of Var [at PatchName] is Formula [with Options])
    The "with Options" element contains options which specify the action of statement:
    ZSLFIN (by default) - at end of IZ slab,
    ZSLSTR - at start of IZ slab,
    SWPSTR - at start of sweep,
    SWPFIN - at end of sweep,
    TSTSTR - at start of timestep,
    TSTFIN - at end of timestep,
    ITHSTR - at start of iteration,
    ITHFIN - at end of iteration,
    RESIDU - at moment of calculating residuals,
    CORREC - at moment of calculating corrections,
    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition.

  • (PROP[ERTY] of Var [at PatchName] is Formula [with Options])

    sets a property values of Var variable at region described by PATCH command with PatchName name by Formula calculated. Var is any variable name from list:

    RHO1 or DEN1 - first-phase density,
    DRH1DP - differential of the logarithm of the first-phase density,
    RHO2 or DEN2 - second-phase density,
    DRH2DP - differential of the logarithm of the first-phase density,
    ENUT or VIST - turbulent kinematic viscosity,
    ENUL or VISL - laminar kinematic viscosity,
    PRNDTL(var_name) - Prandtl Number,
    PHINT(var_name) - interface value for a first- or second-phase variable,
    TMP1 or TEMP - temperature of the first phase,
    TMP2 - temperature of the second phase,
    EL1 or LEN1 - mixing length-scale of the first-phase fluid,
    EL2 or LEN1 - mixing length-scale of the second-phase fluid,
    CP1 or SPH1 - specific heat of the first phase,
    CP2 or SPH2 - specific heat of the second phase,
    DVO1DT - first-phase volumetric thermal-expansion coefficient,
    DVO2DT - second-phase volumetric thermal-expansion coefficient,
    CFIPS or CFIP or INTF - interphase friction coefficient,
    CMDOT or MDOT or CMDO or INTM - interphase mass-transfer rate,
    CINT(var_name) - phase-to-interface transfer coefficient,
    CVM - virtual-mass coefficient.
    where var_name is 3D-stored solved variable. The "with Options" element contains options which specify the action of statement:
    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition.

  • (INFO[B] [at PatchName] is Formula with INFOB_n[!Options])

    sets formula-set object with "n" number by Formula calculated at region described by PATCH command with PatchName name. "n" is positive integer number. The Formula can contains ALL, BOX(), SPHERE(), POINT() and/or LINE() function. The "with Options" element contains options which specify the action of statement:

    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition,
    PORO - for volume and face porosities calculations.

  • (LONG[NAME] of Var [at PatchName] is Formula [with Options])

    sets a account of Var variable at region described by PATCH command with PatchName name by Formula calculated at moment before print-out. For a designation variable field is used a expression of the formula. Var is any 3D-stored variable. The "with Options" element contains options which specify the action of statement:

    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition.
    If it is necessary only to use a long name without accounts by the Formula the following statement is possible
    (LONGNAME of Var as Long_Name)
    where Long_Name is characters string without blanks.

  • (TGRI[D] of Var [at PatchName] is Formula [with Options])

    sets a account of Var variable at region described by PATCH command with PatchName name by Formula calculated. The account begin at moment before calling of second group of GROUND. Var is any 3D-stored variable or some EARTH reals. The "with Options" element contains options which specify the action of statement:

    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition.

  • (XGRI[D] of Var [at PatchName] is Formula with Options)

    sets a account of Var variable at region described by PATCH command with PatchName name by Formula calculated. The account begin at moment before calling of third group of GROUND. Var is any 3D-stored variable or some EARTH reals. The "with Options" element contains options which specify the action of statement:

    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition.

  • (YGRI[D] of Var [at PatchName] is Formula with Options)

    sets a account of Var variable at region described by PATCH command with PatchName name by Formula calculated. The account begin at moment before calling of fourth group of GROUND. Var is any 3D-stored variable or some EARTH reals. The "with Options" element contains options which specify the action of statement:

    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition.

  • (ZGRI[D] of Var [at PatchName] is Formula with Options)

    sets a account of Var variable at region described by PATCH command with PatchName name by Formula calculated. The account begin at moment before calling of fifth group of GROUND. Var is any 3D-stored variable or some EARTH reals. The "with Options" element contains options which specify the action of statement:

    INFOB_n - for moving InForm object,
    IMAT=iprp - in cell with material number iprp,
    IF(condition) - general logical condition.

  • (MAKE of Var is Formula)

    declare storage of user-defined VAR single real variable. Its initial values are calculated by Formula. The length of Var name should not be more than 8 symbols.

  • (MOVOB of VRObName is Formulas [with PARENT=VRPar_Name])

    sets a position of moving VR object with VRObName name by Formulas calculated. This statement is used for the MOFOR purposes. The PARENT=VRPar_Name option set the name of parent reference of object-related coordinate system.

  • (PRIN[T] String_15 [at PatchName] is Formula)

    dumps the fields of dependent variables or user-defined single real variables calculated by Formula in the file INFOROUT, which is placed in the working directory. The String_15 string is used as the title for the dumped variables. String_15 is a character string with a length of 15 symbols. PatchName is the name of a PATCH or VR object.

  • (REAL[READ] SetName is RealVarSet)

    transmits to EARTH the real variables set with SetName name by means SPEDAT lines. SetName is a character string by a length of 15 symbols. RealVarSet is the set of real numbers separated by blanks among themselves.

  • (INTR[EAD] SetName is IntegerVarSet)

    transmits to EARTH the integer variables set with SetName name by means SPEDAT lines. SetName is a character string by a length of 15 symbols. IntegerVarSet is the set of integer numbers separated by blanks among themselves.

  • (LOGR[EAD] SetName is LogicalVarSet)

    transmits to EARTH the logical variables set with SetName name by means SPEDAT lines. SetName is a character string by a length of 15 symbols. LogicalVarSet is the set of logical numbers (T or F) separated by blanks among themselves.

  • (MDFS[OL] of Var [at PatchName] is Formula)

    sets a recalculation of Var variable at region described by PATCH command with PatchName name and calculated by Formula. The account begin at moment after getting equation solution. Var is any 3D-stored variable or some EARTH reals.

  • (MODG[EOM] of Var [at PatchName] is Formula)

    sets a modification of the volume and areas at region described by PATCH command with PatchName name and calculated by Formula. Var variable can be VOLU name for cell volume or EARE, NARE, HARE names for east, north, high cell areas. The account begin at moment after account of all geometrical parameters at each time step.

  • (MODD[IF] of Var [at PatchName] is Formula [with Options])

    make active a modification of the diffusion terms in differential equation of Var dependent variable at region described by PATCH command with PatchName name and recalculated by Formula. The "with Options" flags specify names of cell faces where the modification is executed. Possible names are EAST, NORTH and HIGH.

  • (MODC[ON] of Var [at PatchName] is Formula [with Options])

    make active a modification of the convection terms in differential equation of Var dependent variable at region described by PATCH command with PatchName name and recalculated by Formula. The "with Options" flags specify names of cell faces where the modification is executed. Possible names are EAST, NORTH and HIGH.

  • (MODS[OR] of Var [at PatchName] is Formula)

    make active a modification of the built-in source terms in differential equation of Var dependent variable at region described by PATCH command with PatchName name and recalculated by Formula.

  • (TABLE at file_name is GET(var1,var2,...,varn) with HEAD(head1,head2,...,headn)!sweep)

    or

    (TABLE at file_name is GET(var1,var2,...,varn) with HEAD(head1,head2,...,headn)!time)

    creates a table in the file file_name. The first column of the table is ISWEEP (the outer iteration number) or the current time (TIM) for a transient calculation. The function GET retrieves the values specified by the formulae var1,var2,...,varn and writes them to the specified file.

    The function HEAD sets the headers for columns 2 and above.

    The file is written as a comma-separated-values (csv) file. It is directly compatible with the AUTOPLOT table format, and with Excel if the .csv extension is used as part of the file name.

    An example of use might be to monitor pressure (P1) at three locations with sweep:

    (TABLE of PMON1.CSV is GET(P1[1,2,3],P1[2,3,4],P1[3,4,5]) with HEAD(P1_1,P1_2,P1_3)!sweep)

    will produce a file pmon1.csv containing:

    
     ISWEEP, P1_1, P1_2, P1_3
    
         1,  1.190593E+01,  1.398720E+01,  1.339377E+01
    
         2,  1.216093E+01,  1.415707E+01,  1.316445E+01
    
         3,  1.228719E+01,  1.432991E+01,  1.310740E+01
    
         4,  1.232893E+01,  1.440223E+01,  1.317876E+01
    
         5,  1.235562E+01,  1.442454E+01,  1.327017E+01