This section describes how the settings made in the various object dialog boxes are captured in the Q1 file. The description concentrates on those features pertinent to PHOENICS-VR. Standard Q1 settings are not described in detail - the meanings of PIL statements can be ascertained from the relevant Encyclopaedia entries.
The units used for size and position are:
| Size | Cartesian |
Polar1 |
Polar2 | BFC |
| X direction | metres | radians (angledq) | metres (dX) | I cell / cell corner |
| Y direction | metres | metres (radius dr) | metres (dY) | J cell / cell corner |
| Z direction | metres | metres (dZ) | metres (dZ) | K cell / cell corner |
| Position | Cartesian |
Polar1 |
Polar2 | BFC |
| X direction | metres | radians (angle q) | radians (angle q) | I cell / cell corner |
| Y direction | metres | metres (radius) | metres (radius) | J cell / cell corner |
| Z direction | metres | metres (Z) | metres (Z) | K cell / cell corner |
1 Using default geometry DAT files, whose names all start 'POL'.
2 Using non-default geometry DAT files, whose names do not start 'POL'.
Common settings, Blockage, Inlet, Angled-in, Wind, Wind_profile, Outlet, Angled-out, Plate, Thin Plate, Fan, Point_history, Fine Grid Volume, User Defined, Cell Type, Null, PCB, Pressure Relief, BFC_Domain, Drag_lift, Assembly, Group, Transfer, Clipping_plane
The domain-related settings are:
> DOM, SIZE, Xsize, Ysize, Zsize
The domain size.> DOM, MONIT, Xpos, Ypos, Zpos
The location of the monitoring position (probe),> DOM, SCALE, Xscale, Yscale, Zscale
The display scaling factors in the X, Y and Z co-ordinate directions. These allow domains with extreme aspect ratios to be displayed as if they had a less extreme aspect ratio.> DOM, INCREMENT, increment_size
The increment size sets the distance the probe moves, or how much an object size or position changes each time a size or position button is pressed. It has units of metres.{> GRID, AUTO, T/F T/F T/F}
Auto-meshing flags for the X, Y and Z directions. T is ON, F is OFF. If the line is absent, F is assumed for all three directions for compatibility with Q1 files from older versions of PHOENICS. See The Default Grid - Auto Meshing and Changing the Auto-mesh Rules.{> GRID, MAXCELL, Xmax, Ymax, Zmax}
The maximum cell size in each direction as a fraction of the domain size. Only written if any one is not the default value of 0.05.{> GRID, MINCELL, Xmin, Ymin, Zmin}
The minimum cell size in each direction as a fraction of the domain size. Only written if any one is not the default value of 0.005.{> GRID, MAXRAT, Xrat, Yrat, Zrat}
The maximum size ratio between the first cell in any region and the last cell in the previous region, and the last cell in any region and the first cell in the next region. Only written if any one is not the default value of 1.5.{> GRID, POWER, Xpow, Ypow, Zpow}
The expansion power used to adjust the grid within a region. Only written if any one is not the default value of 1.2.{> GRID, EXPANS, T/F T/F T/F}
This sets the form of the expansion to Geometrical (T) or Power-Law (F). Only written if any one is not the default value of T.{> GRID, BOUNDS, T/F T/F T/F T/F T/F T/F}
Sets whether the first and last regions in X Y and Z use symmetrical expansions (T), or expand outwards towards the domain edge (F). Only written if any one is not the default value of F.{> GRID, RSET_dir_reg, ncells, power, [G]}
The optional GRID,RSET line is written for each region that has had its grid set, where:
- dir is X, Y or Z;
- reg is the number of the region;
- NCELLS is the number of cells for that regions. A negative number of cells indicates that the expansion is to be applied symmetrically from either end of the region;
- power is the expansion power. A negative power indicates that the expansion starts at the far end of the region and works backwards to the start; and
- G is present if a geometrical progression is being used.
If auto-meshing is on for any direction, the auto-generated RSET commands are written to the Q1 as comments as a record of what the auto-mesher did, and to allow users to manually disable the auto-mesh whilst retaining the grid settings.
If the calculation of forces and moments on blockages is turned on ( Main Menu - Output - Output of Forces and Moments), the following optional settings may appear in the domain settings section of the Q1:
{> DOM, CDCALC, YES}
switches the calculation of drag coefficient on. If the line is absent or is NO, the drag coefficients are not calculated.{> DOM, REFDEN, reference_density}
Sets the reference density to be used in the calculation of drag coefficient. If the line is absent, a value of 1.189 is assumed.{> DOM, REFAREA, area_x, area_y, area_z}
Sets the reference, or normalisation, areas in the three coordinate directions. If the line is absent values of 1.0 are assumed.{> DOM, MOMCEN, Xu, Yu, Zu}
Sets the coordinates of a point about which moments of the total force are taken.{> DOM, SWPSTPnn, first_step, last_step, number_of_sweeps}
Sets the number of sweeps per time step in the time step band first_step <= ISTEP <= last_step. nn is the band number. Up to 15 bands are allowed. They do not need to cover all steps - the steps not covered will use the number of sweeps set in the normal way via LSWEEP.{> DOM, SWPTIMnn, start_time, end_time, number_of_sweeps}
Sets the number of sweeps per time step in the time band time < current_time <= end_time. nn is the band number. Up to 15 bands are allowed. They do not need to cover all steps - the steps not covered will use the number of sweeps set in the normal way via LSWEEP.Note that SWPSTP and SWPTIM settings are mutually exclusive - only one method of changing the number of sweeps per step can be used in a case.
{>DOM, P_AMBIENT, Pamb}
Sets the ambient or external pressure for the domain in Pascals. If the line is absent, Pamb is taken to be 0 Pa. This pressure is always relative to the Reference Pressure (PRESS0) set on the Main Menu, properties panel.The ambient pressure is used as the default external pressure at inlets, outlets, openings, and as the default initial pressure for fluid blockage objects.
{>DOM, T_AMBIENT, Tamb}
Sets the ambient or external temperature for the domain. If the Reference Temperature(TEMP0) set on the Main Menu, Properties panel, is set to 273, this temperature is in Centigrade. If the Reference Temeperature is 0.0, this temperature is in Kelvin. The absolute ambient temperature in Kelvin is always Tamb+TEMP0.The ambient temperature is used as the default external temperature at inlets, outlets, openings, and as the default initial temperature for fluid blockage objects and thinplt objects.
{>DOM, INI_AMB, YES}
When set to YES, the initial values of pressure (FIINIT(P1)) and temperature (FIINIT(TEM1), [and FIINIT(TEM2), FIINIT(T3) if present]) are all set to the current ambient value, and are updated whenever the ambient values are changed. The values set in Group 11 of Q1 are ignored, unless they signal a restart.When set to NO, or if the line is absent, the settings made in Group 11 of Q1 will be used. New cases will have the setting YES.
{>DOM, INI_BUOY, YES}
When set to YES, the reference temperature for the Boussinesq buoyancy option is taken to be Tamb regardless of the Group 13 settings. For the Density-difference buoyancy option, the reference density is recalculated from Pamb and Tamb using the current density formula. The reference buoyancy settings in Group 11 of Q1 will not be used.When set to NO, or if the line is absent, the settings made in Group 11 of Q1 will be used. New cases will have the setting YES.
Settings made for domain size and monitor location in this section will override those made in the normal PIL sections of the Q1 file.
The following object-related settings are common to all object types. The settings inside the {} brackets may or may not be present.
> OBJ, NAME, object_name
The object name. See Object creation.> OBJ, POSITION, Xpos, Ypos, Zpos
The co-ordinates of the West-South-Low corner of the object bounding box in the order X,Y,Z. See Object Position. The keyword 'AT_END' can be used to denote that the object is located at the domain end.> OBJ, SIZE, Xsize, Ysize, Zsize
The size of the object bounding box in the order X, Y, Z. See Object Size. The keyword 'TO_END' can be used to denote that the object should extend from its origin (position) to the end of the domain.> OBJ, GEOMETRY, geometry_file_name
The name of the geometry file used for the object geometry. In BFC, this is the same as the object name. This was called CLIPART in earlier versions. [This keyword will still be understood.] See Object Shape.{> OBJ, TEXTURE, file_name}
If a texture has been applied to an object, the name of the texture file will be written. If the texture file is not in the \phoenics\d_prelude\textures folder, the complete path will be written. See Applying Textures.> OBJ, ROTATION24, rotation_code
The rotation code used to orient the geometry within the bounding box, if not BFC. See Object Orientation.{> OBJ, BLOCK, block number}
In multi-block BFC cases, the block to which the object belongs.{> OBJ, ROT-ANGLE, alpha, beta, theta}
The alpha, beta and theta rotation angles (if not zero and not BFC). This was called ARBORIEN in earlier versions. [This keyword will still be understood.] See Object Rotation.{> OBJ, ROT-MODE, OLD}
The object rotation mode is set to 'Old method'. If the line is not present or the value is DEFAULT or 0, the default rotation mode will be used. See Object Rotation Mode. Other values are not allowed.{>OBJ, ROT-CENTRE, centre}
The object rotation centre is set to centre, where centre is one of:
- WSL - Object rotates about its West-south-low corner (the default)
- ESL - East-south-low
- WNL - West-north-low
- WSH - West-south-low
- ENL - East-north-low
- ESH - East-south-high
- WNH - West-north-high
- ENH - East-north-high
- CENTRE - the geometrical centre of the bounding box
- USER - a user-set location, set by > OBJ, ROT-XYZ, Xloc, Yloc, Zloc
{> OBJ, VISIBLE, NO}
The object is hidden. If the line is not present or the value is YES the object is visible. For backward compatibility -1 can mean NO.{>OBJ, GRID, NO}
The object does not create grid regions in any of the three directions. If the line is not present or the value is YES the object creates regions in all three directions. See Object Affects Grid. For backward compatibility 1 can mean YES and 2 can mean NO.If the object is set to only affect the grid in some but not all directions, the line is written as:
>OBJ, GRID, p,p,p
where each p must be Y (affect grid) or N (don't affect grid) for the X, Y and Z directions.
Y,Y,Y is equivalent to YES and will not be written when the Q1 is saved, as this is the default.
N,N,N is equivalent to NO and will be written as NO when the Q1 is saved.{>OBJ, DOMCLP, NO}
The object is not constrained by the domain. If the line is not present or the value is YES, then the object is constrained. See Object constrained by domain.{>OBJ, COLOR-MODE, mode}
The colour mode. The modes are:
- DEFAULT or 0 (or line absent) - default
- DEFAULT2 or 1 - use first facet colour for all facets
- USER or 2 - user-defined colour
See Object Colour.
{>OBJ, COLOR-VAL, colour number}
The colour number for user-defined colour. Valid entries are in the range 0-256. The corresponding colours are shown in Appendix A. See Object Colour.{>OBJ, WIREFRAME, YES}
The object is to be drawn in wireframe. If the line is not present, or the value is NO, the object will be drawn as normal.{>OBJ, OPAQUE, opaqueness value}
The opaqueness value for the object. Any integer value between 0 (completely transparent) and 100 (completely opaque) can be used. 100 is assumed if the line is absent.> OBJ, TYPE, object_type
The object type. See Object Types and Attributes
The remaining object-related settings depend on the object type, and the selections made.
Settings made for object size and location in this section will override those made in the normal PIL sections of the Q1 file.
In the following sections, settings shown in [ ] denote Phase 2 values which only appear if IPSA is active.
Note that in Versions prior to 3.5, the >OBJ command had the form >OBJn, where n was the sequence number of the object. The numbers had to be consecutive.
From Version 3.5, the 'n' is optional, and can be any character string. The only restriction is that any identifying string must be the same for all >OBJn lines for a particular object. To make Satellite write a Q1 with numbered objects (e.g. for use in an earlier version of PHOENICS), add the line:
Object_numbers = on
to the [Q1] section of CHAM.INI.
For downward compatibility, Q1 files with numbered objects (>OBJn) will be read correctly.
In transient cases, most of the object types will have a setting which defines when they are active:
> OBJ, TIME_LIMITS, ALWAYS_ACTIVE
or
> OBJ, TIME_LIMITS, Tstart, Tend
Object type:
> OBJ, TYPE, BLOCKAGE
Object material:
> OBJ, MATERIAL, imat [,material_name]
A positive value of imat is the actual property number for that object. The property values corresponding to imat can be found in the PROPS file.
A negative value for imat signifies that this object is to use the current domain fluid, as set in the Properties panel of the Main Menu.
The material name is optional.
Participating object (solid or fluid) with heat source (imat <
198):
> OBJ, heat_source, val1, val2
The possible settings for heat-source and the corresponding meanings of val1 and val2 are given in Table 1 below:
| Heat_source | Result | val1 | val2 |
| HEAT_FLUX | Fixed Heat Flux (for object) | 0.0 | Q (W) |
| HEAT_FLVX | Fixed Heat Flux (per unit volume) | 0.0 | Q (W/m3) |
| ADIABATIC | No heat Source | 0.0 | 0.0 |
| SURF_TEMP | Fixed surface Temperature | 0.0 | Tsurf (K or C) |
| LINR_HEVT | Linear heat source Q = Vol * C (V - Tp) |
C (W/m3/K) | V (K or C) |
| SURF_ENTH | Fixed surface Enthalpy | 0.0 | Hsurf (J/kg) |
| QUAD_HEAT | Quadratic Heat Source Q = Vol * C (V - Tp)2 |
C (W/m3/K2) | V (K or C) |
| USER_HEAT | User-set Heat source Q = Vol * C (V - Tp) |
C (constant or GRND) | V (constant or GRND) |
| LIN_T_HEA | Heat flux linear with time | Start value (W) | Slope (W/s) |
| LIN_T_HVA | Heat flux linear with time | Start value (W/m3) | Slope (W/m3/s) |
| LIN_T_VAL | Temperature linear with time | Start value (K or C) | Slope (deg/s) |
| SIN_T_HEA (*) | Heat source sin(t) | amplitude (W) | period (s) |
| SIN_T_VAL (*) | Temperature sin(t) | amplitude (K or C) | period (s) |
| COS_T_HEA (*) | Heat source cos(t) | amplitude (W) | period (s) |
| COS_T_VAL (*) | Temperature cos(t) | amplitude (K or C) | period (s) |
| STP_T_HEA (*) | Heat source step of t | amplitude (W) | period (s) |
| STP_T_VAL (*) | Temperature step of t | amplitude (K or C) | period (s) |
| SAW_U_HEA (*) | Heat source saw-up in t | amplitude (W) | period (s) |
| SAW_U_VAL (*) | Temperature saw-up in t | amplitude (K or C) | period (s) |
| SAW_D_HEA (*) | Heat source saw-down in t | amplitude (W) | period (s) |
| SAW_D_VAL (*) | Temperature saw-down in t | amplitude (K or C) | period (s) |
| MEAN_VAL | Mean value for (*) above | W or (K or C) | |
| T-OFFSET | preiod offset for (*) above | fraction of cycle |
In a two-phase case, the ninth character of the heat_source string is changed to 1 or 2, to denote which phase the source belongs to.
Participating fluid with momentum source (imat < 100):
> OBJ, mom_source_dir, val1, val2
where _dir is one of X, Y or Z, and possible settings for mom_source and the corresponding meanings of val1 and val2 are given in Table 2 below.
| Mom_source | Result | Val1 | Val2 |
| FIX_VAL | Fixed Velocity | 0.0 | Velocity (m/s) |
| FIX_FLX | Fixed momentum source (Force) | 0.0 | Force (N) |
| LIN_SOU | Linear momentum source F = mass-in-cell * C (V - Velp) |
C (s-1) | V (m/s) |
| QAD_SOU | Quadratic momentum source F = mass-in-cell * C (V - Velp)2 |
C (m-1) | V (m/s) |
| USR_DEF | User-set Momentum source F = mass-in-cell * C (V - Velp) |
C (constant or GRND) | V (constant or GRND) |
In a two-phase case, a 1 or 2 will be appended after the direction indicator _dir, to denote which phase the source applies to.
Participating fluid with scalar source (imat < 198):
> OBJ, scal_source_scal, val1, val2
where scal is one of the SOLVEd scalars, and possible settings for scal_source and the corresponding meanings of val1 and val2 are given in Table 3 below. One such line for each scalar with a source. _scal is the name of the variable the source applies to.
| Scal_source | Result | Val1 | Val2 |
| FIX_VAL | Fixed Value | 0.0 | Value |
| FIX_FLX | Fixed source | 0.0 | Source S (total or m-3) |
| LIN_SOU | Linear source S = Vol * C (V - Cp) |
C (m-3) | V |
| QAD_SOU | Quadratic source S = Vol * C (V - Cp)2 |
C (m-3) | V |
| USR_DEF | S = Vol * C (V - Cp) | C (constant or GRND) | V (constant or GRND) |
The setting:
> OBJ, SCAL_FIXF, 1.000000E+00
or
> OBJ, SCAL_FIXF, 2.000000E+00
determines whether the fixed scalar source in Table 3 is a total value for the object (1.0), or is per unit volume (2.0).
Initial pressure (if set):
> OBJ, INI_PRESS, Pinit
Pinit may be the character string P_AMBIENT to indicate the value set for P_AMBIENT in the domain section. This is the default.
Initial temperature (if set):
> OBJ, INI_TEMP, Tinit
Tinit may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
[> OBJ, INI_TEMP-2, Tinit_2]
Initial scalar (if set):
> OBJ, INI_scal, Cinit
where scal is one of the SOLVEd scalars. One such line for each scalar with an initial value.
Initial porosity (if set):
> OBJ, INI_por, poros
where por is one of EPOR, NPOR, HPOR or VPOR. One such line for each scalar with an initial value.
[Initial Volume fraction:
> OBJ1, INI_R2, R2init
The initial value of R1 is not written, as internal consistency checks ensure that R1+R2=1.0]
Object emissivity:
> OBJ, EMISSIVITY, 1.000000E-01
Non-participating solid with heat sources on faces (imat=198):
> OBJ, heat_source_W, val1_W, val2_W
> OBJ, heat_source_E, val1_E, val2_E
> OBJ, heat_source_S, val1_S, val2_S
> OBJ, heat_source_N, val1_N, val2_N
> OBJ, heat_source_L, val1_L, val2_L
> OBJ, heat_source_H, val1_H, val2_H
where heat_source is as in Table 1 above, and _W, _E etc denote the West, East etc faces of the object. Note that these settings will only appear if the object geometry is default.dat or one of the cuboid geometries.
Solid Object (imat not 199)
Wall roughness. If line not present, global value used:
> OBJ, ROUGH, val
Heat transfer coefficient. If line not present, derived from
wall-function.
> OBJ, HTCO, heat_transfer_coefficient
Slide Velocity. If these lines are not present, the object is assumed
to be stationary:
> OBJ, VEL_TYPE, velocity_type
where, for Cartesian cases, velocity_type is one of:
The location of the axis is set by the object rotation centre. If this line is absent, but the velocity line is present, the object is not rotating but sliding.
or for Polar cases one of:
In all cases the value of the velocity is set by
> OBJ, VELOCITY, velx, vely,velz
where velx, vely and velz are the X-, Y- and Z-direction components.
Wall function. If line not present, global value used:
> OBJ, WALLCO, Law
Where Law is one of:
- Default
- Blasius
- Logarithmic
- Generalised Logarithmic
- Fully-rough
Object type:
> OBJ, TYPE, INLET
Inlet with 'domain fluid':
> OBJ, PRESSURE, Pval
[> OBJ, PRESSURE-2, Pval]
Pval may be the character string P_AMBIENT to indicate the value set for P_AMBIENT in the domain section. This is the default.
Inlet with 'user-set' density:
> OBJ, DENSITY, RHOin
[> OBJ, DENSITY, RHOin * R1in]
[> OBJ, DENSITY-2, RHOin_2 * R2in]
Inlet with 'Heavy' fluid (SEM or HOL)
> OBJ, FLUID, 1.0
Inlet velocities:
> OBJ, VELOCITY, Vel_X, Vel_Y, Vel_Z
[> OBJ, VELOCITY-2, Vel_X_2, Vel_Y_2, Vel_Z_2]
OR Inlet Volume Flux:
> OBJ, VOLUFLOW, VOLin
[> OBJ, VOLUFLOW-2, VOLin_2]
OR Inlet Mass Flux:
> OBJ, MASSFLOW, MASSin
[> OBJ, MASSFLOW-2, MASSin_2]
Inlet temperature:
> OBJ, TEMPERATURE, Tin
[> OBJ, TEMPERATURE-2, Tin_2]
Tin and Tin_2 may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
Inlet Scalar:
> OBJ, INLET_scal, Cin
where scal is one of the SOLVEd scalars. One such line for each scalar with an inlet value.
Inlet Turbulence - User-set:
> OBJ, KE_IN, KEin
> OBJ, EP_IN, EPin
OR Inlet Turbulence - Intensity (%):
> OBJ, TURB-INTENS, Tintens
Emissivity:
> OBJ, EMISSIVITY, Emiss
Area Ratio:
> OBJ, AREA_RATIO, area_ratio
If the line is absent, a value of 1.0 is assumed
Object side:
> OBJ, OBJECT-SIDE, HIGH
If the line is absent, LOW is assumed. HIGH can be 1, LOW can be 0.
Acts as export:
> OBJ, EXPORT, file_name
Acts as Import:
> OBJ, IMPORT, file_name
Object type:
> OBJ, TYPE, ANGLED-IN
Inlet with 'domain fluid':
> OBJ, PRESSURE, Pval
[> OBJ, PRESSURE-2, Pval]
Pval may be the character string P_AMBIENT to indicate the value set for P_AMBIENT in the domain section.
Inlet with 'user-set' density:
> OBJ, DENSITY, RHOin
[> OBJ, DENSITY, RHOin * R1in]
[> OBJ, DENSITY-2, RHOin_2 * R2in]
Inlet with 'Heavy' fluid (SEM or HOL)
> OBJ, FLUID, 1.0
Inlet velocities:
> OBJ, VELOCITY, Vel_X, Vel_Y, Vel_Z
[> OBJ, VELOCITY-2, Vel_X_2, Vel_Y_2, Vel_Z_2]
OR Inlet Volume Flux:
> OBJ, VOLUFLOW, VOLin
[> OBJ, VOLUFLOW-2, VOLin_2]
OR Inlet Mass Flux:
> OBJ, MASSFLOW, MASSin
[> OBJ, MASSFLOW-2, MASSin_2]
OR Normal Velocity:
> OBJ, NORMAL_VEL, VELin
[> OBJ, NORMAL_VEL-2, VELin_2]
Inlet temperature:
> OBJ, TEMPERATURE, Tin
[> OBJ, TEMPERATURE-2, Tin_2]
Tin and Tin_2 may be the character string P_AMBIENT to indicate the value set for P_AMBIENT in the domain section. This is the default.
Inlet Scalar:
> OBJ, INLET_scal, Cin
where scal is one of the SOLVEd scalars. One such line for each scalar with an inlet value.
Inlet Turbulence - User-set:
> OBJ, KE_IN, KEin
> OBJ, EP_IN, EPin
OR Inlet Turbulence - Intensity (%):
> OBJ, TURB-INTENS, Tintens
Emissivity:
> OBJ, EMISSIVITY, Emiss
Area Ratio:
> OBJ, AREA_RATIO, area_ratio
If the line is absent, a value of 1.0 is assumed
Linked Angled-in:
> OBJ, LINK, status
Status can be PREVIOUS or NEXT, indicating the immediately-preceeding or immediately-following Angled-in object (which need not be the adjacent object). If the line is absent, no linkage is assumed.
Linked Angled-in Heat source:
> OBJ, ADDQ, Q
where Q is the additional heat in W added to the fluid passed between the two linked Angled-ins. If the LINK flag is not set, this setting is ignored.
Object type:
> OBJ, TYPE, WIND
Wind External pressure:
> OBJ, PRESSURE, Pval
Pval may be the character string P_AMBIENT to indicate the value set for P_AMBIENT in the domain section. This is the default.
Wind with 'density is':
> OBJ, DENSITY, RHOin
If line is missing, domain fluid assumed.
Pressure coefficient - linear
>OBJ, COEFFICIENT, Coef
Pressure coefficient - quadratic
>OBJ, COEFFICIENT, Coef, QUADRATIC
Wind speed at reference height:
> OBJ, VELOCITY, Velocity
Wind direction relative to North
>OBJ, WIND_DIR, angle
Angle between north-facing axis and North
>OBJ, AXIS_DIR, angle
External temperature:
> OBJ, TEMPERATURE, Tin
Tinl may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
Inlet profile type - Logarithmic:
> OBJ, PROFILE, Logarithmic
Inlet profile type - Power law and exponent:
> OBJ, PROFILE, Power-law
> OBJ, POWER_EXPONT, alpha
Reference height for wind speed:
> OBJ, REF_HEIGHT, Zr
Roughness height:
> OBJ, RGHNS_HEIGHT, Z0
Vertical direction:
> OBJ, UP-DIR, X [Y or Z]
External temperature for radiative link:
> OBJ, T_EXT,
Text may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
Object type:
> OBJ, TYPE, WIND_PROFILE
Wind_profile with 'domain fluid':
> OBJ, PRESSURE, Pval
Pval may be the character string P_AMBIENT to indicate the value set for P_AMBIENT in the domain section. This is the default.
Wind_profile with 'density is':
> OBJ, DENSITY, RHOin
Wind speed velocity components at reference height:
> OBJ, VELOCITY, X-component, Y-component, Z-component
Inlet temperature:
> OBJ, TEMPERATURE, Tin
Tin may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
Inlet profile type - Logarithmic:
> OBJ, PROFILE, Logarithmic
Inlet profile type - Power law and exponent:
> OBJ, PROFILE, Power-law
> OBJ, POWER_EXPONT, alpha
Reference height for wind speed:
> OBJ, REF_HEIGHT, Zr
Roughness height:
> OBJ, RGHNS_HEIGHT, Z0
Vertical direction:
> OBJ, UP-DIR, X [Y or Z]
External temperature for radiative link:
> OBJ, T_EXT, Text
Text may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
Object side:
> OBJ, OBJECT-SIDE, HIGH
If the line is absent, LOW is assumed. HIGH can be 1, LOW can be 0.
Object type:
> OBJ, TYPE, OUTLET
External pressure:
> OBJ, PRESSURE, Pext
Pext may be the character string P_AMBIENT to indicate the value set for P_AMBIENT in the domain section. This is the default.
Coefficient in fixed-pressure patch (linear coefficient)
> OBJ, COEFFICIENT, Coef (default 1.0E+3)
[> OBJ, COEFFICIENT-2, Coef-2] (default 1.0E+6)
Coefficient in fixed-pressure patch (quadratic coefficient)
> OBJ, COEFFICIENT, Coef, QUADRATIC
[> OBJ, COEFFICIENT-2, Coef-2, QUADRATIC]
External Temperature:
> OBJ, TEMPERATURE, Text
[> OBJ, TEMPERATURE-2, Text_2
Text and Text_2 may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
External turbulence:
> OBJ, TURBULENCE, KEext, EPext
External velocity:
> OBJ, VELOCITY, Vel_X, Vel_Y, Vel_Z
[> OBJ, VELOCITY-2, Vel_X_2, Vel_Y_2, Vel_Z_2]
If the external velocity in any direction is IN-CELL, it is echoed here as SAME. If it is DEDUCED, it is echoed as DEDUCED. In earlier versions it was echoed as GRND1. This setting is still accepted. For DEDUCED, two extra lines may appear:
>OBJ, VELIN, vin
[>OBJ, VELIN2, vin2]
where vin is the intial guess for the external velocity normal to the outlet. If the line
is absent, a value of zero is assumed.
>OBJ, RELAX, relax
[>OBJ, RELAX2, relax2]
where relax is a liner relaxation factor used to slow down the rate of change of the
deduced external velocity. If the line is absent, a value of 0.3 is assumed.
If VOUT (and VOU2 for two-phase case) is STOREd, the deduced velocity is made available for plotting in the Viewer.
External Scalar:
> OBJ, OUTLET_scal, 4.000000E+00
where scal is one of the SOLVEd scalars. One such line for each scalar with an external value.
Note that 'In-Cell' is echoed as SAME.
Emissivity:
> OBJ, EMISSIVITY, Emiss
External temperature for radiative link:
> OBJ, T_EXT, Text
Text may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
Area Ratio:
> OBJ, AREA_RATIO, area_ratio
If the line is absent, a value of 1.0 is assumed
Object side:
> OBJ, OBJECT-SIDE, HIGH
If the line is absent, LOW is assumed. HIGH can be 1, LOW can be 0
Acts as export:
> OBJ, EXPORT, file_name
Acts as Import:
> OBJ, IMPORT, file_name
Object type:
> OBJ, TYPE, ANGLED-OUT
External pressure:
> OBJ, PRESSURE, Pext
Pext may be the character string P_AMBIENT to indicate the value set for P_AMBIENT in the domain section. This is the default.
Coefficient in fixed-pressure patch (linear coefficient)
> OBJ, COEFFICIENT, Coef (default 1.0E+3)
[> OBJ, COEFFICIENT-2, Coef-2] (default 1.0E+6)
Coefficient in fixed-pressure patch (quadratic coefficient)
> OBJ, COEFFICIENT, Coef, QUADRATIC
[> OBJ, COEFFICIENT-2, Coef-2, QUADRATIC]
External Temperature:
> OBJ, TEMPERATURE, Text
[> OBJ, TEMPERATURE-2, Text_2
Text and Text_2 may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
External turbulence:
> OBJ, TURBULENCE, KEext, EPext
Set External velocity:
> OBJ, VELOCITY, Vel_X, Vel_Y, Vel_Z
[> OBJ, VELOCITY-2, Vel_X_2, Vel_Y_2, Vel_Z_2]
OR Deduced External velocity:
> OBJ, VELOCITY, DEDUCED
[> OBJ, VELOCITY-2, DEDUCED
>OBJ, VELIN, vin
[>OBJ, VELIN2, vin2]
>OBJ, RELAX, relax
[>OBJ, RELAX2, relax2]
where vin is the intial guess for the external velocity normal to the outlet. If the line
is absent, a value of zero is assumed. Relax is a liner relaxation factor used to slow
down the rate of change of the deduced external velocity. If the line is absent, a value
of 0.3 is assumed.
If VOUT (and VOU2 for two-phase case) is STOREd, the deduced velocity is made available for plotting in the Viewer.
OR In-cell External velocity:
> OBJ, VELOCITY, IN-CELL
[> OBJ, VELOCITY-2, IN-CELL
OR Normal External velocity:
> OBJ, VELOCITY, NORMAL
[> OBJ, VELOCITY-2, NORMAL
External Scalar:
> OBJ, OUTLET_scal, 4.000000E+00
where scal is one of the SOLVEd scalars. One such line for each scalar with an external value.
Note that 'In-Cell' is echoed as SAME.
Emissivity:
> OBJ, EMISSIVITY, Emiss
External temperature for radiative link:
> OBJ, T_EXT, Text
Text may be the character string T_AMBIENT to indicate the value set for T_AMBIENT in the domain section. This is the default.
Area Ratio:
> OBJ, AREA_RATIO, area_ratio
If the line is absent, a value of 1.0 is assumed
Object type:
> OBJ, TYPE, PLATE
Wall roughness for external plate. If line not present, global value
used:
> OBJ, ROUGH, val
Wall function for external plate. If line not present, global value
used:
> OBJ, WALLCO, Law
Where Law is one of:
- Default
- Blasius
- Logarithmic
- Generalised Logarithmic
- Fully-rough
- Frictionless
External Plate with heat Source
> OBJ, heat_source,
where heat_source is as in Table 1 above, except that the fixed flux can be total for the object or per unit area.
Internal fully-blocked plate
> OBJ, TYPE, PLATE
> OBJ, POROSITY, 0.000000E+00
Internal Plate with heat Source
> OBJ, SIDE,
where heat_source is as in Table 1 above, except that the fixed flux can be total for the object side or per unit area.
Wall roughness for internal plate. If line not present, global value
used:
> OBJ, ROUGH_L, val1
> OBJ, ROUGH_H, val2
where val1, val2 are the roughnesses of the low and high sides of the plate.
Wall function for internal plate. If line not present, global value
used:
> OBJ, WALLCO_L, Law1
> OBJ, WALLCO_H, Law2
where Law1 and Law2, the wall-function laws for the low and high sides of the plate, are as for the external plate.
Internal partially blocked plate
> OBJ, POROSITY, poros
A value of 0.0 (fully-blocked) is assumed if the line is absent.
Presure Drop:
> OBJ, PDROP_LAW, Law
Where Law is one of:
The coefficient and power required for some of the expressions are written as:
> OBJ, PDROP_COE, coefficient (assumed value of 1.0 if line absent)
> OBJ, PDROP_POW, power (assumed value of 2.0 if line absent)
Emissivity
> OBJ, EMISSIVITY, Emiss
External Plate with Radiating Solid Source
Q" = a + b*(Text-Tp)c + d*(Text4-Tp4)
> OBJ, SURF_HEAT, 0.000000E+00, a
> OBJ, PARA_HEAT, b, c, d
> OBJ, T_EXT, Text
Object type:
> OBJ, TYPE, THINPLT
Plate material:
> OBJ, MATERIAL, imat
Plate thickness:
> OBJ, THICKNESS, thick
Plate emissivity:
> OBJ, EMISSIVITY, emiss
Plate porosity:
> OBJ, POROSITY, poros ( if set)
Presure Drop:
> OBJ, PDROP_LAW, Law
Where Law is one of:
The coefficient and power required for some of the expressions are written as:
> OBJ, PDROP_COE, coefficient (assumed value of 1.0 if line absent)
> OBJ, PDROP_POW, power (assumed value of 2.0 if line absent)
Object type:
> OBJ, TYPE, FAN
The remaining settings for a fan are the same as those for an INLET. They are, however, interpreted differently in the case of an internal fan.
A circular fan has the additional lines:
> OBJ, DIAMRATI, Di/Do
> OBJ, SWIRLNUM, S
> OBJ, SWIRLDIR, Sdir
> OBJ, FANAXISD, AXdir
where:
Only the X direction velocity is used.
Object type:
> OBJ, TYPE, POINT_HISTORY
> OBJ, VARLIST1, var1, var2, var3, var4, var5, var6, var7
...
> OBJ, VARLISTn, vari, vari+1, vari+2, vari+3, vari+4
var1 - vari are the names of the selected variables. There are as many VARLISTn lines as are required to list all the selected variables, up to 7 per line.
Note: The point_history object never affects the grid. The size of the object is adjusted to cover the cell nearest the origin of the object.
Object type:
> OBJ, TYPE, FINE_GRID_VOL
The settings for a fine grid volume are:
> OBJ, FINEFACTS, Xfac, Yfac, Zfac
where Xfac, Yfac and Zfac are the (integer) refinement ratios in the three co-ordinate directions.
Object type:
> OBJ, TYPE, USER_DEFINED
> OBJ, PATCHES, patch1, patch2, patch3, patch4, patch5
> OBJ, PATCHES, patch6, ... patchn
The PATCHES attribute contains a list of the patch names associated with this object. As many PATCHES lines as needed to hold all the patch names can be used.
All settings relating to the PATCH and COVAL statements linked to a user-defined object are printed in the relevant Group - these can be Groups 11, 12, 13, or 23. The name of the controlling object is written as a guiding comment.
The first location argument of PATCH (usually IXF) is set to -1, to indicate that the patch is to be linked to an object. The remaining five location arguments are zero. As many PATCH commands can be attached to one user-defined object as required.
In earlier (pre-2009) versions the IXF location argument was used to hold the object number. This method is still recognised on reading a Q1, but when the new Q1 is written the object number will be replaced by -1, and the patch name will be echoed in the PATCHES list.
Satellite modifies the grid so that it fits the edges of the object bounding box. Earth applies whatever settings are implied by the PATCH to those cells that lie inside the volume or area defined by the facets of the object.
For area or volume sources, Earth will scale the source by the ratio between the area (or volume) of the facets, and the area (or volume) of the affected cells, to ensure that the correct total source is set.
Object type:
> OBJ, TYPE, CELLTYPE
> OBJ, PATCHES, patch1, patch2, patch3, patch4, patch5
> OBJ, PATCHES, patch6, ... patchn
The CELLTYPE object is entirely equivalent to a USER_DEFINED object which has the >OBJ, GRID attribute set to NO. It is recommended that this be used instead.
The PATCHES attribute contains a list of the patch names associated with this object. As many PATCHES lines as needed to hold all the patch names can be used.
All settings relating to the PATCH and COVAL statements linked to a cell-type object are printed in the relevant Group - these can be Groups 11, 12, 13, or 23. The name of the controlling object is written as a guiding comment.
The first location argument of PATCH (usually IXF) is set to -1, to indicate that the patch is to be linked to an object. The remaining five location arguments are zero. As many PATCH commands can be attached to one user-defined object as required.
In earlier (pre-2009) versions the IXF location argument was used to hold the object number. This method is still recognised on reading a Q1, but when the new Q1 is written the object number will be replaced by -1, and the patch name will be echoed in the PATCHES list.
Satellite does not modify the grid to fit the edges of the object bounding box. Earth applies whatever settings are implied by the PATCH to those cells that happen to lie inside the volume or area defined by the facets of the object.
For area or volume sources, Earth will scale the source by the ratio between the area (or volume) of the facets, and the area (or volume) of the affected cells, to ensure that the correct total source is set.
The CELLTYPE object is entirely equivalent to a USER_DEFINED object which has the >OBJ, GRID attribute set to NO.
Object type:
> OBJ, TYPE, NULL
The null object has no further settings.
Object type:
> OBJ, TYPE, PCB
The remaining settings for the PCB object are as for a BLOCKAGE , with the exception of the conductivity ratio. This is stored as:
> OBJ, RATIO_T/I, ratio (default 1.0)
Object type:
> OBJ, TYPE, PRESSURE_RELIEF
External Pressure and pressure Coefficient:
> OBJ, PRES_RELIEF, Pcoef, Pext
Pext may be the character string P_AMBIENT to indicate the value set for P_AMBIENT in the domain section. This is the default. Pcoef is defaulted to 1.0.
Note: The pressure-relief object never affects the grid. The size of the object is adjusted at the time of writing EARDAT to cover the cell nearest the origin of the object.
Object type:
> OBJ, TYPE, ROTOR
Number of cells jumped:
> OBJ, NJUMP, njump
Number of rotations to calculate:
> OBJ, NROTS, rots
Rotational speed in r.p.m:
> OBJ, ROTSPEED, rpm
Initialise U to w*r:
> OBJ, INI-U, YES/NO (NO assumed if line is absent)
In-Form settings for U1RL and TRU1 are made if the variables U1RL (and U2RL) ,TRU1 (and TRU2) have been STOREd.
> OBJ, TYPE, BFC_DOMAIN
> OBJ, LINK1_i, n, ixf1,ixl1, iyf1,iyl1, izf1,izl1, itype1
> OBJ, LINK2_i, m, ixf2,ixl2, iyf2,iyl2, izf2,izl2, itype2
{> OBJ, ORIENT_i, ESL}
This defines a block of a multi-block grid. The position values are in 'big' grid co-ordinates, as they locate the current block in the big grid.
Links to other blocks are defined by pairs of LINK1/LINK2 statements. One block may have many links to other blocks, or to itself.
LINK1_i defines the i-th link for the current block n. ixf1,ixl1, iyf1,iyl1, izf1,izl1 define the limits of the link in block n, in 'big' grid co-ordinates. itype1 sets the 'patch type' for the link.
LINK2_i defines the linked location in block m. ixf2,ixl2, iyf2,iyl2, izf2,izl2 define the limits of the link in block m, in 'big' grid co-ordinates. itype2 sets the 'patch type' for the link.
ORIENT_i sets the orientation code if the two blocks do not align 'naturally'.
A fuller description of multi-block linking is given in this Encyclopaedia article.
At present, the BFC_DOMAIN object cannot be created, and should not be modified, interactively. These objects are generated internally when the Q1 created by the mesh generator is read into VR-Editor.
> OBJ, TYPE, DRAG_LIFT
The Drag_lift object has no further settings.
> OBJ, TYPE, ASSEMBLY
> OBJ, PARENT, number_of_components
> OBJ, POBFILE, name_of_pob_file
These lines set the number of components in the assembly, and the name of the POB file defining the assembly.
Objects which are components of this assembly object will have an extra line:
> OBJ, CHILD, name_of_parent_assembly_object
The offset in position between a CHILD object and its parent assembly is kept constant when the assembly (or any of its components) is moved.
The ratio of sizes between a CHILD object and its parent assembly is kept constant when the assembly (or any of its components) is resized.
> OBJ, TYPE, GROUP
> OBJ, LIST1, object_name_1, object_name_2,....
> OBJ, LISTi, object_name_n, object_name_m,....
GROUP objects are created interactively from the Object Management panel - Section 4.2.4.1. Each LIST line contains names of the objects selected as members of the group. As many LIST lines are generated as are required to hold the names of all the objects in the group, subject to a maximum line length of 68 characters.
GROUP objects must come last in the Q1.
An object may be referenced in more than one GROUP.
> OBJ, TYPE, TRANSFER
Acts as export:
> OBJ, EXPORT, file_name
Acts as Import:
> OBJ, IMPORT, file_name
> OBJ, TYPE, CLIPPING_PLANE
>OBJ, PLANETYPE, Low / High
When set to Low, the clipping planes are located at the W,S,L corner of the object and clip everything 'below' them. When set to High, the clipping planes are located at the E,N,H corner of the object and clip everything 'above' them. Only two clipping_plane objects are allowed.
There are several points to bear in mind when hand-editing a Q1 file created by the VR-Editor:
do iob=1,3
> OBJ, NAME, BLK:iob:
> OBJ, POSITION, 1.000000E+00, 0.000000E+00, :9+(iob-1)*2:
> OBJ, SIZE, 5.000000E-01, 5.000000E-01, 1.000000E+00
> OBJ, CLIPART, cube14
> OBJ, ROTATION24, 1
> OBJ, TYPE, BLOCKAGE
> OBJ, MATERIAL, 199
enddo
will create three objects called BLK1, BLK2 and BLK3 with Z positions 9, 11 and 13 respectively. Note that variables or expressions used in > OBJ lines must be enclosed in :: to ensure correct evaluation.
For example, LSWEEP=500 placed after the STOP will always overwrite any setting made in the menu.
PLANT and the VR-Editor
All PLANT commands must be placed after a PLANTBEGIN comment line, and terminated with a PLANTEND comment line. The PLANT Menu does this automatically. All lines in between these comments will be preserved, and written out to the Q1 at the end of Group 10.
Any user-variable declarations used in the PLANT formulae must also be placed within the PLANTBEGIN/END lines.
A new GROUND.HTM is generated every time the Q1 is saved. This happens under the following circumstances:
In-Form and the VR-Editor
'Traditional' InForm Commands
In-Form commands must be placed after a SAVEnBEGIN comment, and terminated with a SAVEnEND comment line. Here 'n' represents the Q1 Group the In-Form commands are to be placed in. The INFORM Editor does this automatically. If a BEGIN block does not have a maching END statement, the VR-Editor will issue an error message when the Q1 is saved.
Any user-variable declarations used in the INFORM formulae must also be placed within the SAVEnBEGIN/END lines.
On exit from VR-Editor, any In-Form commands found within BEGIN/END sections will be echoed to the end of the relevant Group.
Any PIL statements or comments, not just InForm commands, placed inside a SAVEnBEGIN / SAVEnEND block will be written back to the Q1 at the end of the nth Group.
All > DOM, > GRID or > OBJ lines placed inside a SAVE25BEGIN / SAVE25END block will be echoed back to the object-settings part of the Q1 file untouched. In this way, parameterised object settings can be preserved from one Editor run to the next.
Multiple BEGIN/ENDs for the same Group number are allowed, and will be echoed sequentially. In-Form commands outside the BEGIN/END sections will not be transmitted to the Earth solver, and will be lost from the saved Q1.
In earlier versions (pre 2008) INFORMnBEGIN/END was used instead of SAVEnBEGIN/END. These older forms will be recognised and treated corrrectly, but the new Q1 will contain SAVEnBEGIN/END.
Error messages generated by malformed In-Form commands are echoed to the Text box and to the file LU6PVR at the time the Q1 is saved. Error messages generated by In-Form at Solver run-time are written to the RESULT file.
Object-related InForm Commands
An alternative form of InForm statement allows a sub-set of the Inform commands to be directly linked to the object attributes, and be held in the Q1 together with all the other attributes. These commands take the form of:
> OBJ, INFkey_var, formula with condition
In the above , 'key' is one of
'var' is one of the STOREd or SOLVEd variables, or a variable declared by MAK (MAKE).
'formula with condition' is the expression to be applied, together with any 'WITH' options that are needed. The opening and closing brackets of a traditional InForm command are not needed. Lines longer than the normal Q1 line of 68 characters should be 'folded' with a $ as the last character to denote a continuation line. As many continuation lines as needed can be used. Each continuation line should have the same > OBJ, INFkey_var, string at the beginning. An example is:
> OBJ, INFSRC_P1, uin*dens*zg with area
> OBJ, INFSRC_U1, uin*zg with onlyms
> OBJ, INFMAK_UIN, 0.0
> OBJ, INFMAK_DENS, 0.0
> OBJ, INFST1_UIN, 10*3
> OBJ, INFST1_DENS, 1.189
Sources set in this way will replace those set from the object attributes.