pro-STAR COMMANDS

Transcription

pro-STAR COMMANDS

pro-STAR COMMANDS
STAR-CD VERSION 3.26
CONFIDENTIAL — FOR AUTHORISED USERS ONLY
© 2005 CD-adapco
TABLE OF CONTENTS
Overview
STAR-CD SYSTEM STRUCTURE
pro-STAR ................................................................................................................. 1-1
STAR ........................................................................................................................ 1-2
STAR-CD File Use ................................................................................................... 1-2
pro-STAR Commands .............................................................................................. 1-4
The command line ........................................................................................... 1-4
Arithmetic expressions .................................................................................... 1-5
Keywords ........................................................................................................ 1-5
Command usage .............................................................................................. 1-6
Loops ........................................................................................................................ 1-7
Loop definition ................................................................................................ 1-7
Loop execution ................................................................................................ 1-8
Structure of pro-STAR ............................................................................................. 1-9
The pro-STAR Modules ......................................................................................... 1-11
The PRO module ........................................................................................... 1-11
The MESH module ........................................................................................ 1-11
The CONVERT module ................................................................................ 1-13
The PLOT module ......................................................................................... 1-14
The UTILITIES module ................................................................................ 1-15
The PROPERTY module .............................................................................. 1-15
The SCALAR module ................................................................................... 1-17
The BOUNDARY module ........................................................................... 1-17
The CONTROL module ................................................................................ 1-18
The RADIATION module ............................................................................ 1-20
The TRANSIENT module ............................................................................ 1-20
The DROPLETS module .............................................................................. 1-20
The LIQUID FILMS module ........................................................................ 1-21
The EVENTS module ................................................................................... 1-21
The CHEMICAL module .............................................................................. 1-22
The POST module ......................................................................................... 1-23
The GRAPH module ..................................................................................... 1-24
The ANIMATION module ............................................................................ 1-25
The EULERIAN module ............................................................................... 1-25
The AUTOMESH module ............................................................................ 1-25
PRO MODULE
Housekeeping ........................................................................................................... 2-1
Version 3.26
i
Entries to Other Modules .......................................................................................... 2-7
File I/O .................................................................................................................... 2-10
Loops ...................................................................................................................... 2-13
MESH MODULE
Miscellaneous ........................................................................................................... 3-1
Extrusion Mesh Commands ...................................................................................... 3-5
Block Mesh Commands .......................................................................................... 3-10
Local Coordinate Commands ................................................................................. 3-17
Vertex Commands .................................................................................................. 3-22
Spline Commands ................................................................................................... 3-42
Cell Commands ...................................................................................................... 3-52
Coupled Cell Commands ........................................................................................ 3-78
CONVERT MODULE
Foreign Formats ........................................................................................................ 4-1
IGES/VDA Commands ............................................................................................ 4-8
pro-STAR/STAR File Conversions ........................................................................ 4-11
PLOT MODULE
Housekeeping ........................................................................................................... 5-1
Colour Table ............................................................................................................. 5-4
Action ....................................................................................................................... 5-7
Data Base Commands ............................................................................................. 5-11
Plot Characteristics ................................................................................................. 5-23
Post-processing Plot Characteristics ....................................................................... 5-42
Droplet Plot Characteristics .................................................................................... 5-45
UTILITIES MODULE
Command Descriptions ............................................................................................ 6-1
Table Data ............................................................................................................... 6-18
Engineering Monitoring Data ................................................................................. 6-24
PROPERTY MODULE
Housekeeping ........................................................................................................... 7-1
Material Properties .................................................................................................... 7-4
Polynomial Representations ................................................................................... 7-10
Porous Properties .................................................................................................... 7-16
Scalar Properties ..................................................................................................... 7-20
Problem Conditions ................................................................................................ 7-22
SCALAR MODULE
Physical Properties .................................................................................................... 8-1
Polynomial Representations ..................................................................................... 8-4
ii
Version 3.26
BOUNDARY MODULE
Boundary Definition ................................................................................................. 9-1
Cyclic Set Definition ................................................................................................ 9-8
Region Definition ................................................................................................... 9-12
Scalar Boundary Values ......................................................................................... 9-24
Boundary Couple Definition ................................................................................... 9-25
Fluid/Structure Coupling ........................................................................................ 9-27
CONTROL MODULE
Solution Controls .................................................................................................... 10-1
Scalar Controls ...................................................................................................... 10-13
Print Out and Post Data Controls .......................................................................... 10-14
Free Surface and Cavitation Controls ................................................................... 10-20
TRANSIENT MODULE
Command Descriptions .......................................................................................... 11-1
DROPLETS MODULE
Controls ................................................................................................................... 12-1
Parcel Properties ..................................................................................................... 12-5
Spray Modelling ................................................................................................... 12-10
Droplet Models and Properties ............................................................................. 12-12
Global Models ...................................................................................................... 12-16
LIQUID FILMS MODULE
EVENTS MODULE
Event Creation/History ........................................................................................... 14-1
Grid Change and Condition Selection .................................................................... 14-8
Cell Activation/Deactivation ................................................................................ 14-10
Cell Exclusion/Inclusion ....................................................................................... 14-11
Boundary Attachment ........................................................................................... 14-12
Boundary Detachment .......................................................................................... 14-14
Automatic Event Generation ................................................................................ 14-15
Pre-/Post-Processing ............................................................................................. 14-16
Arbitrary Sliding Interface .................................................................................... 14-20
CHEMICAL MODULE
Scheme Definition .................................................................................................. 15-1
Local Source Schemes ............................................................................................ 15-5
PPDF Scheme ......................................................................................................... 15-9
Ignition .................................................................................................................. 15-14
Scalar Mapping ..................................................................................................... 15-16
Version 3.26
iii
Coal Combustion .................................................................................................. 15-17
Emissions .............................................................................................................. 15-21
Complex Chemistry .............................................................................................. 15-23
STAR/KINetics ..................................................................................................... 15-28
POST MODULE
Housekeeping ......................................................................................................... 16-1
Loading Data .......................................................................................................... 16-1
Manipulating Data ................................................................................................ 16-16
Reporting Data ...................................................................................................... 16-30
Particle Tracking ................................................................................................... 16-33
GRAPH MODULE
Register Storage ...................................................................................................... 17-3
Register Labelling and Listing .............................................................................. 17-10
Line/Symbol/Bar Type Definitions ...................................................................... 17-12
Register Manipulation .......................................................................................... 17-14
Frame Definition ................................................................................................... 17-17
Display .................................................................................................................. 17-19
Drawing ................................................................................................................ 17-22
ANIMATION MODULE
EULERIAN MODULE
AUTOMESH MODULE
RADIATION MODULE
APPENDICES
pro-STAR CONVENTIONS
Command Input Conventions .................................................................................. A-1
Help Text / Prompt Conventions ............................................................................. A-3
Control and Function Key Conventions .................................................................. A-4
File Name Conventions ........................................................................................... A-4
COMMANDS SUMMARY
COMMANDS INDEX
iv
Version 3.26
Overview
This document is one of a set describing the methodology and application of the
STAR-CD code system for industrial thermofluids calculations. The companion
STAR-CD manuals present the mathematical modelling practices and numerical
solution procedures embodied in the code (Methodology volume), plus the structure
of the system itself and how to use it (User Guide volume). This document is
concerned with the detailed description of pro-STAR commands and assumes that
the reader is familiar with the background information provided in the above
STAR-CD manuals.
The overall structure and capabilities of the STAR-CD system are presented in
Chapter 1. This also outlines the functions performed by the pre- and
post-processing code, pro-STAR, and the analysis code, STAR, along with the
various files that they generate and use.
Chapters 2 to 20 describe all available commands in detail and should be
consulted before issuing such commands during a pro-STAR session. The same
information is also available on-line so that the user can choose the source of help
according to individual preference.
Version 3.26
1
Chapter 1
pro-STAR
Chapter 1
The STAR-CD system consists of two components (see Figure 1-1): the analysis
module STAR and the pre- and post-processing module pro-STAR. External links
also exist to enable user programming of certain features and to communicate with
other CAE systems for the purposes of, for example, importing grids or performing
other kinds of analysis.
User
programming
Other
CAD/CAE
systems
pro-STAR
pre/post processor
STAR-CD
STAR
numerical analysis
code
Figure 1-1
Overall STAR-CD system structure
An outline of the various components of the system, including their modes of
operation and interactions, is given in this section.
pro-STAR
pro-STAR is an interactive, command- and GUI-driven program whose function is
to provide input data for STAR and to process the output corresponding to these
data. The code thus combines pre- and post-processing within a single,
self-contained package. The user’s interaction with the STAR-CD system is always
through pro-STAR. STAR is at present run separately as an independent,
free-standing program following completion of the input data preparation phase.
pro-STAR’s many functions and capabilities include:
•
•
•
•
•
•
•
Version 3.26
Extensive on-line help facilities
Extensive plotting functions for both mesh and results display
Extensive file control facilities
Boundary condition specification functions
Fluid and solid material property definition functions
Link facilities to other commercial CAE/CAD systems
Control functions for numerical solution and for post-processing and printing
of output data
1-1
Chapter 1
STAR
STAR
STAR is the core analysis code, which generates thermofluids predictions
corresponding to the input data provided by pro-STAR. Being an independent
program, it can be executed in a different computer or under a different operating
system, if necessary. This feature lends great flexibility to a particular
implementation of the overall STAR-CD package. STAR incorporates a numerical
finite-volume procedure for solving the governing partial-differential conservation
equations of mass, momentum and energy. The procedure employs a general,
body-fitted, non orthogonal and unstructured mesh system that endows it with
considerable geometric flexibility. These features are explained in detail in the
Methodology volume.
The types of flow and transport phenomena currently calculable with STAR
include:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Steady or transient
Laminar or turbulent
Two-layer turbulence
Non-Newtonian laminar
Heat transfer (convection, conduction and radiation)
Mass transfer
Dispersed two-phase
Chemical reaction (including combustion)
Turbulent combustion
Distributed resistance (porous media)
Buoyancy
Compressibility
Transonic/supersonic flow
Multi-stream (multi-fluid) flow
In addition to the mesh capabilities already mentioned, STAR allows the use of
adaptive and moving-mesh models with the following features:
•
•
•
•
•
Rotation (e.g. turbomachinery)
Distortion (e.g. internal combustion engines)
Dynamic cell addition or removal
Internal sliding
Embedded mesh refinement
For further details of the capabilities of STAR-CD, refer to the Methodology
volume.
STAR-CD File Use
Because the two main components of the STAR-CD system operate semiindependently, a way must be provided for them to communicate with each other.
This is achieved by means of a set of input/output files. STAR-CD associates a
user-specified case name with each file. The name of every file is made up from the
case name and a three- or four-character filename extension. The default case name
is star so, for example, the geometric data file name will default to star.geom.
The use of the most important files and their relationship to STAR and pro-STAR
1-2
Version 3.26
Chapter 1
STAR-CD File Use
is shown in Figure 1-2.
case.trns
Transient
input data
pro-STAR
case.prob
Boundary conds.
Solution params.
case.mdl
pro-STAR
save
case.echo
Command
echo
case.plot
Neutral plot
case.geom
Geometry
STAR
case.pstt
Transient
output data
case.pst
Binary
output data
Figure 1-2
STAR-CD file usage
The major STAR-CD system files are as follows:
.mdl
—
.echo
—
.plot
—
.trns
—
This file stores all pre-processing information. At any time while
using pro-STAR, the user may save all current information and
thus store an up-to-date description of a model by overwriting the
previous description. The file can be used during the current or a
subsequent session to restore the original information, overwriting
and replacing the session’s data in the process.
All commands entered during the current pro-STAR session are
recorded on this file, which may be used as a reference or case
history file. It may also be used as an input file in place of terminal
input.
Plots made during a pro-STAR session may be saved on this file in
neutral plot form and can be subsequently displayed on the screen
or used to produce hard copy through a separate plotting program.
This file is very similar to .mdl and may be used to store data for
transient models. To some extent, it can be considered as an
extension of file .mdl. Note that, in the current STAR-CD
version, this file is no longer needed for the majority of transient
cases and may become obsolete in future releases.
At the end of a pro-STAR session and completion of the modelling process, a
minimum of two files, .geom and .prob, must be created before proceeding to
the solution stage.
.geom
Version 3.26
—
The file contains all geometric information required as input by
1-3
Chapter 1
pro-STAR Commands
.prob
—
STAR, including interpolation factors, cell volumes, etc.
Additional input data required by STAR, including solution
parameters, fluid properties and boundary conditions, are written
on this file.
Before proceeding to the analysis stage, the user must ensure that an appropriately
dimensioned version of STAR is compiled and linked (see Chapter 21, “pro-STAR
environment variables” in the User Guide). At the end of the STAR run, file .pst
will normally be created. If a transient analysis is performed, file .pstt will be
created as well.
.pst
—
.pstt
—
This file is written at the end of each successful STAR run and
contains the calculated output (flow analysis results). As
explained below, it serves the dual purpose of acting as a ‘restart’
and as a post-processing file.
This file contains post-processing data for transient runs, written
out at regular time intervals during the analysis.
In cases where STAR is used for a restart run — resuming an analysis from a
previous run of the same model — file .pst is required in addition to files .geom
and .prob as it contains all information needed to continue from where the
previous run stopped. Post-processing requires both files .pst (plus file .pstt
for transient problems) and .mdl.
Finally, all files can be written in either binary or coded form, so that they can
continue to be used on the present machine or moved to a different one, if necessary.
In the latter case, translation facilities are available to read in coded files and enable
the analysis to continue in the new environment.
For further information concerning all files used in the STAR-CD system and
their formats, refer to “File I/O” on page 2-10 and to the User Guide (Chapter 21
and Appendix C).
pro-STAR Commands
pro-STAR is the interactive pre- and post-processor in the STAR-CD system. It is
the means by which one defines geometry, boundary conditions, fluid properties,
etc. It also contains extensive on-line help, warning and plotting facilities to enable
users to work in a controlled and flexible environment.
pro-STAR runs in an interactive manner that can be GUI-driven (i.e. interaction
using a Graphical User Interface) or command-driven (i.e. text commands are
entered line-by-line in any logical order). The first mode of operation is described
in the User Guide; the second in this volume. During a session, the program
provides instant feedback so that the user can decide if a command has been issued
and implemented correctly. In many cases, users are made aware of mistakes by
warning messages.
The command line
Each command line consists of a command keyword followed by an appropriate set
of alphanumeric parameters in ‘free format’ style, as described below:
•
1-4
Each keyword and alphabetic parameter can be abbreviated to its first four
Version 3.26
Chapter 1
pro-STAR Commands
•
•
•
•
•
•
•
characters.
Each parameter can be separated from others by any number of blanks or a
comma (,) followed by blanks. Command keywords can be separated from
their parameters in the same way.
Numeric parameters can be entered using fixed decimal point (10000.000) or
scientific (1.0E03, 1.0+03) notation.
Integers are converted to real numbers and real numbers may be rounded to
the nearest integer.
Alphabetic data can be typed in either capital or small letters.
Any line beginning with an exclamation mark (!) is treated as a comment and
is therefore ignored.
Any line ending with two plus signs (++) is continued on the next line but it is
not permissible to split the characters pertaining to a given parameter between
lines, i.e. a continuation line should always start with a fresh parameter.
Any number of continuation lines are allowed per command but the total
number of characters in them must not exceed 320.
Arithmetic expressions
Simple arithmetic expressions can also be evaluated directly on the command line
according to the following rules:
•
•
Each expression is evaluated strictly from left to right, not according to the
usual precedence rules for arithmetic operators.
Operators and operands must be separated from each other by the usual forms
of delineation (comma and/or blanks).
Thus, all the expressions listed below are equivalent:
VLIST,100,1000,10
VLIST, 50 + 50, 2000 / 2, 10
*SET,A,25
VLIST, 4. * A, 1000, A - 15
VLIST, 5. * A - 25, 1000, 10
Keywords
The keywords VX, CX, SX, BX, BLKX may be used instead of any numeric
parameter in any command that requires definition of a range of vertices, cells,
splines, boundaries or blocks, respectively. If present, VX will cause the program to
display a cursor and you will be asked to select a vertex from the current plot; CX,
SX, BX and BLKX will likewise require a cell, spline, boundary, or block selection.
In all cases, the value of the selected entity will be substituted into the current
command. For example, command VFILL,VX,VX can be used to create a number
of vertices between two other vertices that are selected from the current screen
display. Command CLIST,CX will list the attributes of a cell selected directly from
the current display.
In a similar way, the following keywords can be used instead of a numeric
parameter to return a numerical value to the appropriate command:
Version 3.26
1-5
Chapter 1
pro-STAR Commands
•
•
•
•
•
ICUR supplies the number of the currently active coordinate system.
MXV, MXC, MXB, MXS, MXK supply a number equal to the maximum vertex,
cell, boundary, spline or block number + 1.
SXT, SXC or SXG will yield the type, colour index and group index,
respectively, of a selected spline.
CXT, CXC, CXP, CXM, CXS or CXG yield the cell type, colour index, porosity
index, material property number, spin index or group index, respectively, of a
selected cell.
BXR yields the region number of a selected boundary.
Keyword ALL can be supplied as a single parameter in place of a three-parameter
range definition to process all relevant entities (vertices, cells, etc.) currently in
existence. Similarly, keywords CSET, VSET, SPLSET, BLKSET or BSET can be
used instead of range parameters to process all members of a cell, vertex, spline,
block or boundary set.
An alternative way of specifying a range is via keywords VCRS, CCRS, BCRS,
SCRS and BLKCRS, intended for vertices, cells, boundaries, splines and blocks,
respectively. Most commands that use range specification will also accept the
keyword xCRS to select the range by cursor picking.
Command usage
pro-STAR is capable of two modes of prompting. These attempt to take into account
a user’s expertise and familiarity with the program.
•
•
In novice mode, after typing a command, the program will prompt for the
remaining parameters. Users wishing to abandon execution of a command
should type the word ‘Abort’ instead of supplying parameter values.
In expert mode, leaving out the parameters will result in the automatic
substitution of predefined default values.
The right mode is set by a toggle operated by command EXPERT. The expert mode
naturally assumes that the user is familiar enough with the program to know which
parameters are expected for a given command and, if left blank, what the program
defaults are.
To distinguish between a default value and a blank used as a parameter separator
it is necessary to use multiple commas, two successive commas denoting an
intervening default (blank) value for the parameter that is present in that location.
For example,
CTABLE,,SOLID,,2,,
sets the second and fourth parameters of the CTABLE command to SOLID and 2
respectively while leaving the first, third, fifth and subsequent parameters to their
default values. Commas are not compulsory for defaults following the last
parameter that is set. Thus, the last two commas in the above example can be
omitted.
Additional facilities relevant to general command usage are as follows:
•
1-6
Repetition — command RPnnnn causes the previously issued command to
be repeated a given number of times, using the same or different parameters.
The allowable range for nnnn is between 2 (i.e. RP2, since the original
Version 3.26
Chapter 1
Loops
command counts as number 1) and any large integer number or even a
variable, as in the following example:
*SET ABCD=54
CLIST, 1
RPABCD, 1
•
•
•
If RPnnnn is followed by numeric parameters, these are added to the
corresponding parameters of the original command; once for each repetition.
Abbreviation — command *ABBREVIATE allows one or more frequently
used commands and their parameters to be joined together and used as a
group. This group comes into action whenever the previously defined
‘abbreviation’ is typed on the command line. All abbreviation definitions are
stored in a special file called PRODEFS.
Abbreviation listing — command *ABLIST displays currently defined user
abbreviations.
Termination — commands that take a long time to process can be terminated
halfway through by typing Ctrl+C. This returns control to the user and
displays the usual pro-STAR prompt. The facility is useful for aborting
lengthy command execution but may not work correctly in all STAR-CD
implementations.
A summary of program conventions regarding command syntax can be found in
Appendix A.
Loops
Whereas the RPnnnn command above is suitable for simple repetitions, commands
in the ‘LOOP’ group can be used to construct much more complicated sequences of
multiple commands, all of which may be repeated.
Loop definition
A pro-STAR loop structure has the following properties:
1. A start point, set by command *DEFINE.
2. A main body consisting of:
(a) An arbitrary set of pro-STAR commands.
(b) Logical tests — commands *IF, *ENDIF, *ELSE. Multiple ‘IF’
constructions can be used within a loop and can be nested up to 10 deep.
‘IF’ commands may also be used outside the main body of the loop.
(c) Branching operations — command *GOTO.
3. An end point, set by command *END.
Logical tests and branching operations enable jumps to different parts of a loop
based on an arbitrary, user-specified test. Thus, commands in this group virtually
constitute a programming language that can employ every tool in the pro-STAR tool
box.
Version 3.26
1-7
Chapter 1
Loops
Loop execution
Upon completion of the loop definition, command *LOOP will execute the current
loop as frequently as requested, according to values assigned to the *LOOP
command parameters.
Either before or during a loop definition, numeric or character string values may
be assigned to a set of user-defined parameters; these are given alphanumeric names
that are not case-sensitive. The parameters can be used instead of actual numbers or
character strings within a command. Values can be assigned to parameters in the
following ways:
1. Via command *SET (numeric parameters only) — this assigns an initial value
V init and an increment V inc to the given parameter. Any time the latter is
used inside a loop, its value is determined by V = V init +V inc × Loop No.
The following example serves to show how numeric parameters are
calculated within loops:
*SET,VAR1,10,2
*SET,VAR2,100,50
*DEFINE
VLIST,VAR1,VAR2
*END
*LOOP,2,3
–
–
begin loop definition
list vertices 10 to 100
end loop definition
re-execute the loop (loop number varies
from 2, 3)
(First Loop)
VLIST,VAR1(=10+2*2=14),VAR2(=100+50*2=200)
(Second Loop)
VLIST,VAR1(=10+2*3=16),VAR2(=100+50*3=250)
2. Via command *SSET (string parameters only) — this assigns a string value
to the given parameter. The value may include blanks and other string
parameters. These parameters may be used anywhere in a command line or as
a reply to a pro-STAR prompt requiring character string input (c.f. commands
TITLE and PLLABEL) but they must be enclosed in curly brackets.
The example below shows how such parameters are used:
*SSET CHAR1
*SSET CHAR2
*SSET CHAR3
*SSET CHAR4
*CHAR5 file
NEWSET
CSET
CSET NEWSET
SET
CSET {CHAR1} FLUID
{CHAR2} {CHAR1} FLUID
{CHAR3} FLUID
C{CHAR4} NEWSET FLUID
RESUME test {CHAR5}a.mdl
1-8
Set the string parameters
The following commands are interpreted
as shown below:
CSET NEWSET FLUID
CSET NEWSET FLUID
CSET NEWSET FLUID
CSET NEWSET FLUID
RESUME test filea.mdl
Version 3.26
Chapter 1
Structure of pro-STAR
3. Via command *CALC (numeric parameters only) — this works in a similar
manner to *SET but calculates parameters as algebraic or trigonometric
functions of a loop variable, e.g. √, log, sin, tan, etc.
4. Via command *GET — this ‘gets’ many key values known to the program and
assigns them to a user-defined numeric or string parameter. For example, the
following sequence defines a new vertex whose number is 10 higher than the
previous maximum vertex number and places it at the same X but different Y
and Z coordinates:
*GET,IV1,MXVE
stores max. vertex number in IV1
*GET,VX1,X,IV1
stores X coordinate of IV1 in VX1
V,IV1 + 10,VX1,10.2,5.3 defines new vertex
5. Via commands *ASK (numeric) or *SASK (string) — this prompts the user
for the numerical or string value of a given parameter.
6. Via command *SCOPY (string parameters only) — this copies the current
(loop) value of a numeric parameter into a string parameter. The loop value
copied over is calculated as shown in item 1 above.
A list of values for all currently defined parameters and/or loops can be obtained
using the *LIST (numeric) or *SLIST (string) commands. Command *CLEAR
will clear the settings of all numeric or all string parameters or both.
Through the judicious use of parameters, users may be able to create an entire
mesh, based on key locations and vertex definitions stored in loop variables. Large
portions of a model could also be re-meshed simply by altering the parameter
definitions and re-executing the appropriate loops.
Finally, a loop definition can be saved to a named (.loop) file using the *SAVE
command. It can thus be re-used in a different pro-STAR session by issuing an
IFILE command.
For a more detailed description of loop commands refer to “Loops” on page 2-13.
pro-STAR is divided into several units or modules, each with a different function.
Every available command belongs to a module and the user always has a so-called
current module. The PRO module is responsible for most file input and output as
well as communication between sub-modules. PRO is the module that users start in
at the beginning of a pro-STAR session. Every module can be entered from any
other module, either by typing the module name or by using a command included
in the target module. The modular structure exists primarily to organise the
STATUS and HELP commands, where STATUS provides a summary of
information concerning settings in the current module, and HELP lists the
commands available within the module or provides help with individual commands.
However, help with individual commands can also be obtained anywhere within
pro-STAR, without first entering the command’s home module. The modular
structure of pro-STAR is illustrated in Figure 1-3.
Version 3.26
1-9
Chapter 1
PRO
MESH
CONV
TRANS
DROPL
PLOT
UTIL
LFILMS EVENT
Figure 1-3
PROP
CHEM
AUTOMESH
SCAL
POST
BOUN
CONT RADIATION
GRAPH
ANIM
EULER
Modular structure of pro-STAR
As can be seen in Figure 1-3, each module deals with a different modelling aspect
— for example, the MESH module deals with mesh generation, the PROP module
deals with defining material properties, etc. — and contains a logically related series
of commands. Within each module, the commands are divided into subsets or
groups, depending on their function. The functions of the individual modules can be
summarised as follows:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
1-10
PRO — General housekeeping and file I/O functions
MESH — Mesh generation
CONVERT — Links and interfaces to other CAD/CAE systems
PLOT — Graphics and plotting functions
UTILITIES — Geometry checking and surface data manipulation
PROPERTY — Fluid and solid material property functions
SCALAR — Additional scalar variable switches and controls
BOUNDARY — Boundary definition functions
CONTROL — Solution and printout control functions
AUTOMESH — Automatic mesh generation
TRANSIENT — Transient boundary conditions and time (load) step
functions and control parameters
DROPLETS — Special functions for setting up two-phase Lagrangian flow
models
LFILMS — Special functions for setting up cases containing liquid films on
wall and/or baffles
EVENTS — Special functions for manipulating cells in moving-grid
problems
CHEMICAL — Special functions for setting up chemical reaction and
combustion problems
POST — Post-processing functions
GRAPH — On-line graph plotting functions
ANIMATION — On-line animation facilities
EULERIAN — Special functions for setting up Eulerian multi-phase flow
models
Version 3.26
Chapter 1
The pro-STAR Modules
The PRO module
This module can be likened to a reception area; it is the user’s point of entry to and
exit from pro-STAR. The internal structure of its command sets can be seen in
Figure 1-4.
PRO
Miscellaneous
Commands
Figure 1-4
Entries to
other Modules
File I/O
Loop/Macro
Commands
PRO module command set structure
The module contains:
1. Miscellaneous housekeeping commands that can, for example, provide the
model title or change the mode of pro-STAR from expert to novice.
2. Entry points to other modules, made possible by a set of commands indicating
the target module. However, users are not required to go through the PRO
module in order to jump from one module to another. Instead, they can issue
the desired module name or command from within any other module.
3. All the file I/O commands required for writing and saving the various files
already discussed in “STAR-CD File Use” on page 1-2.
4. Loop and ‘macro’ commands, which can be used to:
(a) Simulate simple program control structures such as Fortran ‘DO’ loops.
These can be helpful in generating complex meshes.
(b) Set up user-defined or program-defined parameters, which can be used
for any purpose.
(c) Abbreviate commonly used sequences of commands to a single
user-specified keyword, so as to make command input into pro-STAR less
time consuming.
(d) Execute user ‘macros’, i.e. sets of predefined pro-STAR commands stored
in special files.
For more details on the use of the PRO module commands refer to Chapter 2.
The MESH module
The commands in the MESH module are used to create a mesh representing the
geometric extent of the solution domain. These commands are divided into seven
sets, as shown in Figure 1-5.
Version 3.26
1-11
Chapter 1
MESH
Block
Commands
Vertex
Commands
Local
Coordinate
Commands
Figure 1-5
MESH module command set structure
Spline
Commands
Cell
Commands
Coupled Cell Miscellaneous
Commands
Commands
As discussed in Chapter 3 of the User Guide, the mesh is defined in terms of cells
and vertices; therefore each command set contains capabilities related to a particular
aspect of generating these entities. Thus:
•
•
•
•
1-12
The VERTEX command set is used to create vertices. These are points in
space needed to define cells or used for other functions, such as spline
definition or sensor point location. They can be created in any order and in
various ways, e.g. explicitly, graphically or by replicating an existing vertex
pattern. Following creation, subsequent manipulation of vertex positions is
possible using commands that enable arbitrary translation, reflection,
projection, etc. Reading and writing vertex data from and to a file is also
possible. Placement of vertices in space is facilitated by a wide variety of
alternative coordinate systems.
All commands required for changing and manipulating coordinate systems
are grouped in the LOCAL COORDINATE command set. The available
systems are global Cartesian (default), cylindrical, spherical or toroidal.
Alternatively, user-defined local coordinate systems of varying origin and
orientation can be specified.
In order to help users deal with complicated geometries, the SPLINE set
provides additional commands for generating and creating vertices on curved
surfaces. Such surfaces can be easily built up by a series of cubic splines. The
splines are specified using a set of primary, user-defined vertices. Splines can
be created and manipulated just like vertices. They can also be collected into
groups on the basis of shared attributes.
Cells are the basic finite-volume elements of the mesh. They are created using
commands in the CELL command set. As for vertices and splines, there is a
wide variety of cell generation methods, including creation by reference to the
corner vertices, graphical creation using the terminal cursor and replication
starting from an initial set. Cells can also be listed, deleted, or modified by
changing their constituent vertices.
To facilitate the analysis of conjugate heat transfer, multi-stream, or
multi-fluid problems, certain regions within the mesh can be designated as
fluid cells. Others can be designated as solid or porous with given solid
material properties, such as conductivity, permeability, etc. In addition, a
special type of zero-thickness, shell-type cell called a ‘baffle’ is available that
can possess solid or porous properties such as thermal and fluid resistivity.
Cell properties can be defined by setting up cell tables for the different cell
types and changed from one type to another using various combinations of
commands in the CELL set.
Version 3.26
Chapter 1
•
•
•
An alternative, partially automated, way of generating a mesh is provided by
the BLOCK command set. This is most useful in cases where the flow domain
geometry can be sub-divided into blocks of convenient shape. The available
commands enable definition of both individual block geometries and the
manner in which they are filled with cells. Alternatively, meshes can be
generated by extrusion from a starting shell surface.
To facilitate transitions between coarse- and fine-mesh regions of the model,
pro-STAR permits the definition of so-called coupled cell sets. This construct
consists of several small (slave) cells whose faces connect to a large (master)
cell face. The creation and manipulation of these sets is catered for by various
utilities within the COUPLED CELL command set.
The MISCELLANEOUS command set includes facilities to check the entire
mesh or parts thereof for characteristics such as right-handedness,
doubly-defined cells or vertices and inappropriate internal angles, aspect
ratios or warpage. pro-STAR has sensible default limits for distortion values.
For further information concerning the effects of mesh deformation, refer to
the Methodology volume.
For a full list of commands in this module and further details on their function and
application, refer to Chapter 3.
The CONVERT module
The CONVERT module can be regarded as an interface between pro-STAR and
other geometric and mesh modelling packages. Its commands are divided into three
sets, as shown in Figure 1-6.
CONVERT
Foreign Format
Commands
Figure 1-6
IGES/VDA
Commands
pro-STAR/STAR
File Conversions
CONVERT module command set structure
The facilities provided by this module are as follows:
1. Foreign format conversion commands, capable of translating cell and vertex
data to and from various packages, including ANSYS, PATRAN, IDEAS and
NASTRAN. These also allow:
(a) Automatic conversion of the standard finite-element definitions for
eight-noded bricks, tetrahedrons, prisms and pyramids into the equivalent
cell shapes and of three- or four-noded shells into baffles.
(b) Transfer of additional items of information such as PATRAN and IDEAS
pressure boundary definitions for use as pro-STAR boundary location
data.
(c) Control over the direction of the flow of information (i.e. read or write)
and the range of data to be transferred.
Version 3.26
1-13
Chapter 1
(d) Correct interpretation of the material property types in the external
package, if it exists, for use as a key to differentiate between different
kinds of solid and fluid cells.
Once pro-STAR has read the mesh data, cells can be modified, cell tables can
be set up, and the mesh can be treated as if it was created within pro-STAR.
Of course, the user is still required to build a complete thermofluids model,
even though an outside package was used for creating the mesh.
2. IGES/VDA commands, designed for importing model geometry information
from IGES- or VDA-format files. Internal meshing for the model is then an
additional task that must be performed separately by the user.
3. pro-STAR/STAR conversion commands that perform conversions of various
files generated by the STAR-CD system from binary to coded (text) format or
vice versa. These utilities are useful when moving such data files between
dissimilar computers.
For further information on the capabilities of this module, refer to Chapter 4.
The PLOT module
The commands in the PLOT module display and plot the mesh and its boundaries.
The module has been designed to provide a clear and easily controllable display of
the user’s model. The PLOT module commands are divided into six sets, as can be
seen in Figure 1-7.
PLOT
Miscellaneous Colour Table
Commands
Commands
Figure 1-7
Action
Commands
Database
Commands
Plot
Characteristic
Commands
PostProcessing
Commands
Droplet Plot
Commands
PLOT module command set structure
1. The MISCELLANEOUS set contains commands that provide help with using
the PLOT module, checking the settings of plot parameters, resetting them to
their default values and controlling terminal settings.
2. The colour scheme for both model geometry and post-processing plots can be
closely controlled by various commands in the COLOUR TABLE set.
3. The ACTION set provides a choice of different options for plotting mesh
entities, i.e. vertices, cells, splines, blocks and wall shells.
4. The data to be plotted are controlled by commands in the DATABASE set,
which specify the particular cells, vertices, boundaries, splines or mesh blocks
to be plotted. Users have the freedom and flexibility to limit and select the
required cells, vertices, etc. by the intersection or union of numeric or
geometric ranges. The time to produce any plot is proportional to the number
of cells or vertices in the set, so users can often speed up the plotting process
by pre-selecting an appropriate sub-set. DATABASE sets can also be used in
1-14
Version 3.26
Chapter 1
conjunction with mesh generation, boundary definition and post-processing
commands, replacing the actual range parameters in commands that require a
range specification.
5. The commands grouped collectively as PLOT CHARACTERISTICS provide
basic plotting features such as viewing, rotating, overlaying, and labelling.
Switches that turn on the display of numeric labels (for vertices, cells, etc.),
boundaries, surfaces or edges are activated by commands in this set.
Additionally, users can define whether the plot is to be of the see-through,
section, or hidden line variety. Section plots enable the display of data (with
switchable automatic scaling) on arbitrary cuts through the model.
6. The commands included in the DROPLET group provide special facilities for
setting up plots that display the progress of particles (or ‘droplets’) in
two-phase Lagrangian flow problems (see Chapter 13 in the User Guide).
7. The last set in this module groups together the POST PROCESSING
commands, providing facilities for displaying the output of the analysis such
as the mesh geometry, vector plots for velocities and contour plots for scalar
quantities. The appearance of plots, such as the setting of colour scales or the
uniformity of mapping velocity vectors is also controlled with this command
set.
In general, users can select any sensible combination of plot characteristics and data
displays. Velocity vectors can be superimposed on virtually any type of plot. Colour
contours, however, can be produced only on section or surface plots.
For further details on the PLOT module commands and their application, refer
to Chapter 5.
The UTILITIES module
The UTILITIES commands contain a set of functions designed to aid model control
and development. These provide information such as distances between vertices,
areas of cell faces and cell volumes. Also included are commands to help users
check the mesh arrangement. For example, all cells attached to one or more vertices
can be listed and all the different cell types within the model can be counted.
Other commands are mainly concerned with reading and writing of surface and
set data that can be stored and recalled during a pro-STAR session. For more
information concerning the commands in this module, refer to Chapter 6.
The PROPERTY module
The commands in the PROPERTY module enable users to define the material
properties of fluid, solid and porous media within the flow domain. The commands
are divided into six sets, as can be seen in Figure 1-8.
Version 3.26
1-15
Chapter 1
PROPERTY
Miscellaneous
Commands
Material
Properties
Figure 1-8
Polynomial
Porous Media
Representations
Properties
Scalar
Properties
Problem
Conditions
PROPERTY module command set structure
1. The MISCELLANEOUS set allows the user to define and manipulate
property sets for each individual material present in the model. The current or
default settings for property values can also be checked.
2. Material properties, such as density, molecular viscosity, thermal
conductivity, Prandtl number, etc. are specified for fluids and/or solids using
commands in the MATERIAL PROPERTY set. Surface data for solid
materials, such as emissivity and roughness, are, however, defined as part of
the boundary condition specifications described later in this section.
Properties can be specified as obeying standard equations of state, for
example the ideal gas law or isobaric formulation or constant value for
density. Alternatively, users can choose their own formulations for any
property by specifying a USER option in the target property command and
supplying relevant FORTRAN coding in a subroutine — see Chapter 18 of
the User Guide for more information on user-defined subroutines. Properties
are assigned in a streamwise fashion in multi-stream-type flows, where
individual fluids are separated from each other by solid walls or baffles and
can only communicate via thermal conduction.
3. Polynomial representations of the way certain fluid properties (specific heat,
thermal conductivity and molecular viscosity) vary with temperature can also
be specified via commands in the POLYNOMIAL set. Alternatively, the
required functions can be imported from built-in databases of thermodynamic
properties.
4. Porous material properties, such as porosity and permeability, are specified
using the POROUS PROPERTIES set.
5. Commands in the SCALAR PROPERTIES set provide initial conditions for
additional (scalar) solution variables that describe the concentration of any
chemical species that may coexist within the model. Within a given fluid
stream, all such species must possess the same stream-dependent material
properties, such as molecular diffusivity and Schmidt number.
6. Other physical and numerical considerations relating to the flow conditions in
the model are covered by commands in the PROBLEM CONDITIONS set.
These include the choice of turbulence model and its coefficients, activation
of rotating frames of reference and acceleration forces to simulate gravity.
The choice of location and value for the reference pressure and temperature
and the initialisation of solution variables are also made using this command
set.
1-16
Version 3.26
Chapter 1
For more information and the full list of all available properties refer to Chapter 7.
More information on alternative property formulations (physical and numerical
models) can be found in the Methodology volume.
The SCALAR module
Commands in this module define additional scalar variables for calculating and
storing chemical species concentration. They are divided into two groups, as shown
in Figure 1-9.
SCALAR
Physical
Properties
Figure 1-9
Polynomial
Representations
SCALAR module command set structure
1. Scalar variables are set up and their physical properties defined by commands
in the PHYSICAL PROPERTIES set. The chemical species are distinguished
from each other by properties such as molecular weight, density, heat of
formation, etc.
2. Polynomial representations of the way certain scalar properties (specific heat,
thermal conductivity and molecular viscosity) vary with temperature can also
be specified via commands in the POLYNOMIAL set. Alternatively, the
required functions can be imported from built-in databases of thermodynamic
properties.
For more information and a list of available scalar commands, refer to Chapter 8.
The BOUNDARY module
Commands in the BOUNDARY module define the location of boundaries in the
calculation mesh and their type (i.e. INLET, OUTLET, etc.). The commands are
divided into five sets, as shown in Figure 1-10.
BOUNDARY
Boundary
Definition
Figure 1-10
Region
Definition
Scalar
Boundary
Definition
Cyclic Set
Definition
Boundary/Region
Coupling
Definition
BOUNDARY module command set structure
Boundaries in STAR consist of the faces of calculation cells lying on the outer
surfaces of the mesh. These cell faces can be defined via commands in the
Version 3.26
1-17
Chapter 1
BOUNDARY DEFINITION set using one of two methods:
1. The location of the boundary faces can be described by the corner vertices of
each face, in a similar manner to that used for cells. Each boundary face is
tagged with a unique number that increases as more boundaries are defined.
Additionally, users must assign a ‘region’ identification number to groups of
boundary faces that have a common boundary condition.
2. The boundary locations can also be defined graphically using the graphics
cursor to either
(a) point to individual cell faces in the mesh, or
(b) draw a polygon around the required group of faces.
It is, however, necessary to display a hidden-line plot of the mesh before using
the relevant graphics commands.
The characteristics or boundary conditions for individual regions can be defined
using commands in the REGION DEFINITION set. Valid boundary condition types
are as follows:
Inlet
Outlet
Symmetry Plane
Wall
Baffle
Cyclic
Stagnation
Pressure
Free-stream Transmissive
Transient-wave Transmissive
When assigning a particular type of boundary condition to a region, pro-STAR
automatically responds by asking for boundary data that are appropriate for that
type. Boundary conditions relating to additional scalar variables are set or modified
in a separate command set, SCALAR BOUNDARIES.
Additional commands for defining and matching cyclic boundary faces are
grouped in the CYCLIC DEFINITION set. Such commands are used to create pairs
of matching boundary cell faces on two surfaces acting as cyclic boundaries.
If different parts of the mesh are rotating at different angular velocities, these
must be separated from each other via special inlet or pressure boundaries. These
are then joined together using special coupling commands included in the
BOUNDARY COUPLING set.
Users can also define non-uniform boundary conditions by specifying the USER
option. The coding required to define the variation of boundary variables is supplied
through user subroutines, as explained in Chapter 18 of the User Guide.
For further information on commands in the BOUNDARY module and their
application, refer to Chapter 9. More detailed information on boundary conditions
can be found in the Methodology volume.
The CONTROL module
The CONTROL module commands are used to set numerical solution parameters
and to regulate the printout and post-processing data storage during the analysis.
The commands are divided into three sets, as shown in Figure 1-11.
1-18
Version 3.26
Chapter 1
CONTROL
Solution
Controls
Figure 1-11
Print/Post
Controls
Scalar
Controls
CONTROL module command set structure
Commands in the SOLUTION CONTROL set determine the length and type of run
and supply parameters that help to enhance the numerical stability of the solution.
Thus, detailed control is provided over:
•
•
•
•
•
The number of iterations — or time steps for transient calculations — and the
tolerance for residuals.
The type of solution procedure and whether steady-state or transient. A more
detailed time history for transient calculations can be defined in the
TRANSIENT module, discussed in the next section.
The variables that are solved for in STAR, although the choice of solution
variables is primarily achieved implicitly by the selections in the
PROPERTIES module. For example, if the user selects the k-ε model for
turbulence, those two quantities are solved for and the turbulent viscosity
becomes available automatically. The main use of commands in this module
is therefore to override the implicit selection or to select additional variables if
necessary.
The solution parameters that control the numerical methods used during the
STAR run. Thus, the values of relaxation factors, the maximum number of
inner iteration sweeps for each variable, and the tolerance on inner iteration
residuals can be altered as necessary. A choice of differencing schemes, or a
blend of them for selected variables, is available. This module also activates
radiation modelling.
The settings concerning reading and writing of solution data that are used to
restart the analysis from the results of a previous run or control the frequency
and type of output data.
The printout for flow field variables and additional wall-surface data at the end of
the analysis is controlled using various commands in the PRINT/POST
CONTROLS set. This includes:
•
•
The printout of output during the analysis, allowing the user to echo the input
commands, boundary information and data concerning the inner iteration
loops.
The location of a monitoring cell where field values of solution variables are
printed at every iteration.
Solution and output controls for additional scalar variables are provided by
commands in a separate set, SCALAR CONTROLS.
For more information concerning the settings and significance of solution and
printout control parameters, refer to Chapter 10. The Methodology volume should
Version 3.26
1-19
Chapter 1
also be consulted.
The RADIATION module
This module contains commands for computing radiation patches and view factors
using a fast beam-tracking method based on an automatically generated voxel mesh.
Thermal, solar and direct solar radiation effects can be computed using a
surface-to-surface approach, without the need of a volume mesh. The relevant
commands are given in Chapter 21 of this volume.
The TRANSIENT module
The TRANSIENT module contains commands designed for inputting
time-dependent data. The time history of the problem to be analysed is defined by
a series of so-called load steps. These contain the number of time steps, the duration
of each step, the variation of boundary conditions from one step to another (i.e.
stepwise or linear variation), and the frequency of print and post-processing output.
Commands in this module give the user freedom to divide a transient run into a
series of successive load steps that can be stored in a transient history file.
Thereafter:
•
•
•
Each load step can be accessed, saved into a transient history file, deleted, or
its details listed.
For each new load step, users can modify existing boundary conditions or
introduce new boundary type definitions for some regions. These regions,
however, must already exist and users are not allowed to add new boundary
regions from one step to another.
During the load step definition, solution, print, and post settings can be
modified and reset to suit the time period concerned. The frequency of output
can also be specified.
This module also activates the moving grid capability. One way of specifying the
grid motion is via a user subroutine, as explained in Chapter 18 of the User Guide.
For further information concerning the full list of commands, refer to Chapter 11.
The DROPLETS module
This module contains commands required for preparing and running problems
involving two-phase Lagrangian flow, such as engine injectors and cyclone particle
separators. The commands are divided into two sets, as can be seen in Figure 1-12.
The available facilities in the MISCELLANEOUS set include specification of
•
•
•
1-20
the momentum, heat and mass transfer processes involved,
turbulence effects,
initial droplet injection conditions.
Version 3.26
Chapter 1
DROPLETS
Miscellaneous
Commands
Figure 1-12
Droplet Type
Definitions
DROPLETS module command set structure
The DROPLET TYPE command set enables specification of
•
•
the physical properties of the dispersed phase (droplets),
droplet break-up and wall collision behaviour.
These modelling capabilities are supplemented by comprehensive facilities for
displaying the droplet behaviour on the screen. For further information concerning
the full list of commands, refer to Chapter 12.
The LIQUID FILMS module
This module contains commands for modelling the formation of liquid films on
solid walls and baffles. A discussion of the available options and how to use them
appears in Chapter 17 of the User Guide. A full list of the relevant commands is
given in Chapter 13 of this volume.
The EVENTS module
The EVENTS module contains commands that enable modelling of problems
requiring time-dependent mesh movement and changes in connectivity between
mesh cells. Such problems include simulations of internal combustion engines and
mixing vessels. The eight command sets in this module are shown in Figure 1-13.
EVENTS
Event
Creation/History
Cell
Inclusion/
Exclusion
Cell
Activation/
Deactivation
Figure 1-13
•
Version 3.26
Condition
Selection
Commands
Automatic
Event
Generation
Boundary
Attachment
Boundary
Detachment
Event
Pre-/Post-Processing
Arbitrary
Sliding
EVENTS module command set structure
The mesh movement occurring in this type of problem is described in terms of
discrete, time-dependent ‘events’. Full facilities for the creation and
manipulation of these entities, such as definition, editing, listing, deletion etc.,
1-21
Chapter 1
•
•
•
•
are provided in the EVENT CREATION command set. In general, pro-STAR
events represent a more powerful and flexible alternative to user-supplied
subroutines (see the Transient module above).
As well as mesh movement, events may also be needed to describe cell layer
removal or addition. Such operations address numerical problems associated
with excessive mesh distortion and are provided in the CELL ACTIVATION
set (for addition/removal of whole cell layers) or CELL INCLUSION set (for
addition/removal of specified cell ranges).
Other event sets are used in problems involving sliding. The relevant
commands basically allow changes in cell connectivity and are grouped in the
BOUNDARY ATTACHMENT, BOUNDARY DETACHMENT and
ARBITRARY SLIDING sets. Conditional cell attachment or detachment,
enabling various regions of the mesh to be connected or cut off from each
other depending on flow conditions, is also possible using commands in the
CONDITION SELECTION set.
To ease the task of event definition, special commands are available to
generate events automatically for certain common types of moving mesh
problem such as mixing vessels. These are included in the AUTOMATIC
EVENT set.
Additional EVENT PRE-/POST-PROCESSING facilities are provided in a
separate set. These allow the user to load and execute predefined events in a
controlled fashion and to display the mesh or cell connectivity changes caused
by each of them.
For further information concerning the full list of commands available, refer to
Chapter 14.
The CHEMICAL module
The CHEMICAL module contains commands that enable modelling of chemical
reaction processes, including combustion. It covers both homogeneous reactions,
occurring within the bulk of the fluid, and heterogeneous reactions that take place
only at surfaces such as catalytic converters. The five command sets in this module
are shown in Figure 1-14.
CHEMICAL
Scheme
Definition
Local Source
Schemes
Figure 1-14
PPDF Scheme
Ignition
Scalar
Mapping
CHEMICAL module command set structure
Homogeneous reactions are defined in terms of so-called chemical reaction
schemes, in such a way that each fluid stream of the model is associated with a
unique scheme. Overall scheme definition and assignment to different regions of the
mesh is controlled by commands in the SCHEME DEFINITION set. The available
schemes are classified according to the reaction model they employ, of which the
1-22
Version 3.26
Chapter 1
following four are currently available:
1.
2.
3.
4.
Eddy break-up
Chemical kinetic
Combined eddy break-up and chemical kinetic
Presumed Probability Density function
For the first three models listed above, the user defines the reactants and products
participating in a chemical reaction via commands in the LOCAL SOURCE set.
Scalar variables representing the concentration of each constituent are specified by
commands in the SCALAR MAPPING set. Reactions that use the PPDF model are
defined by separate commands grouped together in the PPDF set.
If an ignition mechanism is present in the model, its characteristics are prescribed
by special commands in the IGNITION set.
Chapter 15.
The POST module
The commands of this module are divided into four sets, as can be seen in Figure
1-15.
POST
Miscellaneous
Commands
Figure 1-15
Data Loading
Commands
Data
Manipulation
Commands
Data Reporting
Commands
POST module command set structure
Combining commands in the POST and PLOT modules, users can represent the
results of an analysis in both graphical and alphanumeric (printed) form. Thus:
•
•
•
Version 3.26
Access to post-processing data is provided by the DATA LOADING
commands. These can read file .pst, containing cell-centre data for all
solution variables, or file .pstt, containing transient solution data. Variables
can be imported for plotting or printing with the aid of appropriate cell-centre,
vertex, or wall data commands. Cell data are regarded as constant within each
cell and are never interpolated; thus, colour contour plots all have a
characteristic checker-board pattern. Vertex data, on the other hand, are
always interpolated to the given location, thus producing smooth colour
contours.
The data can be modified in numerous ways using the DATA
MANIPULATION commands, e.g. by scaling data over a given range or
performing vector arithmetic on one or more variables. The set also contains
an automatic converter from SI to English units.
Commands in the DATA REPORTING set provide various reporting
capabilities, including sorting data into ascending or descending order and
averaging them.
1-23
Chapter 1
For further information concerning the full list of post-processing commands and
their function, refer to Chapter 16.
The GRAPH module
The module contains commands required for preparing and displaying
post-processing data as two-dimensional graphs. This includes time histories of
selected flow variables plus monitoring values and solution residuals plotted against
iteration number. The command sets are shown in Figure 1-16.
GRAPH
Register
Storage
Register
Labelling/Listing
Line/Symbol
Definition
Figure 1-16
Display
Commands
Register
Manipulation
Drawing
Commands
Frame
Definition
GRAPH module command set structure
The distinguishing features of each set are as follows:
1. REGISTER STORAGE contains commands that
(a) set up special storage locations called graph registers,
(b) read data into registers so that they can be displayed in graph form,
(c) store the data in external files for later reuse.
Any flow variable or other physical quantity available in pro-STAR or
produced by an external program can be loaded in this fashion.
2. REGISTER LABELLING includes commands for labelling, listing and
defining the type (line, bar, etc.) of all available registers.
3. REGISTER MANIPULATION includes commands for performing various
kinds of operation (sorting, algebraic, trigonometric, calculus, etc.) on the
values stored in each register.
4. LINE/SYMBOL DEFINITION contains commands that define
(a) how variable values are marked on the graph
(b) the type of line used to join them together
(c) the type of bar used in the case of bar graphs
5. FRAME DEFINITION commands define the overall appearance of the graph
to be produced, including
(a) the basic graph type (e.g. Cartesian, log-log, bar, pie, etc.)
(b) the data type corresponding to the x- and y-axes, respectively
1-24
Version 3.26
Chapter 1
(c) size, labelling and tick marks for the x- and y-axes
6. DISPLAY commands control the display characteristics, such as line colour
and thickness, character size, splitting the plot into multiple graphs, etc.
7. DRAWING commands perform the actual graph plotting as well as auxiliary
functions such as zooming, panning and displaying the value of a point picked
on a graph with the graphics cursor.
Chapter 17.
The ANIMATION module
This module contains commands for producing animated visualisations of
post-processing data. A discussion of the available options and how to use them
appears in Chapter 9 of the User Guide. A full list of the relevant commands is given
in Chapter 18 of this volume.
The EULERIAN module
This module contains commands for setting up Eulerian multi-phase models. A
discussion of the available options and how to use them appears in Chapter 14 of
the User Guide. A full list of the relevant commands is given in Chapter 19 of this
volume.
The AUTOMESH module
Commands grouped under this module cover automatic meshing extensions to
pro-STAR. These commands are typically issued through the special AutoMesh
GUI panel, discussed in a separate User Guide entitled ‘pro-STAR with Auto Mesh
Generation’, and as such do not need to be learned by the user. However, a
knowledge of some of their options will benefit the user in understanding the GUI
operations and are explained in some detail in Chapter 20 of this volume.
Version 3.26
1-25
Chapter 2
PRO MODULE
Housekeeping
Chapter 2
PRO MODULE
Default values for numerical parameters are given in brackets in the command line
description. Where keyword parameters are involved, the default value always
appears first in the list of possible options.
Housekeeping
BATCH, STATUS: When the BATCH, ON option is activated, pro-STAR
assumes that it is working in batch or background mode. It will not issue any
prompts requiring a Yes or No to continue. It will act as if the user always wants to
continue. BATCH, OFF (the default) assumes that the user is working interactively.
In this mode, pro-STAR will prompt the user for a stop or continue when printing
long lists of data or before executing certain commands with far-reaching or
permanent effects.
STATUS
– /OFF/ON/.
Example in tutorial: None
CASENAME, NAME: Changes the default casename for files. This will not affect
files that are already open. However, this will reset the input and output restart file
names (see the RDATA and WDATA commands).
NAME
– New case name (up to 70 characters, no blanks or commas).
Example in tutorial: 8.3
CURSORMODE, OPTION: Allows the user to read cursor picks from the input
file instead of displaying the crosshair and using the screen.
OPTION
– SCREEN. Crosshairs appear on the screen.
– FILE. Cursor pick coordinates are read from the current input
file.
ECHOINPUT, STATUS: Turning ECHOINPUT on forces all input data to be
echoed to the current output file whether that is the screen or a disk file. Input read
from any file, other than the standard input device, is always echoed to output.
STATUS
Version 3.26
– /OFF/ON/.
2-1
PRO MODULE
Chapter 2
Housekeeping
EXIT: Returns to the PRO module.
EXPERT, STATUS: Turns the interactive expert mode on or off.
STATUS
– OFF (default). When a command name is entered without
arguments, pro-STAR will prompt for the required input for
the command. This is also known as NOVICE mode.
– ON. When a command name is entered without arguments,
pro-STAR will use the default values for the command.
HELP, OPTION
or
HELP, COMMAND: Displays the command set for this module or displays more
detailed information about a specific command within this module.
OPTION
– PRO or blank. Lists all commands in this module.
– PROG. Shows the program conventions.
– FILE. Shows the default file usage.
– STDUNITS. Shows the units used in pro-STAR.
– COMB. Shows the plot combinations available.
– COML. List of all pro-STAR commands.
– SUBR. List of all STAR user subroutines.
– TOOL. List of all pro-STAR tool panels.
– RADS. Documentation of Radiation Setup boundary
parameters.
– ENVI. Environment set up definitions.
– DBAN. List of data banks available in pro-STAR.
– MACR. Documentation of MACRO files and usage.
– PANE. Documentation of user-defined Motif panels.
HISTORY, NCOMMANDS(20), CGREP: Lists previously issued commands.
2-2
NCOMMANDS
– Number of commands to list, counting backward from the
last command executed. The keyword ALL may be used.
CGREP
– An optional character string. If not left blank, only those
command lines that contain the string will be listed. This
string may not contain any blanks or commas.
Version 3.26
Chapter 2
PRO MODULE
Housekeeping
MEMORY, OPTION: Sets the size of various pro-STAR parameters.
OPTION
– LIST,PARAMETER. Lists the current value of a parameter. If
PARAMETER is left blank, or if the keyword ALL is used in
the PARAMETER field, then all the parameters available for
change will be listed. See below for a list of valid parameters.
– WRITE. Writes the current parameters to param.prp. The
old param.prp file will be renamed param.bak. The new
param.prp will size pro-STAR to the current memory
allocations the next time pro-STAR is run.
– PARAMETER,NEWSIZE. Sets a new size for a parameter for
the current pro-STAR session. If NEWSIZE is left blank, the
current size of the parameter will be displayed, and the new
size will be prompted for. The new size must be greater than
the current size of the parameter. Note that this does not
change the value of the parameter in the parameter file
(param.prp); a new parameter file can be created by using
the WRITE option.
Valid PARAMETERS include:
MAXASI
MAXBCP
MAXBLK
MAXCEL
MAXDRP
MAXEAT
MAXEDE
MAXEVE
MAXNBU
MAXNCP
MAXNCY
MAXPRB
MAXREF
MAXREG
MAXRGS
MAXSAM
MAXSPL
MAXTAB
MAXVRT
MXSTOR
NCPDIM
NCYDIM
Version 3.26
– Maximum allowed number of event arbitrary sliding interfaces
(for post-processing).
– Maximum allowed number of boundary couples.
– Maximum allowed number of blocks.
– Maximum allowed number of cells.
– Maximum allowed number of droplets.
– Maximum allowed number of event attachments.
– Maximum allowed number of event detachments.
– Maximum allowed number of events.
– Maximum allowed number of boundaries.
– Maximum allowed number of couples.
– Maximum allowed number of cyclic sets.
– Maximum allowed number of sensors and particles.
– Maximum allowed number of event refined cells.
– Maximum allowed number of boundary regions.
– Maximum allowed number of graph registers.
– Maximum allowed number of trimmed cells.
– Maximum allowed number of splines.
– Maximum allowed number of cell, couple, and spline tables.
– Maximum allowed number of vertices.
– Maximum allowed number of total graph register items.
– Maximum allowed number of cells in a couple.
– Maximum allowed number of boundaries in a cyclic set.
2-3
PRO MODULE
Chapter 2
Housekeeping
(Note that the parameter name may not be shortened to four characters.)
Other valid PARAMETERS are MAXB1D, MAXBRK, MAXCUT, MAXFAC,
MAXINF, MAXKT, MAXSC1, MAXSC2, and MAXSC3. These are internal
parameters that should not be changed unless an error message specifically instructs
that they need changing.
Example in tutorial: 2.4, 7.1, 7.2, 7.3, 7.5, 11.1, 13.1, 17.2
MENU: Switches pro-STAR to the Graphical User Interface mode. Commands can
then be issued from pull-down menus or by clicking screen buttons instead of typing
them in.
OPANEL, OPTION, NAME: Opens graphical user interface tool dialogs or
user-defined panels from the command line. Typically, this command would be
used in the PROINIT file to open a set of tools or panels that the user wants on the
screen each time pro-STAR is run.
OPTION
– PANEL (default). Open a user-defined panel.
– TOOL. Open one of the standard tool dialogs that exists within
the pro-STAR graphical user interface. HELP,TOOL gives a
list of all the tool dialogs available.
NAME
– Name of the panel or tool dialog. If this is left blank, it will be
prompted for. Note that panel names are case-sensitive, while
tool dialog names are not.
Example in tutorial: 16.1, 16.2
PAGE, NLINES(20): Sets the number of lines per page for several of the list
commands.
NLINES
– Number of lines of display printed out before the user is asked
for a carriage return to continue.
QUIT, OPTION, LF(case.mdl): Exits from program.
2-4
OPTION
– /NOSAVE/SAVE/.
LF
– File name to save the current model.
Version 3.26
Chapter 2
PRO MODULE
Housekeeping
Example in tutorial: All
RECALL, LC1, LC2: Recalls previously issued commands and re-executes them.
LC1 to LC2 represents a range of command numbers to re-execute. The HISTORY
command can be used to review all previously issued commands.
LC1
– First command number to re-execute (default is last executed
command).
LC2
– Last command number to re-execute (default is LC1).
SAFETY, OPTION, STATUS: Allows the user to turn on or off several safety
features. Note: Turning off any of these options might speed up pro-STAR, but at
the possible cost of making any sort of recovery from mistakes nearly impossible.
Thus, turning off these options should be used with extreme caution.
OPTION
– VUNDO. Turns on/off automatic saving of vertex data when
changes are made. Turning this off prevents the VUNDO
command from operating.
– ECHO. Turns on/off all writing to the echo file. Turning this
off prevents use of the HISTORY, RECOVER and RECALL
commands.
– OUTPUT. Turns on/off all output to the screen (identical to
OFILE,NONE).
– ERROR. Turns on/off the Error/Warning Summary dialog box.
– F16BACK. Automatic backup of the model file.
STATUS
– /ON/OFF/.
SETENV, ELEMENT, TYPE: Sets a user defined environment variable for a
display element. The entire directory path for the display element will be prompted
for.
ELEMENT
– MACRO. Sets the path for macro directories.
– PANEL. Sets the path for panel directories.
TYPE
– LOCAL. A local (user specific) element will be set up.
– GLOBAL. A global element will be set up.
Version 3.26
2-5
PRO MODULE
Chapter 2
Housekeeping
SETFEATURE, OPTION: Sets various pro-STAR features on or off for the
duration of the run. These features are not saved on the model file and do not change
with the use of the RESUME command. The commands available vary by
computer.
OPTION
– LIST. Lists all settings.
For DEC/Compaq ALPHA only:
OPTION
– /BIGENDIAN/LITTLEENDIAN/. Users can use this switch to
swap the byte ordering of binary files. Big Endian format is
native to most machines. Little Endian is native to the ALPHA.
If you want to read .mdl files created in the native format, you
must switch this feature to LITTLE before attempting to
resume or read a binary file.
SIZE: Prints a list of some current maximum quantities (maximum cell number,
maximum vertex number, etc.) allowed in pro-STAR. Users may increase these
values by using the MEMORY command.
STATUS: Displays the status of certain variables within this module.
SYSTEM: The program will prompt for a command line which will be passed to
the operating system and executed as an operating system command. This function
might not be available on all systems.
Example in tutorial: 2.4, 2.7, 9.5, 11.1, 16.3
TEXT: Changes display from graphics screen to text screen.
TITLE, OPTION: Sets the title for the model. The user will be prompted for a title
which may be up to 80 characters long. If the user returns a blank line, the title will
remain unchanged.
2-6
Version 3.26
Chapter 2
PRO MODULE
Entries to Other Modules
OPTION
– NONE to clear the title to a blank line.
TPRINT: Toggles a switch which reports the CPU time required to complete each
pro-STAR function. It is intended mainly for debugging and might not work on all
machines.
USER: Allows access to user written pro-STAR subroutines. The subroutines must
have been previously compiled and linked into the current version of the program.
VARIABLE, OPTION: Controls the allowable length for numeric and string
parameter names.
OPTION
– LONG (default). Numeric and string parameter names can be
up to 80 characters long.
– SHORT. Numeric and string parameter names will be limited
to four characters. Note that any parameters that have already
been defined with names longer than four characters will be
unusable until the VARI,LONG command is issued again.
Note: The status of this command is not saved in the model file.
WIPEOUT, MEMOPT: WIPEOUT with no options clears all model parameters
but leaves the current memory size intact. WIPEOUT, MEMORY clears the model
and releases all memory, back to the size of the param.prp file.
MEMOPT
– /MEMORY/
ANIMATE: Goes to the ANIMATION Module. The animate module is used to
Version 3.26
2-7
PRO MODULE
Chapter 2
create animation files and to display those files on a graphics device.
BOUNDARY: Goes to the BOUNDARY module. This module is used to assign
boundaries to exterior and interior walls and to define values to assign to those
boundaries.
Example in tutorial: 1.1, 2.1, 3.2, 4.1, 4.2, 5.1, 8.1, 9.1, 11.1
CHEMICAL: Goes to the CHEMICAL reactions module. The chemical reactions
module is used to define different chemical reaction models based on the material
types, the leading reactants (fuels) and reactants used, and the products and their
quantities and proportions prior to and after the reaction.
CONTROL: Goes to the CONTROL module. This module is used to define
various solution controls and printout options.
Example in tutorial: Most tutorials
CONVERT: Goes to the CONVERT module. This module is used to read in data
from foreign mesh generating programs and convert the data into the format
required by pro-STAR. It can also write out data in foreign formats. Additionally,
the CONVERT module contains the ability to convert STAR post data files written
in binary format to machine neutral coded (ASCII) formats and back again.
DROPLETS: Goes to the DROPLETS module. This module is used to define two
phase Lagrangian flows.
EVENTS: Goes to the EVENTS module. The events module is used to define a
sequence of event steps dealing with deactivation, activation, change of fluid stream
type, exclusion and inclusion of cells, their new attachments, detachments and
conditional and sliding interface cases, grid change commands, their processing
(loading and execution) and creating an events file for processing in STAR.
2-8
Version 3.26
Chapter 2
PRO MODULE
Example in tutorial: 7.1, 7.2, 11.1
GRAPH: Goes to the GRAPH module. The graph module is used to draw x-y plots
by filling registers with the required information and defining the variables to be
plotted.
MESH: Goes to the MESH module. This module is used to define/generate vertex
locations and cell connectivities.
Example in tutorial: 4.2, 5.1, 8.1, 8.2
PLOT: Goes to the PLOT module. This module is used to plot the geometry,
connectivity and boundary assignments of all or part of the model. It is also used to
plot vector and/or scalar fields used for post-processing purposes.
POST: Goes to the POST module. This module is used to load and manipulate post
data.
PROPERTIES: Goes to the PROPERTIES module. This module is used to define
all model material properties.
RADC: Goes to the RADCALC module. New Meshless Radiation module. The
code computes the patches and view factors using a fast beam-tracking method
based on an automatically generated voxel mesh. Thermal, solar and direct solar
radiation can be computed using a surface-to-surface approach, without the need of
a volume mesh. For more complex coupled heat transfer problems with conduction
and convection, the code can be interfaced with STAR. Please note that, for this
case, a volume mesh is necessary.
Version 3.26
2-9
PRO MODULE
Chapter 2
File I/O
SCALAR: Goes to the SCALAR module. This module is used to define all control
data, material properties and boundary conditions that are associated with additional
scalar mass fraction equations. Up to 50 independent scalars may be defined and
solved for within STAR-CD.
TRANSIENT: Goes to the TRANSIENT module. This module is used to
create/modify a transient history data file containing multiple load steps. These
steps define a time-dependent set of changing boundary specifications. This module
is not necessary for analyses limited to steady-state conditions.
UTILITIES: Goes to the UTILITIES module. This module contains a collection of
various utilities that may be of help to the user in preparing a model.
File I/O
CDSAVE, LCELL(case.cel), LVERT(case.vrt),
LBOUND(case.bnd), LREST(case.inp), LEVENT(case.evnc): Saves
all model data in coded format, typically to transfer the data to another computer
with a binary data representation that is incompatible with the current computer. All
data is saved except for plot options, set definitions and some printout keys. To
recover the model, use the IFILE command on file LREST.
LCELL
– File to write cells to.
LVERT
– File to write vertices to.
LBOUND
– File to write boundaries to.
LREST
– File to write miscellaneous data to.
LEVENT
– File to write events data to.
Note: The writing of any file (except LREST) can be suppressed by entering a ‘–1’
for the file name.
CLOSE, LF(case.inp): Closes a previously used file. Closing the echo file
(case.echo) flushes its buffers so that information will not be lost if the computer
2-10
Version 3.26
Chapter 2
PRO MODULE
File I/O
crashes.
LF
– File name or
– ALL to close all possible files currently open.
GEOMWRITE, LF(case.geom), GSCALE(1.0), FILETYPE, CHECKOPT:
Writes the geometry file used by the analysis section of STAR.
LF
– Geometry file name.
GSCALE
– Scale factor to apply to geometry.
FILETYPE
– /BINARY/CODED/.
CHECKOPT – /CHECK/NOCHECK/. If CHECK is entered, pro-STAR will
perform the double vertex, double cell, negative volume, cell
connectivity, couple, cyclic set and processor number checks
(see command CHECK, command CPCHECK and command
CYCHECK for more details). If any errors are found, the user
is given a chance to exit the command gracefully without
creating a geometry file so that the errors may be fixed.
IFILE, OPTION: Sets the location from where the program input is read.
OPTION
– LF(case.inp). Program input will be read from file LF. This
is the default option of the command if the input is currently
being read from the keyboard. Please note that the CURSOR
command must be set to FILE if the input file contains
cursor-specified commands and automatic cursor selection is
desired.
– TERMINAL. Program input will be read from the keyboard.
This is the default option of the command if the input is
currently being read from a file.
NGEOM, LF(case.ngeom), GSCALE(1.), TYPE: Converts and outputs the
model for use in STAR CCM, STAR CCM+ or CEDRE.
This command outputs cells as a collection of faces, e.g. polyhedral cells. Where
couples occur, the corresponding faces are divided based on the topology on each
side the couple and the proper parts of each divided face are assigned to the correct
Version 3.26
2-11
PRO MODULE
Chapter 2
File I/O
cell. This results in a completely connected, continuous mesh with no couples.
LF
– File name to which to output the model.
GSCALE
– Scale factor to apply to geometry.
TYPE
– /NGEOM/CCM/CCM+/CEDRE/.
– NGEOM. Outputs the ngeom file format.
– CCM. Outputs the model for STAR CCM.
– CCM+. Outputs the model for STAR CCM+.
– CEDRE. Outputs the model for CEDRE.
Note: Currently, the only difference between STAR CCM and STAR CCM+ is that
the patch numbers get compressed for STAR CCM and they do not for
STAR CCM+.
OFILE, OPTION: Sets the location to where the program output is written.
OPTION
– FILENAME(case.out). Program output will be written to
file FILENAME. This is the default option of the command if
the output is currently being written to the screen.
– SCREEN. Program output will be written to the output
window. This is the default option of the command if the
output is currently being written to a file or if the output is
currently being written nowhere.
– NONE. Program output will be written nowhere.
PROBLEMWRITE, LF(case.prob), FILETYPE8: Writes the problem data
file (STAR file case.prob) containing all control, print, property and boundary
condition information.
LF
– Problem data file name.
FILETYPE8 – /BINARY/CODED/. (Specifies how the geometry file was
written, not how the problem file will be written.)
RECOVER: Goes back to last SAVE or RESUME or beginning of echo file,
resumes and plays back all commands since that point. Then the user is prompted
for the number of the last command in the list to re-execute.
2-12
Version 3.26
Chapter 2
PRO MODULE
Loops
WARNING: The user should bear in mind that other input/output files are not
necessarily rewound. It may not be possible to successfully recreate an exact
environment in every possible situation.
RESUME, LF(case.mdl): Restores a previously created model.
LF
– File name from which to restore.
REWIND, OPTION: Rewinds a previously used file.
OPTION
– LF(case.inp). Rewinds file name LF.
– MACRO. Rewinds the current macro.
SAVE, LF(case.mdl): Saves all data from the current model.
LF
– File name to which to save the model.
Loops
*ABBREVIATE, COMMAND: The user may construct a list of personal
commands or abbreviations that are automatically maintained in a file called
‘prodefs’. The user will be prompted for a command string to associate with this
particular COMMAND. The command string may consist of multiple commands
separated by dollar signs ($) as long as the total length does not exceed 75
characters. The ‘prodefs’ file can also be edited with any text editor to
add/modify/delete any particular abbreviations as needed. Abbreviations may be
used to define other abbreviations. However, care should be taken to avoid
constructing infinite loops as well as commands that expand to greater than 80
characters.
COMMAND – A one- to four-character alphanumeric string with which to
associate a user-defined command string.
Version 3.26
2-13
PRO MODULE
Chapter 2
Loops
*ABLIST, COMMAND: Lists a user-defined abbreviation.
COMMAND – A predefined abbreviation. If blank, all user-defined
abbreviations from file ‘PRODEFS’ will be listed.
*ASK, PARA: Prompts the user to enter the numerical value and increment for a
numeric parameter.
PARA
– The parameter name, which can be any alphanumeric string of
up to 80 characters. Note that parameter names are not
case-sensitive.
*CALC, PARA, AVAL(1.0), FUNCT, VAR1, BVAL(0.0), VAR2: Calculates a
numeric parameter as a function of a variable:
PARA = AVAL*FUNCT(VAR1,VAR2) + BVAL
The allowable functions FUNCT are defined below. Note that most functions do not
require VAR2.
2-14
PARA
case-sensitive.
AVAL
– Scale factor to multiply the function by.
FUNCT
– ABSOLUTE. Absolute value of VAR1.
– ACOSINE. Arccosine of VAR1, in radians.
– ASINE. Arcsine of VAR1, in radians.
– ATANGENT. Arctangent of VAR1, in radians.
– ATN2. Arctangent of VAR1/VAR2, in radians.
– COSH. Hyperbolic cosine of VAR1.
– COSINE. Cosine of VAR1 (VAR1 is in radians).
– CUBRT. Cube root of VAR1.
– DACOSINE. Arccosine of VAR1, in degrees.
– DASINE. Arcsine of VAR1, in degrees.
– DATANGENT. Arctangent of VAR1, in degrees.
– DCOSINE. Cosine of VAR1 (VAR1 is in degrees).
– DSINE. Sine of VAR1 (VAR1 is in degrees).
– DTANGENT. Tangent of VAR1 (VAR1 is in degrees).
– EXP10. 10 raised to the VAR1 power.
– EXPE. e raised to the VAR1 power (e = 2.71828182845905).
Version 3.26
Chapter 2
PRO MODULE
Loops
FUNCT
– INT. Integral part of VAR1.
– INVERSE. Inverse of VAR1 (i.e. 1.0/VAR1).
– LOG10. Log base 10 of VAR1.
– LOGE. Natural log of VAR1.
– MAX. Maximum of VAR1 and VAR2.
– MIN. Minimum of VAR1 and VAR2.
– MOD. MOD(INT(VAR1),INT(VAR2)).
– NINT. NINT(VAR1).
– SIGN. SIGN(VAR1,VAR2).
– SINE. Sine of VAR1 (VAR1 is in radians).
– SINH. Hyperbolic sine of VAR1.
– SQRT. Square root of VAR1.
– TANGENT. Tangent of VAR1 (VAR1 is in radians).
– TANH. Hyperbolic tangent of VAR1.
– **2. Square VAR1.
– **3. Cube VAR1.
– **4. Raise VAR1 to the fourth power.
VAR1
– Variable to be used in the function.
BVAL
– Offset to add to the function (after the function has been
multiplied by the scale factor AVAL).
IVAR2
– Second variable to be used in the function if necessary.
*CLEAR, OPTION: Clears all numeric and/or string parameters.
OPTION
– BOTH (default). Clears all user-defined numeric and string
parameters.
– NUMERIC. Clears all user-defined numeric parameters only.
– STRING. Clears all user-defined string parameters only.
*DEFINE, EXEOPT: Begins the definition of a loop. All commands that follow
up to an *END command can be repeated using the *LOOP command.
EXEOPT
– EXECUTE. Each command is executed as the loop is defined.
– NOEXECUTE. The loop commands can be typed in, but
nothing is executed. The user must use at least one pass of the
*LOOP command to activate the loop.
Example in tutorial: 2.4, 7.1, 7.5, 9.6, 11.1, 13.1, 15.1, 16.3, 17.1, 17.2
Version 3.26
2-15
PRO MODULE
Chapter 2
Loops
*ELSE: May be used in a loop in conjunction with the *IF/*ENDIF to define
logical tests. For example:
*IF N1 GT 10 THEN
VLIST N1
*ELSE
*GOTO DONE
*ENDIF
*END: Ends a loop definition.
*ENDIF: Ends an *IF/*ENDIF block of commands in a loop. All commands after
*ENDIF are executed unconditionally.
*GET, PARA, ITEM, NITEMA, NITEMB: Gets the value of a given item and
stores it in a numeric or string parameter. Numeric parameters can be used in lieu
of any numeric field in any command. See the *SSET command help for help on
using string parameters. The meaning of NITEMA and NITEMB vary with each
ITEM and are described below.
PARA
case-sensitive.
The following are the various combinations for ITEM, NITEMA and NITEMB.
Vertex Related Items
(*GET, PARA, ITEM, NITEMA, NITEMB)
2-16
Item
NITEMA
NITEMB
Description
DISTANCE
NV1
NV2
The distance between vertices
NV1 and NV2.
Version 3.26
Chapter 2
PRO MODULE
Loops
Vertex Related Items
Item
NITEMA
NITEMB
Description
/DX/DY/DZ/
NV1
NV2
The difference in the x-, y- or
z-coordinates of vertices NV1
and NV2 in the currently active
coordinate system.
MNVSET
–
–
Minimum vertex number in
current vertex set.
MXVARRAY
–
–
Maximum vertex number
allowed in model.
MXVERTEX
–
–
Maximum vertex number.
MXVSET
–
–
Maximum vertex number in
current vertex set.
NVSET
–
–
Number of vertices in current
vertex set.
/RX/RY/RZ/
NVERT
–
Nodal rotations of vertex
NVERT (MTYPE = ANSYS).
/SCRX/SCRY/SCRZ
NVERT
–
Screen coordinates of vertex
NVERT.
VSET
NPOS
–
Vertex number at the NPOS-th
position in current vertex set.
/X/Y/Z/
NVERT
–
Vertex coordinates of NVERT
in the currently active coordinate system.
Cell Related Items
Version 3.26
Item
NITEMA
NITEMB
Description
CGEOM
NCELL
–
Geometry type of cell number
NCELL. (1 = fluid, 2 = solid,
3 = baffle, 4 = shell, 5 = line,
6 = point).
CSET
NPOS
–
Cell number at the NPOS-th
position in the current cell set.
CTNAME
ICTY
–
Name of cell table entry
number ICTY.
2-17
PRO MODULE
Chapter 2
Loops
Cell Related Items
Item
NITEMA
NITEMB
Description
ICTYPE
–
–
Current cell type.
MNCSET
–
–
Minimum cell number in the
current cell set.
MXCARRAY
–
–
Maximum cell number allowed
in model.
MXCELL
–
–
Maximum cell number.
MXCSET
–
–
Maximum cell number in the
current cell set.
MXCTYPE
–
–
Maximum cell table number.
NC
NPOS
NCELL
Vertex number stored in the
NPOS-th position of cell
number NCELL.
NCSET
-
-
Number of cells in current cell
set.
NCTYPE
NCELL
-
Cell type of cell number
NCELL.
NVCELL
NCELL
-
Number of vertices in cell
NCELL.
Boundary Related Items
2-18
Item
NITEMA
NITEMB
Description
BRNAME
NREG
–
Name of boundary region
number NREG.
BSET
NPOS
–
Boundary number at the
NPOS-th position in the current boundary set.
MNBSET
–
–
Minimum boundary number in
the current boundary set.
MXBOUND
–
–
Maximum boundary number.
MXBSET
–
–
Maximum boundary number in
the current boundary set.
Version 3.26
Chapter 2
PRO MODULE
Loops
Boundary Related Items
Item
NITEMA
NITEMB
Description
MXPATCH
–
–
Maximum patch number.
MXREGION
–
–
Maximum region number.
NB
NPOS
NBOUN
NPOS-th position of boundary
number NBOUN.
NBPATCH
NBOUN
–
Patch number of boundary
NBOUN.
NBREGION
NBOUN
–
Region number of boundary
NBOUN.
NBSET
–
–
Number of boundaries in current boundary set.
Spline Related Items
Version 3.26
Item
NITEMA
NITEMB
Description
ISTYPE
–
–
Current spline type.
MNSSET
–
–
Minimum spline number in
current spline set.
MXSPLINE
–
–
Maximum spline number.
MXSSET
–
–
Maximum spline number in
current spline set.
MXSTYPE
–
–
Maximum spline table number.
NSPLSET
–
–
Number of splines in current
spline set.
NSP
NPOS
NSPLI
NPOS-th position of spline
NSPLI.
NSTYPE
NSPLI
–
Spline type of spline number
NSPLI.
NVSP
NSPLI
–
Number of vertices in spline
NSPLI.
2-19
PRO MODULE
Chapter 2
Loops
Spline Related Items
Item
NITEMA
NITEMB
Description
SPLSET
NPOS
–
Spline number at the NPOS-th
position in the current spline
set.
Block Related Items
Item
NITEMA
NITEMB
Description
BLKSET
NPOS
–
Block number at the NPOS-th
position in the current block
set.
MNKSET
–
–
Minimum block number in
current block set.
MXBLOCK
–
–
Maximum block number.
MXKSET
–
–
Maximum block number in
current block set.
NBLKSET
–
–
Number of blocks in current
block set.
Couple Related Items
(*GET, PARA, ITEM, NITEMA, NITEMB
2-20
Item
NITEMA
NITEMB
Description
CPSET
NPOS
–
Couple number at the NPOS-th
position in the current couple
set.
ICPTYPE
–
–
Current couple type.
MNPSET
–
–
Minimum couple number in
current couple set.
MXCOUPLE
–
–
Maximum couple number.
MXCPTYPE
–
–
Maximum couple table
number.
MXPSET
–
–
Maximum couple number in
current couple set.
Version 3.26
Chapter 2
PRO MODULE
Loops
Couple Related Items
(*GET, PARA, ITEM, NITEMA, NITEMB
Item
NITEMA
NITEMB
Description
NCPSET
–
–
Number of couples in current
couple set.
NCPTYPE
NCOUP
–
Couple type of couple number
NCOUP.
NMACELL
NCOUP
–
Master cell number of couple
NCOUP.
NMAFACE
NCOUP
–
Master face number of couple
NCOUP.
NSLAVES
NCOUP
–
Number of slaves in couple
NCOUP.
NSLCELL
NCOUP
ISLAV
Slave ISLAV cell number of
couple NCOUP.
NSLFACE
NCOUP
ISLAV
Slave ISLAV face number of
couple NCOUP.
Droplet Related Items
Version 3.26
Item
NITEMA
NITEMB
Description
DAGE
NDROP
–
Age of droplet NDROP.
DRACTIVE
NDROP
–
= 1 if droplet is active, 0 otherwise.
DRCOUNT
NDROP
–
Number of individual droplets
in droplet NDROP.
DRDENSITY
NDROP
–
Density of droplet NDROP.
DRDIAMETER
NDROP
–
Diameter of droplet NDROP.
DRMASS
NDROP
–
Mass of droplet NDROP.
DRSTUCK
NDROP
–
= 1 if droplet is stuck, 0 otherwise.
DRTEMP
NDROP
–
Temperature of droplet
NDROP.
DRVMAG
NDROP
–
Velocity magnitude of droplet
NDROP.
2-21
PRO MODULE
Chapter 2
Loops
Droplet Related Items
Item
NITEMA
NITEMB
Description
DRVX
NDROP
–
X-velocity of droplet NDROP.
DRVY
NDROP
–
Y-velocity of droplet NDROP.
DRVZ
NDROP
–
Z-velocity of droplet NDROP.
DRXC
NDROP
ICSYS
X-coordinate of centre of droplet NDROP in coordinate system ICSYS (default = current).
DRYC
NDROP
ICSYS
Y-coordinate of centre of droplet NDROP in coordinate system ICSYS (default = current).
DRZC
NDROP
ICSYS
Z-coordinate of centre of droplet NDROP in coordinate system ICSYS (default = current).
DSET
NPOS
–
Droplet number at the
NPOS-th position in the current droplet set.
IDTYPE
–
–
Current droplet type.
MNDSET
–
–
Minimum droplet number in
current droplet set.
MXDROPLET
–
–
Maximum droplet number.
MXDSET
–
–
Maximum droplet number in
current droplet set.
NDCELL
NDROP
–
Cell in which droplet NDROP
resides.
NDSET
–
–
Number of droplets in current
droplet set.
NDTYPE
NDROP
–
Droplet type of droplet
NDROP.
Plot Related Items
2-22
Item
NITEMA
NITEMB
Description
ANGLE
–
–
Plot angle.
Version 3.26
Chapter 2
PRO MODULE
Loops
Plot Related Items
Item
NITEMA
NITEMB
Description
/CNTX/CNTY/CNTZ/ –
–
Centre of last plot.
PDIST
–
–
Distance to centre of last plot.
/SXMIN/SXMAX/
–
–
Minimum/maximum X coordinate of current plot frame.
/SYMIN/SYMAX/
–
–
Minimum/maximum Y coordinate of current plot frame.
/VWX/VWY/VWZ/
–
–
Current viewing components.
Event Related Items
Version 3.26
Item
NITEMA
NITEMB
Description
EACELL
–
–
Total number of activated cells
in current event.
EATTACH
–
–
Total number of attached cells
in current event.
ECFLUID
–
–
Total number of cells with fluid
stream changes in current
event.
EDCELL
–
–
Total number of deactivated
cells in current event.
EDETACH
–
–
Total number of detached cells
in current event.
ERCELL
–
–
Total number of refined cells in
current event.
ETIME
–
–
Time of occurrence of current
event.
ETVALUE
–
–
Time value (time, degree, distance for piston expansion or
compression, as specified by
the EVSTEP command) of current event.
EVCURRENT
–
–
Current event number.
2-23
PRO MODULE
Chapter 2
Loops
Miscellaneous Pre-Processing Items
Item
NITEMA
NITEMB
Description
CASE
–
–
The current casename.
ICSYS
–
–
Current local coordinate system number.
MXCYCLIC
–
–
Maximum cyclic set number.
Post-Processing Related Items
Item
NITEMA
NITEMB
Description
ITER
–
–
Iteration number of currently
stored post data.
POST
IREG
NUMB
A post data value loaded into
any one of the six post data
registers. IREG is the post register number (1-6) and NUMB
is the cell or vertex number as
appropriate.
SCALE
–
–
The geometry scale factor in
the post file.
TIME
–
–
Time of currently stored post
data.
Summary Command Related Items
Item
NITEMA
NITEMB
Description
The following access the numbers found by issuing the SUMMARY command.
Note: The SUMMARY command does not actually have to be used to access any
of the variables below. IREG is the post data register number. Note: The post data
are scanned only for items in the current cell or vertex set.
LMAX
2-24
IREG
–
The cell or vertex number of
the maximum value of a post
data register.
Version 3.26
Chapter 2
PRO MODULE
Loops
Summary Command Related Items
Item
NITEMA
NITEMB
Description
LMIN
IREG
–
The cell or vertex number of
the minimum value of a post
data register.
RAVG
IREG
–
The average value of a post
data register.
RMAX
IREG
–
The maximum value of a post
data register.
RMIN
IREG
–
The minimum value of a post
data register.
RTOT
IREG
–
The total (summed) value of a
post data register.
Integrate Command Related Items
Item
NITEMA
NITEMB
Description
The following access the numbers found by issuing the INTEGRATE command:
TAREA
–
–
The total area cut by the
defined plane.
TAS
–
–
The sum of area * scalar (register 4) for the defined plane.
TAV
–
–
The sum of area * velocity normal to the defined plane.
TAVS
–
–
The sum of area * velocity normal to the defined
plane * scalar (register 4).
Graph Related Items
Item
NITEMA
NITEMB
Description
The following access numbers in the graph registers (IGREG is the graph register
number):
Version 3.26
2-25
PRO MODULE
Chapter 2
Loops
Graph Related Items
Item
NITEMA
NITEMB
Description
GAVG
IGREG
–
The average value of a graph
data register.
GMAX
IGREG
–
The maximum value of a graph
data register.
GMIN
IGREG
–
The minimum value of a graph
data register.
GNUM
IGREG
–
The number of values in a
graph register.
GRAPH
IGREG
ILOC
Data value stored in location
ILOC of graph register
IGREG.
GSUM
IGREG
–
The total (summed) value of a
graph data register.
*GOTO, LABEL: The *GOTO command may be used anywhere in a loop to jump
to another location. The LABEL must be defined within the loop and must start with
a colon (:). For example:
*DEFINE
: LAB
*SET A A + 1
*IF A GT 5 THEN
*GOTO DONE
*ENDIF
*GOTO LAB
: DONE
*END
*IF, PARA, TEST, PARA: Executes all commands between *IF and *ENDIF in
a loop only if the value of TEST is true. Multiple *IF/*ENDIF blocks may be used
in the same loop. Nested blocks may be used up to 10 deep.
2-26
Version 3.26
Chapter 2
PRO MODULE
Loops
PARA
– Either a predefined numeric parameter (defined using the ASK,
*SET or *GET commands) or any user-defined number.
TEST
– One of /EQ/NE/GT/GE/LT/LE/. All parameters are converted
to real numbers for the test.
Example in tutorial: 7.1, 7.2, 11.1 13.1
*LIST, OPTION: Lists the values of numeric parameters and/or lists the current
loop definition.
OPTION
– BOTH (default). Lists the values of all defined numeric
parameters and the loop.
– PARAM. Lists the values of all defined numeric parameters
only.
– PARAM NAME. Lists the value of the named numeric
parameter.
– MACRO. Lists the current loop definition only.
*LOOP, LSTART, LEND, LINC: Executes all the commands between *DEFINE
and *END. If any parameters have been used within the loop, then the value for each
parameter is VSTART + L*VINC, where L varies from LSTART to LEND by
LINC.
LSTART
– Starting value of loop counter.
LEND
– Ending value of loop counter.
LINC
– Increment of loop counter.
*MACRO, OPTION, MACNAM: Lists or executes commands from a macro file.
A macro file is defined as a file with a ‘.MAC’ extension and it may exist in any of
the following directory trees:
1. Current directory.
2. A predefined local macro directory.
3. A predefined global macro directory.
The macro directories can be preset either prior to starting the pro-STAR session or
via the SETENV command within pro-STAR.
Version 3.26
2-27
PRO MODULE
Chapter 2
Loops
OPTION
– LIST. Contents of a macro file will be listed. The name of the
macro file will be prompted for.
– EXECUTE. Commands within a macro file will be executed.
The name of the macro file will be prompted for.
MACNAM
– The name of the macro (without the ‘.MAC’ extension).
RPnnnn, INC1, INC2, …, INC10: Repeats the previous command nnnn
(2 < nnnn) times incrementing each field of that command by INC1 to INC10,
respectively. The first command instance is included in the count. nnnn may be
replaced by any user defined variable.
Note: If the previous command was one of CSET, VSET, BSET, BLKSET,
SPLSET, CPSET or DSET, then RPnnnn will change any NEWSET option
specified for these commands to ADD.
*SASK, PARA: Prompts the user to enter a string value for string parameter
PARA. Blanks, commas, and other string parameters are allowed in the string value.
If the string value is left blank, then the parameter will be deleted. See the *SSET
command for more information.
*SAVE, LF(case.loop): Saves the currently defined loop to an output file. The
loop can be reused at a later date by typing IFILE,LF to bring the loop back into the
program.
LF
– File name in which to save the loop definition.
*SCOPY, NPARA, SPARA, FORMAT(G13.6): Copies the current value of a
numeric parameter into a string parameter.
2-28
NPARA
– The name of an existing numeric parameter.
SPARA
– The name of a string parameter to which to copy the current
loop value of NPARA (i.e. the value of NPARA + (the loop
counter multiplied by the increment of NPARA)).
Version 3.26
Chapter 2
PRO MODULE
Loops
FORMAT
– A valid FORTRAN format specification for a single number
(for example: I4 or F5.2).
*SET, PARA, VSTART, VINC: Sets the value of a numeric parameter. The
parameter can then be used instead of any numeric field in any command. If any
arithmetic operator is used to define the parameter, a space must be inserted on
either side of the operator.
PARA
case-sensitive.
VSTART
– Initial value of the parameter.
VINC
– Increment to add to the parameter when within a loop.
Example in tutorial: 2.4, 7.1, 7.2, 7.5, 8.2, 8.3, 9.6, 11.1, 13.1, 15.1, 16.3
*SLIST, OPTION: Lists the values of string parameters and/or lists the current
loop definition.
OPTION
– BOTH (default). Lists the values of all defined string
parameters and the loop.
– PARAM. Lists the values of all defined string parameters only.
– PARAM NAME. Lists the value of the named string
parameter.
– MACRO. Lists the current loop definition only.
*SSET, PARA, STRING: Sets the value of a string parameter.
PARA
case-sensitive.
STRING
– A string value to assign to the parameter PARA. STRING may
include blanks and other string parameters. If STRING is left
blank, then the parameter will be deleted.
The parameter may be used in any place in a command line (or for any string
prompt, such as for the TITLE or PLLABEL commands), enclosed with curly
Version 3.26
2-29
PRO MODULE
Chapter 2
Loops
braces. pro-STAR will replace any brace-enclosed string parameter with the
user-defined value. For example, if only the following string parameters are set:
*SSET
*SSET
*SSET
*SSET
*SSET
CHAR1
CHAR2
CHAR3
CHAR4
CHAR5
NEWSET
CSET
CSET NEWSET
SET
file
then the parameters can be used as in the simple examples below:
Command
Interpreted As
CSET {CHAR1} FLUID
{CHAR2} {CHAR1} FLUID
{CHAR3} FLUID
C{CHAR4} NEWSET FLUID
RESUME test_{CHAR5}a.mdl
CSET NEWSET FLUID
CSET NEWSET FLUID
CSET NEWSET FLUID
CSET NEWSET FLUID
RESUME test_filea.mdl
Note that the following commands will NOT be changed (the last one because string
parameter CHAR6 has not been set):
Command
CSET {CHAR1 FLUID
CSET CHAR1} FLUID
{CHAR2 CHAR1} FLUID
CSET {CHAR6} FLUID
2-30
Version 3.26
Chapter 3
MESH MODULE
Miscellaneous
Chapter 3
MESH MODULE
Miscellaneous
CDIRECTION, NCELL, NVORIG, NVI, NVJ, NVK: Specifies I, J, K directions
to reorder vertices or subdivide cells.
NCELL
– Cell number to use as the basis for defining the direction.
NVORIG,
NVI, NVJ,
NVK
– Vertices in cell NCELL.
– NVORIG to NVI defines direction I.
– NVORIG to NVJ defines direction J.
– NVORIG to NVK defines direction K.
Any two directions suffice to define I, J, K. If NV1 is not
specified, the I, J, K directions of cell NCELL will be used.
Direction I is the direction with the least vertex number
variation. Direction K is the direction with the greatest vertex
number variation.
CHECK, NC1(ALL), NC2, OPTION, SETOPTION: Provides several different
checks on the model geometry. The output from each check is placed into the
post-processing registers and is therefore available for contour plotting.
Version 3.26
NC1, NC2
– Checks only cells between NC1 and NC2. NC1 can be
replaced with ALL or CSET.
OPTION
– ALL (default). Invokes all checks listed below, using the
default parameters for each.
– AREAFACE,AREAOPT. Computes all the face areas of each
cell and performs one of the following two checks:
– AREAOPT.
– RATIO,RVAL(0.2). Checks for cells for which the ratio of
the smallest face area to the largest face area is less than
RVAL (this is the default AREAOPT). Shells, baffles, line
cells, and point cells are not checked with this AREAOPT.
– VALUE,AVAL(1.0E-5). Checks for cells with at least one
face area less than AVAL. Line and point cells are not
checked with this AREAOPT.
3-1
MESH MODULE
Chapter 3
Miscellaneous
Command: C , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8
7
8
6
5
3
4
1
2
Figure 3-1
OPTION
3-2
Right-handed cell definition
– ASPECT,RATIO(10.). Checks fluid and solid cells for aspect
ratios greater than RATIO. The aspect ratio is the ratio of the
length of the longest to the shortest side on each cell face (see
Figure 3-2).
– CENTROID,CHECKOPT. Checks the location of cell
centroids.
– CHECKOPT.
– BOTH (default). Invokes both of the following two checks.
– OUT. Checks for any cells whose centroid resides outside
the volume of the cell.
– IN. Checks for any cell whose centroid falls within the
volume of another cell. This check is useful for finding
cells whose volumes improperly overlap each other. This
check can be very time-consuming for large cell sets.
– CONCAVE. Checks fluid and solid cells for concavities.
– CONNECTIVITY. Checks the cell connectivity of fluid and
solid cells within the specified range. pro-STAR will first flag
as an error any cell face in the range that is both in a couple
and connected to another cell. If no cells fail that check,
pro-STAR will then search the range for disjoint groups of
cells. Each disjoint group will be given a different ‘group
number’ that is stored in post register 4, thus allowing the user
to select and/or contour plot the various connected groups.
– CRACK,DELTA(0.001). Checks for cracks in the model. This
is done by extruding the centroid of every free surface in the
cell range by DELTA and checking to see if it falls within any
other cell.
Version 3.26
Chapter 3
MESH MODULE
Miscellaneous
φ
b
θ
a
b/a = aspect ratio
Figure 3-2
OPTION
Version 3.26
θ = internal angle
φ = warp angle
Cell distortion definition
– DBCI. Checks for regions being present in more than one
coupling interface. SETOPTION will be ignored.
– DBLCELL. Checks for the same cell defined more than once
(double cells). Also checks that the vertices and cell table
entries are defined and valid for each cell checked.
– DBLVERTEX. Checks cells for illegal use of the same vertex
more than once (double vertices).
– FACECOLLAPSE. Checks cells for illegal face collapses (bad
definition of cells).
– INTFACE,ANGLE(45.),ANGOPT. Checks fluid and solid
cells for internal angles [angles made between two adjacent
faces in a cell (see Figure 3-2)] that are outside the range of
90˚ ANGLE.
– ANGOPT.
– BOTH (default). Reports all angles outside the range (that
is, less than (90–ANGLE) degrees and more than
(90+ANGLE) degrees) are reported.
– SMALLER. Reports only angles less than (90–ANGLE)
degrees.
– LARGER. Reports only angles more than (90+ANGLE)
degrees.
– NEGVOL,VOLUME(0.0). Checks fluid and solid cells for
negative volumes (volumes less than VOLUME). The volumes
are calculated in the same manner as in STAR. All cells in
STAR must be defined such that the volumes are positive.
Negative volumes are often an indication of left-handed cells.
3-3
MESH MODULE
Chapter 3
Miscellaneous
OPTION
– RIGHTHAND. Checks fluid and solid cells for
right/left-handed definitions. Right-handedness can be
calculated in a number of ways, occasionally yielding
different results for the same cell. STAR requires only that
cells must have positive volumes, which in turn assumes that
cells are right-handed. However, it is possible that a cell can
be seen as left-handed and still have a positive volume. This
situation is usually an indication that the cell is highly
skewed (see Figure 3-1).
– TETQUALITY,THRESHOLD(0.10). Compares the volume
of each tetrahedron in the given cell range with that of a
regular tetrahedron whose vertices lie on the same sphere as
that defined by the actual tetrahedron’s vertices. Outputs a
number from 0.0 to 1.0 for each tetrahedron in the given cell
range, with a number close to 1.0 meaning that the
tetrahedron is nearly regular in shape.
– WARP,ANGLE(45.). Checks fluid and solid cells for face
warpages greater than ANGLE. Face warpage is defined as
the angle made between the normals of each half of a cell
face. Warpage can vary between 0˚ and 90˚ (see Figure 3-2).
– SEVERE. Invokes checks for items which will cause failures
in the writing of geometry and problem files. These checks
are: DBLVERTEX, DBLCELL, NEGVOL, CENTROID and
CRACK. The defaults will be used for each of the checks.
SETOPTION
– NOSET. The cell set is not altered by this command.
– NEWSET. The program will form a new cell set out of all the
cells that do not pass the check option specified above. Note
that ‘NEWSET’ is not a valid parameter when using the
‘SEVERE’ or ‘ALL’ options.
The defaults for aspect ratio and angles used in these checks are simply defaults.
Good results have been achieved in models with cells far outside the ranges given
here. Users should decide for themselves how much distortion from perfectly
regular cells is allowable.
EXIT: Returns to PRO module.
HELP, OPTION
or
HELP, COMMAND: Displays the command set for each option or displays more
3-4
Version 3.26
Chapter 3
MESH MODULE
Extrusion Mesh Commands
OPTION
– /ALL/VERT/COORD/CELL/MISC/.
RESTRUCTURE, NVSTART(MAXV+1), ROPTION, INCOPT, COPTION:
Reorders vertices attached to the current cell set (on the basis of connectivity) into
a structured order and optionally renumbers the redefined vertices in other cells,
splines and blocks. The current cell set must correspond to a structured scheme
(i.e. there should be no transition zones) although holes (non-existing cells) are
permitted. The I, J, K directions must be specified by a prior issue of the
CDIRECTION command. Only the model region corresponding to the set of
eight-noded hexahedral cells contained in the current cell set will be reordered.
NVSTART
– Starting vertex number for the reordered mesh.
ROPTION
– REPLACE. Redefined vertices in other cells, splines and
blocks will be replaced.
– NOREPLACE. Cells outside the current cell set, spline set and
block set will have their original vertices.
INCOPT
– DEFAULT,INCI,INCJ,INCK. Either default (program
calculated) or specified increments INCI, INCJ and INCK in
the I, J and K directions will be used.
– PROMPT. Increments will be prompted for (the best available
increments will be disclosed).
Direction I is the direction with the least vertex variation.
Direction K is the direction with the greatest vertex variation.
INCJ must be at least INCI*(NI+1)– INCK must be at least
INCJ*(NJ+1), where NI, NJ and NK are cells in the I, J and K
directions.
COPTION
– NORENUMBER. Cells will not be renumbered.
– RENUMBER,NCSTART(MAXC+1). Cells in the reordering
scheme will be renumbered in structured order starting from
NCSTART. NCSTART must be greater than the maximum
defined cell number in the model.
CBEXTRUDE, ICTID, DT, NC1(1), NC2(NC1), NCINC(1), DOPTION:
Extrudes baffles and shells into solid cells. This command is intended for setting up
a conjugate heat transfer problem with conduction through baffles. Baffle
Version 3.26
3-5
MESH MODULE
Chapter 3
boundaries on extruded shells or baffles will be extruded into two new wall
boundaries, one on either side of the new solid cell. New cell numbers will start at
the maximum defined cell number plus one. New boundary numbers will start at the
maximum defined boundary number plus one. New boundary region numbers will
start at the maximum defined boundary region number plus one. Only three-sided
and four-sided baffles and shells can be extruded.
ICTID
– Cell table of the solid cells created. This may be a currently
defined solid cell table, a currently undefined cell table or left
blank. If currently undefined, then it will be defined as a solid
type. If left blank, then the next available cell table will be
defined as a solid type and used for the new cells.
DT
– Thickness to which the baffles and shells will be extruded.
Each baffle or shell will be extruded by DT/2 in the direction
normal to each of its face. Baffle and shell edges that are not
shared by any other baffles or shells, as well as edges that are
shared by more than two baffles or shells, will not be extruded,
thereby creating tapered solid cells. If a 0 or blank is entered,
the minimum possible thickness (to avoid merging of the
resulting cell’s vertices using the default tolerance) will be
assumed.
NC1, NC2,
NCINC
– Searches cells NC1 to NC2 by NCINC for the baffles and
shells to extrude, as well as for the fluid cells that are attached
to the baffles and shells. Every baffle and shell in the range
must be between two fluid cells in the range. NC1 may be
replaced with ALL or CSET.
DOPTION
– DELETE (default). Deletes the original baffles, shells and
baffle boundaries that are extruded.
– NODELETE. Does not delete the baffles, shells or boundaries.
PATCH, NV1, NV2, NV3, NV4, NCI, NCJ, NVINCI, NVINCJ, NVSTART,
CREOPT, ICSRF(0), NITER(0), TOL(.0001), RLXF(.9), RATIOI(1.),
RATIOJ(1.): Creates a (structured) surface bounded by up to four splines. The
surface consists of vertices and shell cells (see Figure 3-3). Any edge not contained
in a spline reverts to a straight line between two corners. Edges can span entire
splines or only parts of them. Any discontinuous (negative) vertices on an edge
spline will be treated as a fixed point. Newly created shells are given the reference
number (ICTID) of the currently active cell type.
3-6
NV1, …,
NV4
– ID numbers of four corner vertices.
NCI
– Number of cells in the I direction (parallel to NV1-NV2).
Version 3.26
Chapter 3
MESH MODULE
NCJ
– Number of cells in the J direction (parallel to NV1-NV4).
NVINCI,
NVINCJ
– Increments between adjacent vertices in the I and J directions,
respectively.
NVSTART
– Vertex number of lowest numbered vertex in patch (I = J = 1).
CREOPT
– BOTH. Creates both cells and vertices.
– VERT. Creates vertices only.
– CELL. Creates cells only.
ICSRF
– If ICSRF is non-zero, then the interior vertices are projected to
the surface defined by shells of type ICSRF after the
orthogonalising pass (if any).
NITER
– If NITER > 0, then a routine is called to attempt to
orthogonalise the newly created mesh. This routine also tends
to flatten out the surface (if curved) and is best used on planar
patches. It may, however, be used in conjunction with ICSRF
to smooth and place vertices onto a curved surface
simultaneously.
TOL, RLXF – Tolerance and under-relaxation factor to apply to the
orthogonaliser. These are ignored if NITER = 0.
RATIOI,
RATIOJ
– Each successive space between new vertices is RATIO x the
previous space. Use ratio = 1.0 (default) for linear (even)
spacing. If RATIO < 0 then use accordion fill (i.e. spacing
increases to middle of fill and then decreases again to reach the
second point. RATIOI determines spacing in the I (NV1 to
NV2) direction, while RATIOJ determines spacing in the J
(NV1 to NV4) direction.
NV4
j
NV3
NV1
i
NV2
Before
Figure 3-3
Version 3.26
After
Patch definition using command PATCH
3-7
MESH MODULE
Chapter 3
REEXTRUDE, NV1(1), NV2(NV1), NVINC(1),/ICTYPE or NC1(1),
NC2(NC1), NCINC(1)/, /NORMAL,DT/ or /LOCAL,DX,DY,DZ/ or
/EXISTING,DT/, /RATIO(1): Moves a set of vertices and cells by extruding all
the vertices attached to the back faces of the given vertices (see Figure 3-4)
NV1, NV2,
NVINC
– The list of vertices on the starting surface layer.
ICTYPE
– Cells of the type ICTYPE will be moved. Type ICTYPE must
exist in the cell table.
NC1, NC2,
NCINC
– The list of cells. The vertices of these cells will be re-extruded.
NORMAL,
DT
– Vertices are generated normal from the surface defined by the
vertices in the current vertex set. Each layer is DT away from
the previous layer.
LOCAL, DX, – Vertices are generated by offsetting each layer DX, DY, DZ
DY, DZ
away from the previous layer. The offsets are interpreted in the
currently active local coordinate system.
EXISTING,
DT
– Vertices are generated in the existing direction. DT is the total
thickness of all the extruded layers.
RATIO
– Specifies the spacing of the extruded cell layers.The default
ratio is 1.0, i.e. uniform spacing.Values of less than 1 on DT,
DX, DY or DZ would concentrate the layers on the far end,
while values above 1 would have the same effect on the inner
end.
Before
After
Figure 3-4
3-8
Example of mesh re-extrusion
Version 3.26
Chapter 3
MESH MODULE
VCEXTRUDE, NSET(1), NVOFF(MINI), NC1(1), NC2(NC1), NCINC(1),
/NORMAL, DT, NVREF/LOCAL, DX, DY, DZ/, /BOTH/CELL/VERTEX/,
/UNIFORM/NON UNIFORM, TOTDIST(1.0)/: Creates a set of vertices and/or
cells by extruding all the vertices attached to a given pattern of shell, baffle, line or
point cells (see Figure 3-5).
NSET
– Number of layers of new cells to generate. If NSET is equal to
1, then the surface is extruded into a layer that is one cell thick.
NVOFF
– Offset to apply to all the vertices in the surface layer to create
each new layer. By default, the minimum allowable vertex
offset will be used.
NC1, NC2,
NCINC
– The starting surface layer is defined by cells NC1 to NC2 by
NCINC. NC1 may be replaced by ALL, CSET or CCRS.
Shells and baffles in the starting set will be extruded into fluids
or solids. Lines in the starting set will be extruded into shells or
baffles. Points in the starting set will be extruded into lines.
Fluids and solids in the starting set will not be extruded. The
new cells will be given the currently active cell table number
whenever possible. Otherwise, new cell tables will be created
using the first available cell table numbers.
NVREF
DT
Starting cell surface
Figure 3-5
VCEXTRUDE command illustration
Pick one of the following two options:
1. NORMAL,DT,NVREF — Vertices are generated normal from the given
Version 3.26
3-9
MESH MODULE
Chapter 3
Block Mesh Commands
surface. Each layer is DT away from the previous layer unless the nonuniform
option is used. The normal direction used is the one which points closest to
the vertex NVREF. If NVREF = 0, then the normal direction used is
determined by the normal (using the right hand rule) of each individual shell.
If the nonuniform option is used, then DT is the fill ratio.
2. LOCAL,DX,DY,DZ — Vertices are generated by offsetting each layer DX,
DY, DZ away from the previous layer unless the nonuniform option is used.
The offsets are interpreted in the currently active local coordinate system. If
the nonuniform option is used, then DX, DY, DZ are the fill ratios.
If the nonuniform option is used, then values of less than 1 on DT, DX, DY, or
DZ would concentrate the layers on the far end, while values above 1 would
have the same effect on the inner end. Values of 1 will return uniform spacing.
/BOTH/CELL/
/VERTEX/
– The user can decide whether to generate either cells
only, vertices only or both cells and vertices.
/UNIFORM/
/NONUNIFORM,
TOTDIST/
– Specifies the spacing of the extruded cell layers. The
default UNIFORM spacing would be as described
above. For the NONUNIFORM option, the spacing
would be similar to the VFILL command. The last
argument is the total distance from the initial cell layer
to the outer layer of the extrusion. For a default value of
1.0, the outer layer remains unbounded.
Block Mesh Commands
2D3D, OPTION: Takes a two-dimensional shell model built in the X-Y plane and
creates a three-dimensional ready model using one of the following methods:
OPTION
– CARTESIAN. The shells are turned into fluid cells with a
constant thickness in the Z direction equal to 10% of the
maximum model dimension. Symmetry boundaries are created
and applied to the +Z and –Z faces of all cells.
– AXISYMMETRIC. The shells are turned into fluid cells with a
5 degree arc in tangential direction. The X axis is treated as the
radial direction and the Y axis is the axial direction. Cyclic
boundaries are created and applied to the +Z and –Z faces of
all cells. Cyclic matches are also created between the two
cyclic faces.
BLK, NBLK, NV1, NV2, …, NV8: Defines the corner vertices for a mesh block
3-10
Version 3.26
Chapter 3
MESH MODULE
Block Mesh Commands
(see Figure 3-6). Any edge that lies partially or totally on a spline will include that
part of the spline in the mesh generation.
NBLK
– Arbitrary block reference number.
NV1, NV2,
…
– Corners 1 to 8, respectively.
8
7
5
6
4
k
1
3
j
i
2
Figure 3-6
i direction: 1 → 2
j direction: 1 → 4
k direction: 1 → 5
Mesh block definition
BLKCELL, NBLK(1), NC1(1), NC2(NC1), NCINC(1), OPTION: Defines
blocks from existing cell definitions.
NBLK
– Block number to start the generation.
NC1, NC2,
NCINC
– Blocks will be defined at cells from NC1 to NC2 in increments
of NCINC.
OPTION
– /NODELETE/DELETE/. The delete option will delete selected
cells.
BLKDELETE, NBLK1(1), NBLK2(NBLK1), NBLKINC(1): Deletes
definitions for mesh blocks.
Version 3.26
3-11
MESH MODULE
Chapter 3
Block Mesh Commands
NBLK1,
NBLK2,
NBLKINC
– Deletes information for blocks NBLK1 to NBLK2 by
NBLKINC.
BLKEXECUTE, NBLK1(1), NBLK2(NBLK1), NBLKINC(1), OPTION:
Creates the vertices and cells associated with a range of mesh blocks. The blocks
must be predefined with the BLK and BLKFACTOR commands as necessary. If
NVSTART and/or NCSTART is 0 for any block, then the block will begin at the
next highest vertex or cell location. If not 0, the block will begin at the indicated
location and overwrite any pre-existing vertex/cell definitions.
NBLK1,
NBLK2,
NBLKINC
– Creates the meshes for blocks NBLK1 to NBLK2 by
NBLKINC.
OPTION
– LIST. A summary of each meshed block will be written to the
output file.
– NOLIST. Only error messages will be written to the output
file.
BLKFACTORS, NBLK, NCI(1), NCJ(1), NCK(1), INCI(1),
INCJ((NCI+1)*INCI), INCK((NCJ+1)*INCJ), RI(1.), RJ(1.), RK(1.),
ICTID(1), NVSTART(MAXVERT+1), NCSTART(MAXCELL+1)
or
BLKFACTORS, NBLK, RESET: Defines the pertinent fill factors for a given
mesh block. These factors include number of cells and vertex increments in each
direction, spacing factors in each direction and the starting vertex and cell number.
If the starting vertex and/or cell number is left blank and the block is being executed
for the first time, then the new vertices/cells generated for the block will begin after
the highest defined vertex or cell at BLOCK EXECUTION time. If the block is
being regenerated and the starting vertex/cell numbers are blank (defaulted), then
the new cells and vertices will be created at the same location, if possible
(i.e. provided that the total number of new cells is less than or equal to the total
number generated by the previous BLKEXE use). Otherwise, pro-STAR will place
the new cells/vertices at the end of the current cell/vertex list.
NBLK (or
BLKSET)
3-12
Version 3.26
Chapter 3
MESH MODULE
Block Mesh Commands
NCI, NCJ,
NCK
– Number of cells in the I, J and K directions respectively.
Direction I is from vertex 1 to vertex 2. Direction J is from
vertex 1 to vertex 4. Direction K is from vertex 1 to vertex 5.
INCI, INCJ, – Vertex increments to be applied in the I, J and K directions
INCK
respectively. INCI must be less than INCJ which must be less
than INCK.
RI, RJ, RK
– Spacing factors in the I, J and K directions, respectively. If Rn
is greater than 0, each cell will be Rn its preceding neighbour
in length. If Rn is less than 0, each cell will be ABS(Rn) × its
neighbour up to the centre and then 1./ABS(Rn) back to the
second side.
ICTID
– Cell type to assign to cells in this block.
NVSTART
– Starting vertex number for this mesh block. Use of a number
here (other than zero) will override the default behaviour
described above.
NCSTART
– Starting cell number for this mesh block. Use of a number here
(other than zero) will override the default behaviour described
above.
If the RESET option is used, all data for this block except for the corner vertex
numbers are reset to 0.
BLKGENERATE, NSET, NVOFF, NBLK1, NBLK2, NBLKINC: Creates a
new set of mesh block definitions by applying an offset to the vertices of a
predefined set. The meshing factors of the original set are duplicated in the new sets.
NSET,
NVOFF
– Generates NSET groups incrementing all vertices by NVOFF.
The initial set is included in the NSET count.
NBLK1,
NBLK2,
NBLKINC
– Initial set defined by NBLK1 to NBLK2 by NBLKINC.
BLKLIST, NBLK1(1), NBLK2(NBLK1), NBLKINC(1): Lists definitions for
mesh blocks.
Version 3.26
3-13
MESH MODULE
Chapter 3
Block Mesh Commands
NBLK1,
NBLK2,
NBLKINC
– Lists information for blocks NBLK1 to NBLK2 by
NBLKINC.
BLKMODIFY, NBLK, NVP1, NVP2, …: Modifies any of the vertex definitions
for a predefined mesh block. If any vertices are specified as equal to zero, then the
vertex definition for that location will remain unchanged.
NBLK
NVP1, NVP2, – New vertex definitions for the mesh.
…
BLKTRACE, NBLK, NV1, NV2, DIVOPTION, RATIO(1.0), OVERIDEOPT:
Traces block factors defined along an edge of one block throughout the current
block set.
NBLK
– Starting block number.
NV1, NV2
– Vertices defining an edge of block NBLK. If
NV1 = NV2 = 0, then the factors for all three edges of block
NBLK are propagated.
DIVOPTION
– BYDIVI,NCELL. The number of cells along the indicated
edge is NCELL. If NCELL = 0, then the existing number of
cells along this edge is used.
– BYSIZE,RLEN(1.). The number of cells along the indicated
edge is determined by the edge length/RLEN.
RATIO
– Filling ratio.
OVERIDEOPT – NO. The tracing function will not override any pre-existing
values for cell divisions in a given block.
– YES. The tracing function will force every block found to
have the same cell division structure, regardless of any prior
definitions.
BLKWALL, NBLK, IFACE1, ICT1, IFACE2, ICT2, …, IFACE6, ICT6
3-14
Version 3.26
Chapter 3
MESH MODULE
Block Mesh Commands
or
BLKWALL, NBLK, RESET: Assigns shell cell IDs to block faces for mapping.
When the block is created, each face may be mapped (projected) onto a different
shell surface.
NBLK
– Arbitrary block reference number (or BLKSET).
IFACE1,
ICT1
– Up to six pairs of face number, shell ID (ICTID) may be
assigned to each block. Using an ICT1 = 0 for any face
removes the mapping association for that face.
If the RESET option is used, then all faces for this block are set to 0 (all mapping
associations removed).
MORTHO, NCI, NCJ, NCK, NVINCI, NVINCJ, NVINCK, NVSTART,
NITER(50), TOL(.0001), RLXF(.9)
or
MORTHO, BLOCK, NBLK, NITER, TOL, RLFX: Runs an elliptic
orthogonaliser on a predefined (structured) meshed surface or volume in order to
improve the quality of cells with poor internal angles and/or warpages. This
function tends to flatten out non-planar surfaces, so the user may need to force or
map vertices back to their original surfaces after using MORTHO. Alternatively,
vertices that should not be moved can be collected in a VSET prior to using
MORTHO. If applied to a volume, it moves only vertices on the interior, leaving the
surface definitions intact.
NCI, NCJ,
NCK
– Number of cells in the local I, J and K directions, respectively,
for the surface or volume currently being manipulated.
NVINCI,
NVINCJ,
NVINCK
– Increments between adjacent vertices in the I, J and K
directions, respectively.
NVSTART
– Vertex number of lowest vertex in volume (I = J = K = 1).
BLOCK,
NBLK
– NBLK is the block number of the volume to be manipulated.
NITER
– Number of iterations to perform.
TOL, RLXF – Tolerance and under-relaxation factor to apply to the
orthogonaliser.
VC2DGEN, X1, X2, NCX(0), Y1, Y2, NCY(0), NVSTART(MAXV+1),
Version 3.26
3-15
MESH MODULE
Chapter 3
Block Mesh Commands
NCSTART(MAXC+1): Creates a plane of vertices and shells at the same time. The
plane extends from X1 to X2 and Y1 to Y2 where X and Y are all interpreted in the
currently active local coordinate system. The shells are given the currently active
cell type.
X1, X2, Y1, – Coordinates defining the extent of the plane interpreted in the
Y2
NCX, NCY
– Number of shells in the X and/or Y directions, respectively.
NVSTART,
NCSTART
– Starting vertex and cell number, respectively, from which to
start the generation of this plane.
VC3DGEN, X1, X2, NCX(1), Y1, Y2, NCY(1), Z1, Z2, NCZ(1),
NVSTART(MAXV+1), NCSTART(MAXC+1): Creates a block of vertices and
cells at the same time. The block extends from X1 to X2, Y1 to Y2, Z1 to Z2, where
X, Y and Z are all interpreted in the currently active local coordinate system (see
Figure 3-7). The user can create a model using several blocks, but must remember
to use the VMERGE command to join blocks together on their boundaries. The cells
are given the currently active cell type.
Z1
Z2
Y2
Y
Y1
X1
X2
X
NCX = 4
NCY = 3
NCZ = 2
Z
Figure 3-7
VC3DGEN command illustration
X1, X2, Y1, – Coordinates defining the extent of the block interpreted in the
Y2, Z1, Z2
3-16
Version 3.26
Chapter 3
MESH MODULE
Local Coordinate Commands
NCX, NCY,
NCZ
– Number of cells in the X, Y and Z directions, respectively.
NVSTART,
NCSTART
– Starting vertex and cell number, respectively, from which to
start the generation of this block.
Example in tutorial: 1.1, 2.1, 5.1, 6.1, 7.1, 7.3, 7.4, 8.1, 9.1, 10.1, 11.1, 14.1,
14.2, 15.1, 16.1, 16.2, 16.3, 17.1
CLOCAL, ICSYS, SYSTEMTYPE, XL, YL, ZL, ROTXY, ROTYZ, ROTZX,
RMAJOR: Defines a local coordinate system using coordinates in the currently
active coordinate system.
ICSYS
– Arbitrary system reference number in the range
4 ≤ ICSYS < 100. This should not be the currently active
coordinate system.
SYSTEMTYPE – /CARTESIAN/CYLINDRICAL/SPHERICAL/
/TOROIDAL/.
XL, YL, ZL
– Local coordinates of system origin in the currently active
coordinate system.
ROTXY,
ROTYZ,
ROTZX
– Right-handed rotations about each axis (in degrees) to
define the axis direction.
RMAJOR
– For toroidal systems only, the major radius.
CSDELETE, ICSYS1, ICSYS2, ICSINC: Deletes user-defined coordinate
systems ICSYS1 to ICSYS2 by ICSINC.
Note: Coordinate systems 1, 2 and 3 cannot be deleted.
CSDIR, DOPTION: Changes the calculation of angles in local non-Cartesian
coordinate systems from –180/+180 to 0/360 degrees or vice versa. By exercising
this option the user can force FILL commands to fill through 0 degrees or 180
degrees in the local coordinate system — see Figure 3-8. If the desired fill arc
defined by the two selected vertices (see command VFILL) contains both 0 and 180
degrees, the BOTH option must be selected otherwise the smaller arc containing
Version 3.26
3-17
MESH MODULE
Chapter 3
neither 0 or 180 degrees will be filled.
Command: VFILL , 2 , 1 , 5 , 10 , 10 , 1 , 1 , 1
30
y
y 40
1
50
20
r
10
θ
θ = 180
2
x
1
2
x
40
10
CSDIR , 180
50
r
30
20
Figure 3-8
θ=0
θ
CSDIR , 0
Switching the direction of angular change via CSDIR
DOPTION
– 0. Local non-Cartesian coordinate system is defined from –180
to +180 degrees. FILLS pass through 0 degrees.
– 180. Local non-Cartesian coordinate system is defined from 0
to 360 degrees. FILLS pass through 180 degrees.
– FLIP. Toggles the DOPTION between 0 and 180.
– BOTH. Local non-Cartesian coordinate system is defined from
0 to 360 degrees. FILLS pass through both 0 and 180 degrees.
CSLIST, ICSYS1(1), ICSYS2(ICSYS1), ICSINC(1): Lists attributes of
predefined local coordinate systems.
ICSYS1,
ICSYS2,
ICSINC
– Lists coordinate systems ICSYS1 to ICSYS2 by ICSINC.
CSYS, ICSYS(1): Sets the currently active coordinate system.
ICSYS
– Coordinate system number.
Example in tutorial: 2.1, 3.1, 4.1, 5.1, 7.1, 7.2, 7.3, 7.4, 9.1, 9.5, 13.1, 14.2, 17.2
LOCAL, ICSYS, SYSTEMTYPE, XC, YC, ZC, ROTXY, ROTYZ, ROTZX,
3-18
Version 3.26
Chapter 3
MESH MODULE
RMAJOR: Defines a local coordinate system.
ICSYS
– Coordinate system, which must be from 4 to 99. Numbers
1, 2 and 3 are reserved for the global Cartesian, global
cylindrical and global spherical systems, respectively.
/TOROIDAL/. (see Figure 3-9, Figure 3-10, Figure 3-11
and Figure 3-12).
Y
M(x,y,z)
M
y
0
X
z
x
Z
Figure 3-9
Cartesian coordinate system definition
Y
Underlying Cartesian system
r
θ
0
z
X
M
M(r,θ,z)
Z
Figure 3-10
Version 3.26
Cylindrical coordinate system definition
3-19
MESH MODULE
Chapter 3
Y
θ
0
r
X
φ
M
M(r,θ,φ)
Z
Figure 3-11
Spherical coordinate system definition
Y
r
φ
R
θ
M
0
M(r,θ,φ)
Parameter = R
Z
Figure 3-12
Toroidal coordinate system definition
XC, YC, ZC – Global coordinates of the origin of the coordinate system (see
Figure 3-13).
3-20
ROTXY,
ROTYZ,
ROTZX
– Right-handed rotations about each axis (in degrees) to define
axis direction (see Figure 3-13).
RMAJOR
Version 3.26
Chapter 3
MESH MODULE
YG
Y″′,YL
Y′
Y″
2
XL
X″,X″′
ROTATION
1 ROTXY about Z′
2 ROTYZ about X″
3 ROTZX about Y″′
O′
1
3
Z′,Z″
Z″′
X′
Final local Cartesian
coordinates XL, YL, ZL
ZL
TRANSLATION
to
O′
O
(X′,Y′,Z′)
(XG,YG,ZG)
O
XG
ZG
Figure 3-13
Local coordinate translations and rotations
VLOCAL, ICSYS, SYSTEMTYPE, NVORIG(0), AXIS1, NV1, AXIS2, NV2,
RMAJOR: Defines a local coordinate system using three predefined vertices.
ICSYS
– Coordinate system, which must be from 4 to 99. Numbers
1, 2 and 3 are reserved for the global Cartesian, global
cylindrical and global spherical systems, respectively.
/TOROIDAL/.
Version 3.26
NVORIG
– Vertex that defines the origin of the coordinate system. If
NVORIG = 0, then the origin is at the global origin (0,0,0).
AXIS1
– /X/Y/Z/.
NV1
– AXIS1 runs from NVORIG to NV1.
AXIS2
– /X/Y/Z/.
3-21
MESH MODULE
Chapter 3
Vertex Commands
NV2
– Vertices NVORIG, NV1 and NV2 provide three points
defining the AXIS1-AXIS2 plane (see Figure 3-14).
RMAJOR
Axis 1 = XL
YG
Axis 2 = YL
NV2
NV1
NVORIG
Axis 3 = ZL
XG
Axis 3 = Axis 1 × Axis 2
ZG
Figure 3-14
Local coordinate definition using three vertices
Vertex Commands
REPROJECT, NV1(1), NV2(NV1), NVINC(1), NC1(1), NC2(NC1),
NCINC(1), ICTYPE, POPTION, DISTM(1.E30), DISTE(0), DT(0),
RATIO(1.0): Projects vertices onto a shell surface. The vertices will travel along
the normal direction to the shell surface. Depending upon the POPTION, the cells
attached to vertices in the current vertex set will be re-extruded in the normal
direction to the shell surface or along the exact same direction line as already existed
(see Figure 3-15).
3-22
NV1, NV2,
NVINC
– The list of vertices to be projected.
NC1, NC2,
NCINC
– The list of cells. The vertices of these cells will be reprojected.
ICTYPE
– Cells of the type ICTYPE will be moved. Type ICTYPE must
exist in the cell table.
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
POPTION
– NORMAL. Moves the next layer of vertices normal to the
current layer vertices (VSET).
– EXISTING. Moves the next layer of vertices keeping the
orientation of an edge from one layer to the next layer the
same.
DISTM
– Absolute limit on distance moved. Any vertex projected farther
than this distance will not be moved or created.
DISTE
– Any face (cell) that has a vertex that has moved more than a
DISTM will be re-extruded.
DT
– Total thickness of all the extruded layers. If DT is zero, the
original thickness of the extruded layers will be maintained.
RATIO
– Thickness ratio between adjacent cell layers.The default ratio
is 1.0 (i.e. uniform spacing).Values of less than 1.0 on DT, DX,
DY or DZ would concentrate the layers on the far end, while
values above 1.0 would have the same effect on the inner end.
Before
After
Vertex set
Shell surface
Figure 3-15
Projecting vertices and cells onto a surface using REPROJECT
UNSKEW, DIST: This command is typically used to decrease the internal angles
of surface cells. For each cell in the current CSET, UNSKEW finds the corner
vertex of the three most coplanar faces of the hexahedron (vertex with the highest
sum of the face angles) and moves that point a specified distance in order to reduce
the internal angles. The direction of movement is perpendicular to the plane formed
by the three adjacent vertices. Vertices in the current VSET are not moved.
Version 3.26
3-23
MESH MODULE
Chapter 3
Vertex Commands
DIST
– The amount to move a given vertex. If DIST is 0, then a default
distance based on the characteristic length of the cell is used.
The maximum allowable distance moved is equal to the
minimum distance between any two vertices in the cell.
UNWARP, NC1(1), NC2(NC1), NCINC(1), ANGLE(45.), ITER(10),
DIST(0.001), RELAX(0.1), NCVERT(25), MOVOPT(N): Reduces cell face
warpages within the current cell set. The vertices of the current vertex set are treated
as fixed. Typically this vertex set corresponds to the surface vertices (selected using
command VSET,NEWSET,SURF) and any other vertices that the user needs to fix.
Note that if all the surface vertices are not in the current vertex set, the model will
distort. Because removing warpages is time and memory intensive, the current cell
set should be small and contain only the warped cells and cells around them.
NC1, NC2,
NCINC
– Unwarp cells NC1 to NC2 by NCINC.
ANGLE
– Warp angle criterion.
ITER
– Maximum number of iterations to perform. The solution will
stop if either the warp angle criterion is met or the maximum
specified iterations are performed.
DIST
– Vertices will not move at all if the perturbation value is less
than DIST.
RELAX
– Relaxation value for the smoothing algorithm when calculating
vertex movements.
NCVERT
– Maximum number of cell faces attached to a vertex. If more
cell faces are attached, the user will be requested to re-issue the
command with a greater value.
MOVOPT
– NO/YES/. By default, vertices on faces which satisfy the warp
angle criterion will not be moved. If YES, all vertices will be
moved until all faces satisfy the warp angle criterion.
V, NV1, X, Y, Z: Defines a vertex in the currently active local coordinate system.
3-24
NV1
– Vertex number.
X, Y, Z
– Coordinates of point (R, θ, Z in cylindrical or R, θ, φ in
spherical and toroidal).
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
Example in tutorial: 3.1, 4.1, 8.1, 8.2, 8.3, 13.1
VADJANGLE, CINT(175.0), DINT(175.0), WARP(0.0), DIST(1.0E30):
Reduces the warpage and the internal angles of cells in the current CSET.
VADJANGLE repositions vertices to minimise warpage and to reduce the
maximum internal angle to a user-specified value. Vertex movement is restricted to
a user-specified value.
CINT
– Maximum allowable internal angle in degrees. Cells with
smaller internal angles will be skipped.
DINT
– Desired internal angle in degrees. VADJANGLE will attempt
to modify the vertices so as not to exceed this angle.
WARP
– Allowable warpage angle in degrees. Cells with less warpage
will be skipped.
DIST
– Maximum allowable distance to move vertex. Vertices will not
be moved more than DIST.
VBOUNDARY, NVSTART(MAXN+1), OPTION: Defines vertices at the
centroids of boundaries. This could be particularly useful for defining sensors or
particles for post-processing (see command SENSOR and command PARTICLE).
NVSTART
– Starting vertex number.
OPTION
– ALL. A vertex will be defined at the centroid of all boundaries
in the model.
– BSET. A vertex will be defined at the centroid of all
boundaries in the current boundary set.
– BCRS. A vertex will be defined at the centroid of boundaries
selected by cursor picking.
– REGION,IR. A vertex will be defined at the centroid of all
boundaries having a region number IR.
– BLIST,NB1,[NB2,…, NB17]. A vertex will be defined at the
centroid of a list of up to 17 boundaries.
– BRANGE,/NB1(1),NB2(NB1),NBINC(1)/ALL/BSET/. A
vertex will be defined at the centroid of the range of boundaries
given by NB1 to NB2 by NBINC. BRANGE,ALL and
BRANGE,BSET are equivalent to ALL and BSET above.
Version 3.26
3-25
MESH MODULE
Chapter 3
Vertex Commands
VCELL, NVSTART(MAXV+1), OPTION: Defines vertices at the centroids of
cells. This command is useful to define sensor or particle vertices at the centroids
of selected cells.
NVSTART
OPTION
– ALL. Vertices will be defined at the centroid of each cell in the
model.
– CSET. Vertices will be defined at the centroid of each cell in
the current cell set.
– CRANGE,/NC1(1),NC2(NC1),NCINC(1)/ALL/CSET/.
Vertices will be defined at the centroid of each cell in the range
given by NC1 to NC2 by NCINC. CRANGE, ALL and
CRANGE, CSET are equivalent to ALL and CSET above.
– CLIST,NC1,[NC2,…,NC17]. Vertices will be defined at the
centroids of a list of up to 17 cells.
– CCRS. Vertices will be defined at the centroids of cells
VCENTER, NV(1), NV1, NV2, NV3, RADIUS: Given two vertices on a circle
and a radius or three vertices on a circle, this command calculates the centre of the
circle and puts vertex NV at that location — see Figure 3-16.
Command: VCEN , 20 , 5 , 15 , 10 , 3.5
5
r = 3.5
10
20
15
Figure 3-16
3-26
Vertex centering using VCENTRE
NV
– Vertex number to which the centre will be assigned.
NV1, NV2
– Vertex numbers of two points on the circle.
NV3
– If RADIUS = 0, then this is the vertex number of a third point
on the circle. If RADIUS is non-zero, then this point is used to
define the plane of the circle and which side of the two points
the centre is located at.
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
RADIUS
– The radius of the circle (not required if NV1, NV2 and NV3
are all on the circle).
VCOMPRESS, NV1(1), NV2(MAXN): Compresses out all unused vertex
numbers in the given range. Cell, boundary, block, spline and post data definitions
are renumbered appropriately. The VSET is also updated. (Note: VSET is not a
valid option for VCOMPRESS.)
NV1
– Vertex at which to begin compression.
NV2
– Vertex at which to end compression.
Example in tutorial: 2.1, 3.1, 3.2, 4.1, 8.1, 8.2, 15.1
VCROSS, OPTION, HEIGHT(0.0): Allows the user to define/modify vertex
positions using the terminal cursor to mark new locations.
OPTION
– NV1,NV2(NV1),NVINC(1). Use the cursor to define vertices
NV1 to NV2 by NVINC. The keyword DEFX can be used in
place of NV2 in order to define vertices starting from NV1 in
increments of NVINC until the process is stopped by the user.
– VCRS,,,. Use the cursor to pick, then redefine, vertices.
– VSET,,,. Use the cursor to redefine every vertex in the current
vertex set.
HEIGHT
– The location of any vertex is assumed to fall on a plane normal
to the VIEW direction and passing through the centre of the
plotted region. If the plot is being viewed along any one of the
global axes, then the coordinate of the vertex in the depth
direction (the viewing axis) is determined by the value for that
axis listed under the ‘CENTRE’ subtitle + HEIGHT. Thus, the
user may alter the depth coordinate by using the ‘CENTRE’
command or specifying HEIGHT here or both.
VDELETE, NV1, NV2(NV1), NVINC(1): Deletes a range of vertices.
NV1, NV2,
NVINC
– Deletes NV1 to NV2 by NVINC.
Version 3.26
3-27
MESH MODULE
Chapter 3
Vertex Commands
VELLIPTIC, ITER(10), WEIGHT(1.0): Provides smoothing for all vertices
connected to the current CSET. This smoothing function is similar to the
VSMOOTH command, but adds extra control functions on the boundaries which
affect the vertices closest to the boundaries the most. Vertices contained in the
current VSET are assumed to define the boundary and are locked from any
movement. (Note: The CSET must not contain any trimmed cells.)
ITER
– Number of smoothing iterations to perform.
WEIGHT
– Weight (relaxation) to apply.
VEQUAL, NVFIX, NVMOVE, DOPTION(XYZR): Takes one or more
coordinates of vertex NVMOVE and equates them to the coordinates of vertex
NVFIX in the current local coordinate system — see Figure 3-17.
Command: VEQUAL , 10 , 20 , X
Y
Fixed vertex 10
10
20
X
Z
Figure 3-17
Moving vertices using VEQUAL
NVFIX
– Vertex remaining fixed (unchanged).
NVMOVE
– Vertex whose coordinates will change.
DOPTION
– This can be any combination of X, Y, Z or R, where X, Y and
Z refer to the individual coordinates that will be equated and R
indicates that all three vertex rotations will be equated (for
MTYPE = ANSYS). If left blank, all coordinates and rotations
will be equated.
3-28
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
VFILL, OPTION: Fills in vertices between two predefined vertices in the
currently active local coordinate system — see Figure 3-18.
Command: VFILL , 1 , 5 , 5 , 10 , 10 , 1 , 1 , 1
50
y
5
5
40
x
30
20
θ
1
10
40
10
1
20
(a) Filling in Cartesian coordinates
Figure 3-18
50
r
30
(b) Filling in cylindrical coordinates
Additional vertex filling using VFILL
There are four OPTIONs:
OPTION
Version 3.26
– /NV1(1),NV2(1),NNUM(IABS(N2-N1)-1),
NVSTART(N1+NVINC),NVINC((N2-N1)/(NNUM+1)),
NREP(1),NRINC(1),RATIO(1.)/. Fills vertices between two
existing vertices.
– NV1,NV2,NNUM. Fills NNUM new vertices between
existing vertices NV1 and NV2.
– NVSTART,NVINC. The new vertices will be numbered
beginning at NVSTART and incrementing by NVINC. Note
that NVSTART and NVINC can be chosen so that existing
vertices are moved.
– NREP,NRINC. Repeats the fill NREP times incrementing
NV1, NV2 and NVSTART by NRINC. The current VFILL
operation is included in the NREP count.
– RATIO. Each successive space between new vertices is
RATIO times the previous space. Use RATIO = 1.0 (default)
for linear (even) spacing. If RATIO < 0, then an accordion
fill is used (i.e. spacing increases to middle of fill and then
decreases again to reach the second point).
– /VSET,NV2OFF,NNUM,NVSTRTOFF,NVINC,RATIO(1.)/.
Fills vertices based on the current vertex set.
– NV2OFF,NNUM. Fills NNUM new vertices between each
vertex (NV) in the current vertex set and vertex number
(NV+NV2OFF).
– NVSTRTOFF,NVINC. The new vertices will be numbered
beginning at (NV+NVSTRTOFF) and incrementing by
NVINC.
– RATIO. See above.
3-29
MESH MODULE
Chapter 3
Vertex Commands
OPTION
– /VCRS,RATIO(1.)/. The user selects up to 100 existing
vertices using the cursor. The vertices will be filled, in order of
their selection, between the first and last picked vertices. See
above for the definition of RATIO.
– /VLIST,RATIO(1.)/. The user will be prompted for a list of up
to 100 vertices (up to 20 at a time). Entering ‘DONE’ will end
the list. The vertices will be filled, in order of their selection,
between the first and last entered vertices. See above for the
definition of RATIO.
VGAP, MINGAP(5000), NV1(1), NV2(N1): Finds gaps (unused vertices) in a
given vertex range.
MINGAP
– Gaps of this size or larger will be reported.
NV1,NV2
– The vertex range searched will be NV1 to NV2.
VGENERATE, NSET, NVOFF, NV1, NV2, NVINC, DX, DY, DZ, RATIO(1.):
Generates sets of vertices from a predefined pattern by incrementing in the currently
active local coordinate system — see Figure 3-19.
Command: VGEN, 2 , 10 , 1 , 4 , 1 , 2 , 0 , 0
12
13
11
14
2
2m
1
y
3
4
r
θ
x
Figure 3-19
3-30
Vertex set generation using VGEN
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
NSET,
NVOFF
– Generates the pattern NSET times incrementing initial pattern
by NVOFF. The initial pattern is included in the NSET count.
If NVOFF is 0, then the vertices will be moved (note that to
simply move the vertices by DX, DY and DZ, NSET must be
set to 2).
NV1, NV2,
NVINC
– Initial pattern is vertices NV1 to NV2 by NVINC.
DX, DY, DZ – Geometric offsets in local coordinate system.
RATIO
– Each successive space between new sets of vertices is RATIO
the previous space. Regardless of the value of RATIO, the final
set of vertices is always (NSET–1) (DX,DY,DZ) away from the
initial set. Use RATIO = 1.0 (default) for linear (even) spacing.
If RATIO < 0, then use accordion type change in spacing
(i.e. spacing increases to middle of generation and then
decreases again to reach the final set).
VINTERSECT, ICSHELL, NVSTART(MAXN+1), COPTION, ITYPID,
SOPTION, TOL(.0001): Defines vertices at the intersection of the current cell set
with a shell type. Also defines line cells or splines at the intersection, if requested.
Version 3.26
ICSHELL
– Shell cell type, which must already be defined.
NVSTART
COPTION
– /NONE/LINE/SPLINE/.
– NONE. Line cells or splines will not be generated. Fields
ITYPID and SOPTION are not used.
– LINE. Generates line cells from the newly created vertices.
Field SOPTION is not used.
– SPLINE. Generates splines from the newly created vertices.
ITYPID
– Cell/spline type for the generated line cells/splines. This must
be an already-defined line cell/spline type.
SOPTION
– /SEGMENTED/CONTINUOUS/. This option is only used for
COPTION = SPLINE.
– SEGMENTED. Many splines will be defined on the
intersection, a new spline definition beginning at angles
greater than that specified for edge depiction (see command
EDGESEL).
– CONTINUOUS. One spline will be defined until a
continuous spline is created or there is a gap in the cell set.
TOL
– Tolerance for merging nearly adjacent vertices.
3-31
MESH MODULE
Chapter 3
Vertex Commands
VLIST, NV1(1), NV2(NV1), NVINC(1), ICSYS(1): Lists the locations of
predefined vertices.
.
NV1, NV2,
NVINC
– Lists vertices NV1 to NV2 by NVINC. Using VCRS will list
vertices by enabling cursor picking.
ICSYS
– Lists in local coordinate system ICSYS.
VMAP, OPTION: Allows the user to define/modify vertex positions using the
terminal cursor to mark new locations. The vertex is mapped into the plane of
whichever cell face encompasses the location marked on the screen — see Figure
3-20.
Surrounding cell face
Terminal cursor
Indicated point
Figure 3-20
OPTION
3-32
Projecting vertices onto a cell face using VMAP
– NV1,NV2(NV1),NVINC(1). Use the cursor to define vertices
NV1 to NV2 by NVINC. The keyword DEFX can be used in
place of NV2 in order to define vertices starting from NV1 in
increments of NVINC until the process is stopped by the user.
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
OPTION
– VCRS. Use the cursor to pick, then redefine, vertices.
– VSET. Use the cursor to redefine every vertex in the current
vertex set.
VMERGE, NV1(ALL), NV2, TOL(.0001), XMIN, XMAX, YMIN, YMAX,
ZMIN, ZMAX, KEEPOPT, DELOPT: Merges groups of coincident vertices
together. The KEEPOPT parameter determines whether the lowest or highest
numbered vertex of each set is kept. Adjustment is also made to cell, boundary,
block and spline definitions where necessary.
NV1, NV2
– Only vertices within the range of NV1 to NV2 will be checked
for coincidence. If keyword VSET is used, all vertices in the
current vertex set will be used for the merge operation.
TOL
– Vertices are deemed to coincide if their coordinate difference
in each direction is less than TOL.
XMIN,
XMAX,
YMIN,
YMAX,
ZMIN,
ZMAX
– Only vertices within these geometric ranges will be checked
for coincidence. The ranges are applied in the currently active
local coordinate system.
KEEPOPT
– /LOW/HIGH/. Determines whether the lowest or highest
numbered vertex of a coincident set is kept after merging.
DELOPT
– /DELETE/NODELETE/. If DELETE is used, then merged
vertices are removed from the model and all references to them
in the cell, boundary, spline and block lists are replaced with
the kept vertices. If NODELETE is used, then the merged
vertices are collocated (moved) but not deleted or replaced in
any subsequent lists.
VMODIFY, NV1, X, Y, Z: Modifies one or more coordinates of a vertex in the
currently active coordinate system.
Version 3.26
NV1
– Vertex to be modified. Keyword VSET can be used to modify
the coordinates of the current vertex set.
X, Y, Z
– New coordinates (in the currently active coordinate system).
Use ‘F’ or blank for any coordinate to leave the coordinate
unchanged.
3-33
MESH MODULE
Chapter 3
Vertex Commands
VMOVE, NV1, ICSYS1, X1, Y1, Z1, ICSYS2, X2, Y2, Z2, TOL(1.0E-5): Moves
a vertex to the intersection of two local coordinate systems — see Figure 3-21.
Command: VMOVE , VSET , 11 , F , V , F , 12 , 5 , V , V , 1.E-4
Y
Local Cartesian system 11
Local cylindrical system 12
Vertex set 20 to 22
r=5
20 21
22
X
Z
Figure 3-21
Moving vertices using VMOVE
NV1
– Vertex to move (it must already exist). Keyword VSET can be
used to move vertices in the current vertex set.
ICSYS1,
ICSYS2
– Reference numbers for two pre-defined local coordinate
systems.
X1, Y1, Z1,
X2, Y2, Z2
– Coordinate values in respective local system. The user must
supply any three for program to calculate the other three. Use
‘V’ to allow a coordinate to vary and either supply a value or
use ‘F’ to fix the value as it currently is.
TOL
– Calculation tolerance for the new vertex position.
VPCREATE, NVSTART(MAXN+1), SOPTION(CURSOR),
GOPTION(POINT): Creates vertices based on specified patterns. This command
is particularly useful for defining sensors or particles for post-processing (see
command SENSOR and command PARTICLE).
NVSTART
3-34
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
SOPTION
– CURSOR. Uses the cursor to specify vertex locations. In this
case the following coordinate system and coordinate value
fields are not processed. Specified locations on the viewing
plane are mapped onto the surface or section definition
depending on which type of plot is displayed.
– COORDINATES. Uses coordinates to specify vertex locations.
GOPTION
– POINT,ICSYS(1),XP,YP,ZP. Creates a vertex at point XP, YP,
ZP of coordinate system ICSYS.
– LINE,NVERT(20),ICSYS(1),XP1,YP1,ZP1,XP2,YP2,ZP2.
Creates NVERT vertices between points XP1, YP1, ZP1 and
XP2, YP2, ZP2 of coordinate system ICSYS. If
SOPTION = COORDINATES and ICSYS is non-Cartesian,
vertices will be created along an arc rather than a straight line
as with the VFILL command.
– RECTANGLE,NVERTX(6),NVERTY(6),ICSYS(1),
ZCOORD(0.0),XCMIN(-1.0),XCMAX(1.0),YCMIN(-1.0),Y
CMAX(1.0). For SOPTION = CURSOR, creates vertices in
the viewing plane by clicking two corners of a rectangle and
maps them onto the surface or section definition. NVERTX
and NVERTY correspond to the number of vertices in the
screen X, Y directions. For SOPTION = COORDINATES,
creates vertices in a plane defined by Z = ZCOORD of the
Cartesian coordinate system ICSYS. The rectangle will be
defined by XCMIN ≤ X ≤ XCMAX and
YCMIN ≤ Y ≤ YCMAX. NVERTX vertices will be created in
the X direction and NVERTY vertices will be created in the Y
direction.
– CIRCLE,NVERTR(2),NVERTT(8),ICSYS(2),
ZCOORD(0.0),RADIUS(1.0). For SOPTION = CURSOR,
creates vertices in the viewing plane by clicking the centre of a
circle and a point on the circle and maps them onto the surface
or section definition. NVERTR and NVERTT correspond to
the number of vertices in the radial and angular directions. For
SOPTION = COORDINATES, creates vertices in a plane
defined by Z = ZCOORD of the cylindrical coordinate system
ICSYS. The circle will be defined by 0 ≤ R ≤ RADIUS.
NVERTR vertices will be created in the R direction and
NVERTT vertices will be created in the THETA direction.
Setting NVERTR = 2 results in two concentric rings of
vertices.
VPROJECT, NV1(1), NV2(NV1), NVINC(1), NVOFF(0), NC1(1), NC2(NC1),
NCINC(1), POPTION, DIST(1.E30), RLXF(1.): Projects vertices onto a shell
surface. The vertices may travel along a constant coordinate direction in the
Version 3.26
3-35
MESH MODULE
Chapter 3
Vertex Commands
currently active local coordinate system or may travel normal to the shell surface
itself, depending upon the POPTION selected — see Figure 3-22.
(CSET is the target shell surface)
Command: VPROJ , 1 , 3 , 1 , 10 , CSET ,,, NORM
1
2
3
11
12
13
Figure 3-22
Projecting vertices onto a surface using VPROJECT
NV1, NV2,
NVINC
NVOFF
– Offset to apply to the existing vertex set to create the projected
set. If NVOFF = 0, then the starting vertex set is moved.
NC1, NC2,
NCINC
– The list of shell cells defining the surface to which to move the
vertices.
POPTION
– NORMAL. Vertices are moved in a direction normal to the
given shell surface until intersecting the surface.
– LOCAL,/X/Y/Z/. Vertices are moved along a line of constant
X, Y or Z in the currently active coordinate system until
intersecting the surface.
DIST
– Absolute limit on distance moved. Any vertex projected farther
than this distance will not be moved or created.
RLXF
– Relaxation factor. The new position is calculated as:
– NEW = OLD + RLXF * (PROJECTED – OLD).
– If RLXF = 1., then the vertex is located at the projected
position.
VREAD, LF(case.vrt), NVOFF, NV1, NV2, FOPT: Reads in a set of vertex
position data from a file.
3-36
LF
– File name from which to read vertices.
NVOFF
– Offset to add to vertices upon input.
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
NV1, NV2
– Reads only vertices between NV1 and NV2 (default = all
vertices).
FOPT
– CODED. Reads a coded (ASCII) file in the format
(I9,6X,3G16.9).
– BINARY. Reads the data in binary form.
VREFLECT, ICSYS(1), IDIR(1), NVOFF, NV1(1), NV2(NV1), NVINC(1):
Generates a set of vertices by reflection about a local coordinate system axis — see
Figure 3-23.
Command: VREF , 11 , 2 , 100 , 10 , 40 , 10
Y
40
30
20
10
X
Coordinate system no. 11
110
120
130
140
Figure 3-23
Vertex reflection using VREFLECT
ICSYS
– Reference ID of a predefined local coordinate system.
IDIR
– Axis of reflection (1, 2 or 3).
NVOFF
– Offset to add to vertices to form new set.
NV1, NV2,
NVINC
– Original set is NV1 to NV2 by NVINC.
VRENUMBER, CONOPT, NVSTART(1), NC1, NC2, NCINC: Renumbers all
cell, boundary, spline and mesh block definitions by the following method: Each
cell in the given range is taken in turn and the vertices are renumbered sequentially
starting at NVSTART.
Version 3.26
3-37
MESH MODULE
Chapter 3
Vertex Commands
CONOPT
– CONNECT. All occurrences of any given vertex are replaced
consistently such that there is no change to the connectivity.
– DISCONNECT. Only vertices on cells in the range or CSET
are renumbered. This will lead to these cells being
disconnected from the remainder of the model.
– CELLSONLY. Same as DISCONNECT (above) with the
additional property that vertices of boundary, spline and block
definitions will not be redefined.
NVSTART
– Vertex number with which to replace the first vertex
encountered on a cell. It defaults to 1 for options CONNECT
and DISCONNECT and defaults to MAXV+1 for
CELLSONLY.
NC1, NC2,
NCINC
– Only vertices in this range of cells are renumbered.
VREPLACE, NV1(1), NV2(NV1), NVINC(1), NVOFF, TOLCHK(.0001): This
command is similar to VMERGE in that it replaces one group of vertices with a
different set and then searches all cell, boundary and mesh block definitions to make
an appropriate adjustment. Unlike VMERGE, this function does not look for
vertices physically located near each other. Instead, it simply replaces vertex
NVOUT = NV + NVOFF by vertex NV where NV is defined as NV1 to NV2 by
NVINC. TOLCHK is simply a distance check. The function produces a warning if
vertex NVOUT is farther away from NV than this distance.
NV1, NV2,
NVINC
– Range of vertices kept.
NVOFF
– Offset used to find the vertex range to throw away.
TOLCHK
– Distance check beyond which a warning message is produced.
VSCALE, VSCALE, NV1(1), NV2(NV1), NVINC(1), SFX(1.), SFY(1.),
SFZ(1.), COORDOPT, ICS: Scales (multiplies) a range of vertices by a different
factor in each direction of a given coordinate system.
3-38
NV1, NV2,
NVINC
– Vertices in the range NV1 to NV2 by NVINC will be scaled.
SFX, SFY,
SFZ
– Scale factors in the local X, Y and Z directions, respectively.
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
COORDOPT – If COORDOPT = YES, then the origins of all local coordinate
systems (except the three global systems and the given local
system) will also be scaled by the same factors. If
COORDOPT = NO (default), then no coordinate systems will
be modified.
ICS
– The coordinate system in which to scale the vertices. The
default is the currently active coordinate system (see command
CSYS).
VSECTION, NVSTART(MAXV+1), COPTION, ITYPID, SOPTION,
TOL(.0001), /RZSPLINE/, SPL(1), ICYLSYS(2): Defines vertices at the section
of the current cell set. Also defines line cells or splines at the section, if requested.
Version 3.26
NVSTART
COPTION
– NONE (default). Line cells or splines will not be generated.
Fields ITYPID and SOPTION are not used.
– LINE. Generates line cells from the newly created vertices.
Field SOPTION is not used.
– SPLINE. Generates splines from the newly created vertices.
ITYPID
– Cell/spline type for the generated line cells/splines. If left
blank, a new cell/spline type will be created. Otherwise, this
must be a previously defined line cell/spline type.
SOPTION
– This option is only used for COPTION = SPLINE.
– SEGMENTED (default). A new spline definition will begin
at angles greater than that specified for edge depiction (see
command EDGESEL).
– CONTINUOUS. A new spline definition will only begin
when there is a gap in the current cell set.
TOL
– Tolerance for merging nearly adjacent vertices.
RZSPLINE
– Use the RZSPLINE option to define a varying section plane as
multiple R,Z coordinates in a cylindrical coordinate system
(ICYLSYS). The R,Z coordinates associated with the section
are derived from the R and Z position of nodes along the
entered spline (SPL). Note: When performing the section cut,
all segments of the spline SPL are treated as line segments.
SPL
– Spline number containing nodes specifying the R and Z
coordinates of the desired section cut.
ICYLSYS
– Cylindrical coordinate system for which the R and Z
coordinates of spline SPL are placed.
3-39
MESH MODULE
Chapter 3
Vertex Commands
VSMOOTH, ICSYS(1), ITER(10), DIST(1.E30), RLX(1.), RLY(1.), RLZ(1.):
Provides algebraic smoothing for all vertices connected to the current CSET, see
Figure 3-24. Vertices contained in the current VSET are locked from any
movement. Vertices on the surface of the CSET are smoothed only in relation to
other vertices also on the surface. Use of this command without first locking any
vertices (usually along the edges) almost always results in shrinkage of the model.
Before
Figure 3-24
After
Vertex smoothing using VSMOOTH
ICSYS
– Local coordinate system in which to smooth.
ITER
– Number of smoothing iterations to perform.
DIST
– Vertices will not move at all if the distance to the smoothed
position is greater than DIST.
RLX, RLY,
RLZ
– Relaxation factors for each local coordinate direction. Users
may effectively prevent movement in any direction by setting
the appropriate factor to a near zero value.
VTRANS, ICSYS(1), NV1(1), NV2(NV1), NVINC(1), NVOFF(0): Transfers
vertices from the currently active coordinate system into another system by
reinterpreting the coordinates directly in the new system.
3-40
ICSYS
– Coordinate system to which the vertices are to be transferred.
NV1, NV2,
NVINC
– Transfer vertices NV1 to NV2 by NVINC.
Version 3.26
Chapter 3
MESH MODULE
Vertex Commands
NVOFF
– Transferred vertices are equal to the original vertex plus
NVOFF.
VUNDO: Undoes the results of the last command used to add/delete/modify any
vertex. This does not include the following commands: VCOMPRESS, VREAD,
VROTATE or conversion of foreign formats.
VVERTEX, NV(MAXV+1), OPTION: Defines a vertex at the centroids of other
vertices.
NV
OPTION
– ALL. A vertex will be defined at the centroid of all vertices in
the model.
– VSET. A vertex will be defined at the centroid of all vertices in
the current vertex set.
– VRANGE,/NV1(1),NV2(NC1),NVINC(1)/ALL/VSET/. A
vertex will be defined at the centroid of the range of vertices
given by NV1 to NV2 by NVINC. VRANGE,ALL and
VRANGE,VSET are equivalent to ALL and VSET above.
– VLIST,NV1,[NV2,…, NV17]. A vertex will be defined at the
centroid of a list of up to 17 vertices.
– VCRS. A vertex will be defined at the centroid of vertices
VWRITE, LF(case.vrt), NVOFF, NV1, NV2, FOPT: Writes a set of vertex
position data to a file.
Version 3.26
LF
– File name to write vertices.
NVOFF
– Offset to add to vertices upon output.
NV1, NV2
– Writes out only vertices between NV1 and NV2 (default = all
vertices).
FOPT
– CODED. Writes a coded (ASCII) file in the format
(I9,6X,3G16.9).
– BINARY. Writes the data in binary form.
3-41
MESH MODULE
Chapter 3
Spline Commands
Spline Commands
SPCHECK, NSPL1(1), NSPL2(NSPL1), NSPLINC(1), /ALL/END/,
DUPCHECK(N/Y): Checks for splines which cross over themselves and for
identical splines.
NSPL1,
NSPL2,
NSPLINC
– Range of splines NSPL1 to NSPL2 by NSPLINC. Keywords
ALL and SPLS are valid in the NSPL1 field as well.
/ALL/END/
– Option whether to check all spline vertices against each other
to see if they are coincident or to check only whether the last
spline vertex is coincident with one of the other spline vertices.
Note that two different vertices with the same coordinates are
not considered the same vertex.
DUPCHECK – Option whether to check for duplicate splines, i.e. splines
(N/Y)
which have exactly the same set of vertices. If the vertices of
both splines are defined in the same order, the splines will be
flagged as identical. If the vertices of one spline are defined in
reverse order relative to those of the other spline, the splines
will be flagged as mirror images. Default is ‘N’ for this option.
SPCOMPRESS: Compresses deleted splines out of a model. Splines are
renumbered with no gaps. The current SPLSET is updated.
SPL, NSPL, OPTION: Defines a cubic spline by specifying either the vertices
which make up the spline (OPTION = VLIST), a range of vertices which make up
the spline (OPTION = VRANGE) or several vertices along the spline path and
having the computer fill in vertices by following a surface (OPTION = CHASE or
MESH). The use of a negative vertex number in the vertex definition list provides
for slope discontinuity at the location of the (absolute value) of the vertex — see
Figure 3-25. There is no imposed limit on the number of vertices per spline.
3-42
Version 3.26
Chapter 3
MESH MODULE
Spline Commands
Command: SPL , 1 , VRAN , 10 , 60 , 10
Command: SPL , 2 , VLIST , 1 , –2 , –3 , 4 , 5 , 6 , –7 , 8
2
40
30
10
50
4
60
1
5
3
6
20
7
(a)
Figure 3-25
(b)
8
Spline creation using SPL
NSPL
– Arbitrary spline reference number. If this spline already exists,
then the vertex points referenced in this command are added to
the end of the current list.
OPTION
– VLIST,NV1,NV2,…,NV17. Spline is defined by specifying a
list of up to 17 vertices.
– VRANGE,NV1,NV2,NVINC(1). Spline is defined by
specifying a range of vertices from NV1 to NV2 by NVINC.
NV1 may not be replaced with VSET or ALL.
– CHASE,/CSURF/CSHELL/,/NV1,NV2,…/VSET/VCRS/ or
CHASE,ICTID,NV1,NV2. Spline is defined by specifying
several points along the intended path of the spline. The
computer fills in the rest of the points by following the best
straight line path between the two points and finding
intersections with the surface elements requested. The surface
element options are CSURF where the current surface is used
or CSHELL where shells only in the current cell set are used.
NV1, NV2, … are vertices to be used as end points for the
path. If neither CSURF or CSHELL is used, then the
parameter after CHASE is taken to be the type number
(ICTID) of a set of shells to be used to chase the spline
through.
– MESH,/CSURF/CSHELL/,NV1,NV2,…/VSET/VCRS/ or
MESH,ICTID,NV1,NV2. This option is the same as CHASE
described above except that the spline does not cross cells but
follows the mesh lines or individual cell edges.
SPLCROSS, NSPL, SOPTION: Defines or adds to a spline definition by using the
cursor to point to a series of predefined vertices. A vertex plot (VPLOT) must be on
the screen to use this command. If the user clicks on the same vertex twice in a row,
then pro-STAR changes the sign of the vertex, indicating a break in slope continuity
Version 3.26
3-43
MESH MODULE
Chapter 3
Spline Commands
at that location.
NSPL
– Arbitrary spline reference number.
SOPTION
– /INIT/ADD/. INIT deletes the definition of spline number
NSPL before adding new vertices. ADD adds picked vertices
to the end of the existing spline NSPL definition.
SPLDELETE, NSPL1, NSPL2, NSPLINC: Deletes a range of splines.
NSPL1,
NSPL2,
NSPLINC
– Deletes all splines from number NSPL1 to NSPL2 by
NSPLINC. SPLSET and SCRS are valid keywords for range.
SPLGENERATE, NSET, NSOFF, NSPL1, NSPL2, NSPLINC, NVOFF:
Generates additional splines from a predefined series of splines — see Figure 3-26.
Command: SPLGEN , 3 , 1 , 5 , 5 , 1 , 10
26
25
24
23
Spline 7
21
22
16
15
14
13
Spline 6
11
12
4
5
6
3
1
Spline 5
Figure 3-26
3-44
2
Spline set generation using SPLGENERATE
NSET,
NSOFF
– Generates the splines NSET times incrementing initial spline
range by NSOFF. The initial set is included in the NSET count.
NSPL1,
NSPL2,
NSPLINC
– Initial pattern is splines NSPL1 to NSPL2 by NSPLINC.
NVOFF
– Offset each vertex of the initial spline pattern by NVOFF to
form a new spline.
Version 3.26
Chapter 3
MESH MODULE
Spline Commands
SPLLIST, NSPL1, NSPL2, NSPLINC: Lists spline definitions for a range of
splines.
NSPL1,
NSPL2,
NSPLINC
– Lists all splines from number NSPL1 to NSPL2 by NSPLINC.
SPLSET and SCRS are valid keywords for range.
SPLMODIFY, NSPL, MOPTION: Modifies a spline by changing the set of
vertices that it references and/or by changing its type number — see Figure 3-27.
The type number is always changed to that of the current spline type (see command
STYPE).
Command: SPLMOD , 3 , MODIFY , 14 , 24 , 25 , 26
15
16
14
Spline 3
13
11
Figure 3-27
12
24
25
26
Spline modification using SPLMODIFY
NSPL
– Spline reference number. Keyword SPLSET can be used to
modify Splines in the current spline set.
If none of the following options are used, then only the type number will be
modified.
MOPTION
Version 3.26
– INSERT,NVAFTER,NV1,NV2,…,NV16. Inserts vertices NV1
to NV16 after vertex NVAFTER.
– DELETE,NV1,NV2. Removes all vertices starting with vertex
NV1 and ending with vertex NV2. Note: NV1, NV2 is not a
range. It refers only to vertices on the given spline located
between vertices NV1 to NV2.
3-45
MESH MODULE
Chapter 3
Spline Commands
MOPTION
– MODIFY,NVSTART,NV1,NV2,…,NV16. Modifies vertices
starting at vertex NVSTART. NV1 to NV16 are new vertex
numbers to associate with this spline. If any vertex is equal to
0, then the original vertex in that position will remain.
– SEGMENT,NV1,NV2,…,NV16. Changes the sign of all the
vertices in the list. Negative vertices indicate a break in slope
continuity of the spline at a given vertex. If NV1 = ALL, then
all vertices in the spline are changed to negative values, so that
the spline is in reality a set of connected straight line segments.
– SPLIT,NVAT,NSPLINE2(MAXSPLINE+1). Splits spline
NSPL at vertex number NVAT into two splines. The second
spline will be numbered as NSPLINE2.
– JOIN,NSPLINE2. Joins NSPLINE2 to NSPL. NSPLINE2 is
not modified by this operation. This option first looks for a pair
of common end points at either spline end. If none are found,
the splines are joined at whichever pair of end points is closest.
– REVERSE. Reverses the order of all vertices in the definition
of spline NSPL.
SPLREAD, LF(case.spl), NVOFF, NS1, NS2, OPTION, FOPT: Reads a set
of spline definition (connectivity) data from a file.
LF
– File name from which to read splines. The first number is the
spline number, the second (NPTS) is the number of points in
the spline, and the third is the spline type (ISTID) referencing
the spline table (STABLE command). Next follows NPTS
vertex numbers, 8 per line, up to 100 points.
NVOFF
– Offset to apply to vertices upon input.
NS1, NS2
– Reads only splines between NS1 and NS2 (default = all).
OPTION
– ADD. Adds the splines to the end of the spline list, regardless
of the spline numbers on the file.
– MODIFY. Uses the spline numbers on the file to overwrite
current spline definitions.
FOPT
– CODED. Reads a coded (ASCII) file in the format (3I9,/,8I9).
– BINARY. Reads the data in binary form (1 record per spline).
SPLUNDELETE, NSPL1, NSPL2, NSPLINC, OPTION: Undeletes a set of
splines. Any deleted spline can be undeleted (reinstated) until the SPCOMPRESS
3-46
Version 3.26
Chapter 3
MESH MODULE
Spline Commands
command has been used. Note that SPLSET cannot be used as a range substitute in
this command.
NSPL1,
NSPL2,
NSPLINC
– Un-deletes splines NSPL1 to NSPL2 by NSPLINC.
OPTION
– ALL. All deleted splines in the above specified range will be
reinstated.
– TYPE,ISTID. Only splines of type ISTID in the above
specified range will be reinstated.
SPLWRITE, LF(case.spl), NVOFF, NS1, NS2, FOPT: Writes a set of spline
connectivity data to a file.
LF
– File name to which splines are written.
NVOFF
– Offset to apply to vertices upon output.
NS1, NS2
– Writes only splines between NS1 and NS2 (default = all).
FOPT
– CODE. Writes a coded (ASCII) file in the format: (3I9,/,8I9).
The first number is the spline number, the second (NPTS) is
the number of points in the spline, and the third is the spline
type (ISTID) referencing the spline table (STABLE
command). Next follows NPTS vertex numbers, 8 per line, up
to 100 points.
– BINA. Writes the data in binary form (1 record per spline).
SPVCOMPRESS: Compresses the spline vertex storage array to its minimum size.
Spaces (zeroes) and deleted splines are removed from the storage array to save
memory. If the maximum number of spline vertices is exceeded (MXSPVT), it is
wise to issue this command before the MEMORY command.
STABLE, ISTID(1), ICOL(7), IGROUP(1): Defines a spline table entry.
ISTID
Version 3.26
– Arbitrary reference ID for this entry. All splines generated with
this ISTID will have the characteristics associated with this
entry.
3-47
MESH MODULE
Chapter 3
Spline Commands
ICOL
– Colour table index for all splines referenced to this entry.
IGROUP
– Arbitrary group number used to identify related objects.
STDELETE, ISTID1(1), ISTID2(ISTID1), ISTINC(1): Deletes spline table
entry definitions. (In order to delete any table entry, all splines referencing this entry
must first be deleted or modified to a different entry.)
ISTID1,
ISTID2,
ISTINC
– Deletes table entries ISTID1 to ISTID2 by ISTINC.
STLIST, ISTID1(1), ISTID2(ISTID1), ISTINC(1): Lists spline table entry
definitions.
ISTID1,
ISTID2,
ISTINC
– Lists table entries ISTID1 to ISTID2 by ISTINC.
STYPE, ISTID(1): Changes the currently active spline type ID.
ISTID
– Pointer to an entry in the spline table (see command STABLE).
VSPCROSS, NSPL, NV1, NV2, NVINC: Allows the user to define/modify vertex
positions using the terminal cursor to mark new locations. Each vertex is positioned
directly on the referenced spline.
NSPL
– Spline reference number on which vertices will be located.
NV1, NV2,
NVINC
– The cursor will reappear to mark vertices NV1 to NV2 by
NVINC.
3-48
Version 3.26
Chapter 3
MESH MODULE
Spline Commands
VSPDEFINE, NSPL, NV, ARCOPTION, VL, IOPTION: Defines a single
vertex on a given spline with reference to the arc length of the spline — see Figure
3-28.
Command: VSPDEF , 4 , 60 , PERC , 0.6
3
Spline 4
2
1
Figure 3-28
5
4
60
Vertex creation on a spline using VSPDEFINE
NSPL
– Spline reference number.
NV
– Vertex number to position on spline NSPL.
ARCOPTION – ABSARC. Location along the spline is determined by an
absolute arc value.
– PERCENTARC. Location along the spline is determined by a
percentage arc value (0 < VL < 1.).
VL
– Value of arc length used to position vertex NV.
IOPTION
– NOINSERT. The defined vertex will not be inserted into the
spline.
– INSERT. The spline definition will be modified to include the
defined vertex at the specified location.
VSPFILL, /NSPL, NV1, NV2, NNUM, NVSTART, NVINC, RATIO (1.)/
/NSPL, VCRS, RATIO(1.)/: Fills in along a predefined spline between two
vertices already located on the spline — see Figure 3-29. If VCRS is used, then the
user should select with the cursor any number of vertices sequentially (up to 100)
and the program will fill on the spline between the first and last vertices selected.
Command: VSPF , 8 , 10 , 20 , 3 , 2 , 1
4
Spline 8
3
10
Figure 3-29
Version 3.26
20
2
Vertex filling between two points on a spline
NSPL
NV1, NV2
– Fills from NV1 to NV2.
3-49
MESH MODULE
Chapter 3
Spline Commands
NNUM,
NVSTART,
NVINC
– Fills NNUM vertices starting with NVSTART and
incrementing by NVINC.
RATIO
– Each successive space between new vertices is RATIO the
previous space. Use RATIO = 1.0 (default) for linear (even)
spacing. If RATIO < 0, then use accordion fill (i.e. spacing
increases to middle of fill and then decreases again to reach the
second point).
VSPGENERATE, NSPL(1), NSET(2), NVOFF, NV1(1), NV2(NV1),
NVINC(1), SOPTION, SSTART(0.), SEND, SINC: Generates a group of vertices
using a spline as a referenced local coordinate system. Each new set of vertices is
located as if the original set had been dragged or slid along the referenced spline to
a new location — see Figure 3-30.
Command: VSPGEN , 7 , 3 , 10 , 10 , 12 , 1 , ABSA , 0.2 , 0.0 , 1.0
32
12
Spline 7
11
10
Figure 3-30
22
21
31
30
20
Vertex set generation using a spline as a coordinate system
NSPL
NSET,
NVOFF
– Generates the pattern NSET times incrementing initial pattern
by NVOFF. The initial pattern is included in the NSET count.
NV1, NV2,
NVINC
– Initial pattern is vertices NV1 to NV2 by NVINC.
SOPTION
– /ABSO/PERC/. Specifies whether the following arc length
parameters are absolute or percentages of the total spline. If arc
length parameters are entered as percentages, they should be in
the range between 0.0 and 1.0 where 0.0 corresponds to vertex
1 and 1.0 corresponds to vertex N of a spline with N vertices.
SSTART
– Initial arc length to which the starting vertex set (NV1 to NV2
by NVINC) is referenced.
SEND, SINC – The user must provide either SEND (the ending spline arc
length) or SINC (the arc length increment between successive
generated sets). One of either SEND or SINC must be left
blank.
3-50
Version 3.26
Chapter 3
MESH MODULE
Spline Commands
VSPLIST, NSPL(1), NV1(1), NV2(NV1), NVINC(1): Lists the spline coordinates
of a range of vertices. The output includes absolute arc length, percent arc length
and distance from the vertex to the projected location of the vertex on the spline.
NSPL
NV1, NV2,
NVINC
– Lists vertices in range NV1 to NV2 by NVINC.
VSPMOVE, NSPL(1), NV, IC(1), X, Y, Z, TOL(1.0E-5): Moves a vertex to the
intersection of a spline and a local coordinate system — see Figure 3-31.
Command: VSPMOVE , 7 , 47 , 23 , V , V , 3.0
YL
Vertex 47
Spline 7
Z = 3.0
ZL
XL
Figure 3-31
Version 3.26
Intersection of a spline and a local coordinate system
NSPL
NV
– Vertex to move (it must already exist). Keyword VSET can be
used to move all vertices in the current vertex set.
IC
– Reference number for a predefined local coordinate system.
X, Y, Z
– Coordinate values in the local system. User must supply any
one for the program to calculate the other two. Use ‘V’ to
allow a coordinate to vary and either supply a value or use ‘F’
to fix the value as it currently exists.
TOL
– Calculation tolerance when finding the new vertex position.
3-51
MESH MODULE
Chapter 3
Cell Commands
VSPPROJECT, NV1(1), NV2(NV1), NVINC(1), NVOFF(0), NS1(1),
NS2(NS1), NSINC(1), DIST(1.E30): Projects vertices onto splines.
NV1, NV2,
NVINC
NVOFF
– Offset to apply to the existing vertex set to create the projected
set. If NVOFF = 0, then the starting vertex set is moved.
NS1, NS2,
NSINC
– The list of splines defining the curves to which to move the
vertices.
Cell Commands
C, NV1, NV2, …, NV8: Defines a single cell of the same type as the currently
active cell type. If the current cell type is point, then only NV1 is needed. Line cells
require only NV1 and NV2. Baffle and shell cells require only NV1-NV4. For shell
cells, NV5 and NV6 may optionally be defined (see Figure 3-32 and Figure 3-33).
NV1, NV2,
…, NV8
– Vertex reference numbers.
3-52
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
4
4
3
8
7
1
3
1
2
2
5,5,5,5
5
6
Hexahedron
Pyramid
5,5,5,5
3,3
7,7
3,3
1
1
2
5
6
2
Triangular prism
Figure 3-32
Tetrahedron
Basic fluid or solid cell shapes
4
3,3
3
2
1
1
Quadrilateral
Figure 3-33
2
Triangle
Basic baffle or shell shapes
CCOMPRESS: Compresses deleted cells out of a model. Cells are renumbered
with no gaps. Couples and post data definitions are renumbered appropriately. The
current cell set is also updated.
CCROSS, OPTION: Identifies cells using the cursor device to pick out a cell face.
The identified cell can be deleted or modified (change of cell type) or a baffle can
be added to the indicated face. The cursor will continue to appear until it is placed
Version 3.26
3-53
MESH MODULE
Chapter 3
Cell Commands
over a region of the screen in which no surfaces have been drawn. Any cell plot
other than a section plot can be on the screen for this command to function. If the
cursor is placed over a location showing more than one face (non-hidden line plot),
the face nearest the viewer will be picked.
OPTION
– MODIFY,ICTID. Changes the type of the cell to type ICTID,
which must exist in the cell table. ICTID defaults to the
currently active type.
– DELETE. Deletes the cell definition.
– BAFFLE,ICTID. Adds a baffle to this cell face. The baffle will
have type ICTID which must exist in the cell table. ICTID
defaults to the current cell type.
– SHELL,ICTID. Adds a shell to this cell face. The shell will
have type ICTID, which must exist in the cell table. ICTID
defaults to the current cell type. Shells are constructed such
that their outward normals are consistent with the cell face on
which they are added (assuming that the starting cells are
right-handed).
CDELETE, NC1, NC2(NC1), NCINC(1): Deletes a set of cells. Deleted cells may
be reinstated with the CUNDELETE command as long as the cell list has not been
compressed.
NC1, NC2,
NCINC
– Deletes cells NC1 to NC2 by NCINC. CSET, ALL and CCRS
are also valid keywords.
CDIVIDE, NDIVI(2), NDIVJ(NDIVI), NDIVK(NDIVI),
NVSTART(MAXV+1), COUPOPT: Subdivides all hexahedral cells in the
current cell set if they correspond to a structured mesh and a predefined I,J,K
direction specified by the CDIRECTION command. The connectivity in the cell set
must be such that for any given cell, the directions corresponding to the three
division factors, NDIVI, NDIVJ and NDIVK, are independent of the path from the
cell used with the CDIRECTION command. Thus, for example, any surface vertex
which does not lie on an edge should join exactly four cells. The cells in the current
set will be deleted and the subdivided cells will correspond to the current set. The
newly created cells will correspond in type to the deleted parent cell.
3-54
NDIVI
– Number of refined cells to create in the specified I direction.
NDIVJ
– Number of refined cells to create in the specified J direction.
NDIVK
– Number of refined cells to create in the specified K direction.
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
NVSTART
– Starting vertex number in the subdivided cells. The vertices in
these cells will correspond to an ordered sequence starting
from NVSTART.
COUPOPT
– NOCOUPLE. Couples will not be generated at the interface
between refined cells and the original model.
– COUPLE. Couples will be generated with couple type ICPTID
at the interface between refined cells and the original model. If
ICPTID is left blank, then the current couple type will be used
(see command CPTYPE).
CDX, TYPE: Defines cells using the cursor to pick vertices. The cursor will
reappear to define multiple cells until the user picks a location outside the plot
window, a spot far away from any vertex or the ‘DONE’ button. The cell type is
determined by the currently active cell type (see command CTYPE). The user may
select vertices from vertex, cell or spline plots. When using cell plots, the selector
will respond to exact hidden or quick hidden as if they were both quick hidden plots.
TYPE
Version 3.26
– /HEXA/SHELL,NVER(4)/LINE,NVER(2)/POINT/PRISM/
/TETRA/PYRAMID/TRIM,STYPE/.
– If TYPE = HEXAHEDRON (default), hexahedral cells will
be defined if the current cell type is FLUID or SOLID, else
cells will be defined according to the currently active cell
type. If the active cell type is SHELL, only four-noded shells
may be generated with this type. To define five- or six-noded
shells using CDX, see type SHELL below. If the active cell
type is LINE, only two-noded lines may be generated using
this type. To define three-noded lines using CDX, see type
LINE below.
– If TYPE = SHELL, shell cells will be defined (the currently
active cell type must be SHELL). NVER is the number of
vertices per shell (either 4 (default), 5 or 6).
– If TYPE = LINE, line cells will be defined (the currently
active cell type must be LINE). NVER is the number of
vertices per line (either 2 (default) or 3). If MTYPE is not set
to ANSYS, then only two-noded lines may be defined.
– If TYPE = POINT, point cells will be defined (the currently
active cell type must be POINT).
– If TYPE = PRISM, prisms will be defined (the currently
active cell type must be FLUID or SOLID). Six vertex clicks
are required for this definition: three each for face 1 and face
2.
– If TYPE = TETRA, tetrahedra will be defined (the currently
active cell type must be FLUID or SOLID). Four vertex
clicks are required for this definition.
3-55
MESH MODULE
Chapter 3
Cell Commands
TYPE
– If TYPE = PYRAMID, pyramids will be defined (the
currently active cell type must be FLUID or SOLID). Five
vertex clicks are required for this definition, the first four
corresponding to face 1 (base) of the pyramid.
– If TYPE = TRIM (see Figure 3-34), trimmed cells will be
defined. STYPE is the type of trimmed cell which
corresponds to the number of vertices removed from a
regular hexahedron. See the manual for an illustration of the
number of vertex clicks required and click order for each
trimmed cell type.
8
8
9
10
9
7
6
10
3
5
3
4
4
2
(1)
2
5
1
9
1
(2)
8
6
7
10
7
6
2
5
6
10
7
5
1
3
4
3
2
1
(3)
(4)
11
10
12
7
9
8
7
8
4
9
8
3
4
1
5
6
2
(5)
Figure 3-34
5
4
6
(6)
3
1
2
Allowable polyhedral cell shapes
CFIND, OPTION, NVSEED: Finds cells on the current plot (SURFACE,ON) by
finding all surface cell faces attached to one vertex (NVSEED) and proceeding in
waves outward from this initial start. The process ends at any vertex included in the
3-56
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
current VSET. The user should find VSET,NEWSET,EDGE helpful in defining a
VSET that may be particularly useful with this command — see Figure 3-35.
Commands: VSET , NEWS , EDGE
CFIND , SHELL , 8 , 100
VSET selected
Seed vertex 100
Shell created
Figure 3-35
Surface cell manipulation using CFIND
OPTION
– MODIFY. Changes the type ID of the cell to the currently
active type.
– DELETE. Deletes the cell definition.
– BAFFLE,ICTID(3). Adds a baffle to each cell face. The baffle
will have type ICTID which must exist in the cell table.
Location 7 of each baffle description will contain the
associated cell number and location 8 will contain the
associated cell face. (Note that the associated face numbers
will be different in STAR models from what they are in
ANSYS models.)
– SHELL,ICTID(3). Adds a shell to each cell face. The shell will
have type ICTID which must exist in the cell table. Shells are
constructed such that their outward normals are consistent with
the cell face on which they are added (assuming that the
starting cells are right-handed). Locations 7 and 8 of the shell
descriptions will be defined like the baffles above.
– BOUNDARY,NREG(1),NPAT(0). Adds a boundary to each
cell face. Each boundary will be given region number NREG
and radiation patch number NPAT. Note that this is essentially
the same as the BFIND command.
NVSEED
– Starting vertex number to search for adjacent boundaries.
Version 3.26
3-57
MESH MODULE
Chapter 3
Cell Commands
CFIX, NC1, NC2, NCINC, OPTION: Fixes or transforms cell definitions for
range or set of cells.
NC1, NC2,
NCINC
– Flips cells NC1 to NC2 by NCINC.
OPTION
– FIX. If possible, fixes an invalid cell.
– HAND. Changes handedness of cell.
– COLLAPSE. Looks at the collapsed faces of all prisms and
tetrahedra and attempts to reorient them such that the collapsed
face is not on a boundary surface. The boundary surface is
assumed to be represented by the current VSET. It is the user's
responsibility to create the appropriate VSET before using this
option. A reasonable approach to this could be with the
commands:
CSET NEWSET FLUID
VSET NEWSET SURFACE
CFLIP, NC1, NC2, NCINC, OPTION: Flips the definitions of a range or set of
cells by interchanging vertices (see Figure 3-32 on page 3-53 and Figure 3-33 on
page 3-53).
NC1, NC2,
NCINC
– Flips cells NC1 to NC2 by NCINC.
OPTION
– RIGHT. For fluid/solid bricks and prisms, the first and last four
vertices are interchanged. For fluid/solid pyramids and
quadrilateral shells and baffles, vertices 2 and 4 are
interchanged. For fluid/solid tetrahedra and triangular
shells/baffles, vertices 1 and 2 are interchanged. Flipping these
vertices reverses the right/left-handedness of a cell.
– PRISM. Finds all incorrectly defined prisms, tetrahedra and
pyramids in a given range and interchanges their vertices to
produce correctly defined cells. For example, 1 1 2 3 4 4 5 6
becomes 2 3 1 1 5 6 4 4.
– COLLAPSE. Looks at the collapsed faces of all prisms and
tetrahedra and attempts to reorient them such that the collapsed
face is not on a boundary surface. The boundary surface is
assumed to be represented by the current VSET. It is the user’s
responsibility to create the appropriate VSET before using this
option. A reasonable approach to this could be with the
commands:
CSET NEWSET FLUID
VSET NEWSET SURFACE
3-58
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
OPTION
– TRIM. Trimmed cells badly defined using the CDX command
will be changed to have the correct definition.
CGENERATE, NSET, NVOFF, NC1(1), NC2(NC1), NCINC(1), VOPTION:
Generates a new set of cells by applying an offset to the vertices of a predefined set
— see Figure 3-36.
Version 3.26
NSET,
NVOFF
– Generates NSET groups incrementing all vertices by NVOFF.
The initial set is included in the NSET count.
NC1, NC2,
NCINC
– Initial set defined by NC1 to NC2 by NCINC.
VOPTION
– NONE. No vertices will be generated.
The following VOPTIONs create corresponding vertices of the
newly created cells:
– VGEN,IC,DX,DY,DZ,RATIO(1.). Generates vertices with
offsets DX, DY and DZ in the local coordinate system IC,
ratio-filling each successive set by RATIO.
– VREFLECT,IC,IDIR. Generates vertices by reflection in
direction IDIR of coordinate system IC. The cells generated
will usually be flipped to have the same sense (handedness) as
the selected range of cells. If IC is a cylindrical coordinate
system and IDIR = 1, then the cells do not need to be flipped
and will not be flipped. This option is only valid for NSET = 2.
3-59
MESH MODULE
Chapter 3
Cell Commands
Command: CGEN , 3 , 5 , 1 , 4 , 1
116
117
118
119
120
16
17
18
9
10
19
11
20
12
115
11
12
13
5
6
14
7
Generated sets
15
8
110
6
7
8
1
1
2
2
Figure 3-36
9
3
3
10
4
4
Starting set
105
5
Cell set generation using CGEN
CJOIN, NC1, NC2, NREPI(1), NCOFFI(0), NREPJ(1), NCOFFJ(0),
NREPK(1), NCOFFK(0): Joins two cells together and propagates this in a
structured mesh. Only brick (hex) cells can be joined.
NC1, NC2
– Cell numbers to be joined. Cell NC2 will be deleted.
NREPI,
NCOFFI
– The joining will be repeated NREPI times with a cell offset of
NCOFFI to NC1 and NC2 in the I direction (direction from
NC1 to NC2).
NREPJ,
NCOFFJ
– The joining will be repeated NREPJ times with a cell offset of
NCOFFJ to NC1 and NC2 in the J direction (any other
direction which is not NC1 to NC2).
NREPK,
NCOFFK
– The joining will be repeated NREPK times with a cell offset of
NCOFFK to NC1 and NC2 in the K direction (any other
direction which is not NC1 to NC2).
3-60
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
CLIST, NC1(1), NC2(NC1), NCINC(1), ICTID(ALL), OPTION: Lists a range
of cells.
NC1, NC2,
NCINC
– Lists cells NC1 to NC2 by NCINC. Using CCRS will list cells
by enabling cursor picking.
ICTID
– Only cells of this type within the range will be listed.
OPTION
– NORMAL. Normal listing of each cell’s vertices, up to eight
per line. For polyhedral cells, the eight nodes of the underlying
hexahedral cell are listed on the first line where the cell
number appears (with a zero placed in any column which
corresponds to a ‘missing’ vertex) and extra lines listing the
special vertices are displayed after this line.
– SHELL. This option, meant for listing of shells (and baffles)
only, enables the listing of the cell and face number of the face
of the three-dimensional cell to which the shell is attached.
This information is placed in the columns where the seventh
and eighth cell vertices would normally be listed.
CMODIFY, OPTION, NV1, NV2, NV3, NV4, NV5, NV6, NV7, NV8, ICTID:
Modifies the type or vertices of a cell or cells. For all the options listed below, the
cell type ICTID must exist in the cell table. If no ICTID is given or if the ICTID is
not defined, then ICTID defaults to the currently active cell type.
OPTION
– NC. Modifies a single cell number NC.
– CSET. Modifies all cells in the current set.
– ALL. Modifies all cells.
– CCRS. Modifies cursor-picked cells.
NV1, NV2,
…, NV8
– Modified vertex numbers. If a vertex field is left blank, then
that vertex is unchanged. If a vertex field defining an optional
vertex for the cell type ICTID (NV3 for lines, NV5 and NV6
for shells) is set to zero, then the vertex is removed from the
cell definition. If cell type ICTID is a shell and NV5 is set to
zero, then vertex 5 is removed and vertex 6 is moved to vertex
5.
ICTID
– Modified cell type. If no ICTID is given, ICTID defaults to the
currently active cell type (see command CTYPE).
CMREFINE, NC1(1), NC2(NC1), NCINC(1), ICPTID, FOPT1, MAPOPT,
CHKOPT: Refines cells of any type in three dimensions or extruded type cells
Version 3.26
3-61
MESH MODULE
Chapter 3
Cell Commands
(prisms, hexahedra, trimmed cell type 2 and trimmed cell type 8) in one or two
dimensions using midpoint subdivision, creating new couples, boundaries and
restart data as needed. Refinement options are set using the CMROPTION
command. Three-dimensional refinement is the default.
Refined cells and boundaries must not be compressed or otherwise renumbered
if the ability to un-refine is desired (see command CMUNREFINE). If a seed cell
face is used, all cells in the refine range must be connected. Baffles refined should
not reside on triangular faces of pinched hexahedron or pyramid cells. (Such cells
can be redefined as two or more cells prior to refinement.)
NC1, NC2,
NCINC
– Refines cells NC1 to NC2 by NCINC. NC1 may be replaced
by ALL, CSET or CCRS. If NC1 is CSET, the new cell set will
consist of the newly formed cells.
ICPTID
– Couple table number for new couples created. The default is
the currently active couple table number (see command
CPTYPE).
FOPT1
– BINARY (default). Refinement data file (case.refi) used
by the CMUNREFINE command will be written in binary
form.
– CODED. Refinement data file will be written in coded form.
MAPOPT
– MAP,LPOUT(case.smap). Post data will be mapped onto
the new geometry and written to a standard restart file LPOUT
in binary form as with the SMAP command. The MAP option
is the default if post data is loaded.
– NOMAP,,. Post data will not be mapped. The NOMAP option
is the default if no post data is loaded.
CHKOPT
– CHECK (default). Refinement will not proceed if the
command estimates that any memory parameters (MAXCEL,
MAXVRT, etc.) may be exceeded.
– NOCHECK. Refinement will proceed regardless of memory
parameters.
CMROPTION, REFOPT(3D,,), EDGOPT(ANGLE): Sets refine options for the
CMREFINE command.
REFOPT
3-62
– 3D,,. Refines cells in all three dimensions.
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
REFOPT
– REFDIM,DIROPT(CCRS,). Refines cells in one or two
dimensions.
– REFDIM.
– 1D. Refines cells in one dimension (parallel to extruded
face).
– 2D. Refines cells in two dimensions (perpendicular to
extruded face).
– DIROPT.
– NCLSEED,NFCSEED. The ‘extruded’ faces of cells in the
refine range are determined by a connectivity search
starting with cell NCLSEED with extruded face
NFCSEED. NCLSEED,NFCSEED can be replaced by
CCRS,.
– WALL,IWLREG(0). Cell faces on wall boundaries or
adjacent to baffles are designated as ‘extruded’ faces when
refining (useful when the desired refine range largely
consists of such cells). Region IWLREG will be used to
specify the refine direction for cells which have more than
one wall face.
– VECTOR,VOPT(PDAT),THRESHV(.866). Refines cells
according to a vector field.
– VOPT.
PDATA. The vector field used for refinement is stored in
post registers 1, 2 and 3. This option is used to refine cells
based on error, gradient or residual data.
DIRECTION. The vector field used for refinement is a
constant unit vector in a direction of the active coordinate
system. Therefore DIRECTION can be X, Y, Z, R, THETA
or PHI.
– THRESHV. A cell is refined in the i, j or k direction if the
corresponding component of its vector is greater than
THRESHV.
EDGOPT
– ANGLE,TOLANGE(0.0). Model edges are defined by
physical angles greater than TOLANGE degrees. An angle of
180 degrees entered for TOLANGE indicates that no model
edges are present in the refine range. An angle of 0 entered for
TOLANGE indicates that all surface edges in the refine range
are model edges; i.e. there will be no surface smoothing.
– SET. Model edges are defined by line cells in the current cell
set. Edge-defining line cells are automatically refined as well.
CMUNREFINE, NC1(1), NC2(NC1), NCINC(1), RANOPT, ICPTID,
SETOPT, MAPOPT: Un-refines a mesh refined via CMREFINE, updating and/or
restoring couples, boundaries and restart data as needed.
Version 3.26
3-63
MESH MODULE
Chapter 3
Cell Commands
Cells and boundaries must not have been compressed or otherwise renumbered
since refinement.
NC1, NC2,
NCINC
– Un-refines cells NC1 to NC2 by NCINC. NC1 may be
replaced by ALL, CSET or CCRS.
RANOPT
– ANY. Cells are unrefined if any offspring of the parent cell are
included in the cell range.
– ALL. Cells are only unrefined if all offspring of the parent cell
are included in the cell range.
ICPTID
– Couple table number for new couples created. The default is
the currently active couple table number (see command
CPTYPE).
SETOPT
– ADD (default). Restored cells will be added to the current cell
set.
– NEWSET. A new cell set consisting of the restored cells will
be made.
– NOSET. The current cell set will not be changed.
MAPOPT
– MAP,LPOUT(case.smap). Post data will be mapped onto
the new geometry and written to a standard restart file LPOUT
in binary form as with the SMAP command. The MAP option
is the default if post data is loaded.
– NOMAP. Post data will not be mapped. The NOMAP option is
the default if no post data is loaded.
CREAD, LF(case.cel), NVOFF, NC1, NC2, OPTION, FOPT, NCOFF,
NCTOFF: Reads in a set of cell connectivity data from a file.
LF
3-64
– File name from which to read in cells. The first number is the
cell number. The next eight are vertices and the tenth is the cell
type ICTID referencing the cell table (CTABLE command).
The eleventh is a key based on the following table:
Key
Meaning
1
2
3
4
5
6
Fluid cell
Solid cell
Baffle
Shell
Line
Point
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
If the cell is a polyhedron requiring more than eight vertices,
then the ‘key’ is made negative and an additional record is
added.
NVOFF
– Offset to apply to vertices upon input.
NC1, NC2
– Reads only cells between NC1 and NC2 (default = all).
OPTION
– ADD. Adds the cells to the end of the cell list, regardless of the
cell numbers on the file.
– MODIFY. Uses the cell numbers on the file to overwrite
current cell definitions.
FOPT
– CODED. Reads a coded (ASCII) file in the format
(I9,6X,9I9,1X,I4).
NCOFF
– Offset to apply to cells (only works with the MODIFY option).
NCTOFF
– Offset to apply to cell type number
CREFINE, NDIVI(2), NDIVJ(NDIVI), NDIVK(NDIVI), NC1(1), NC2(NC1),
NCINC(1), MERGOPT, COUPOPT: Refines all cells in the specified range by
NDIVI, NDIVJ, NDIVK in the cell I, J, K directions respectively — see Figure
3-37. New cells and vertices are put at the end of the lists. All cells in the range are
deleted as they are processed. New cells are given the same type ID as their parent.
Prismatic cells must be subdivided such that NDIVI = NDIVJ = an even number (or
1). If a prismatic cell is in the range of cells to be subdivided, then if NDIVI is odd
and greater than 1, it will be set to NDIVI – 1 for that cell only. In addition, NDIVJ
will be set to NDIVI for that cell only. Pyramids and trimmed cells cannot be
subdivided and will be ignored. Tetrahedra will be ignored as well; they can only
be subdivided with the TETREFINE command.
Version 3.26
3-65
MESH MODULE
Chapter 3
Cell Commands
Commands: CREF , 3 ,,, 2 , 3 , 1 , MERGE
CREF , 3 , 3 , 4 , 6 , 7 , 1 , MERGE
9
10
5
6
1
Figure 3-37
2
11
7
3
12
8
4
Local mesh refinement using CREFINE
NDIVI
– Number of refined cells to create in cell I (V1-V2) direction.
NDIVJ
– Number of refined cells to create in cell J (V1-V4) direction.
NDIVK
– Number of refined cells to create in cell K (V1-V5) direction.
NC1, NC2,
NCINC
– Refines cells NC1 to NC2 by NCINC NC1 may be replaced by
ALL, CSET or CCRS.
MERGOPT
– MERGE. The VMERGE command will be called
automatically after all new cells and vertices have been
created. The merge will be limited strictly to newly created
vertices.
– NOMERGE. No VMERGE will take place. It is up to the user
to merge newly subdivided cells to create continuity.
COUPOPT
– NOCOUPLE. Couples will not be generated at the interface
between refined and unrefined cells. Existing couples which
have either their master cells or all their slaves cells refined
will be deleted.
– COUPLE,ICPTID. Couples will be generated at the interface
between refined cells. Existing couples which have cells that
have been refined will be deleted and regenerated. All newly
generated couples will be given couple type ICPTID. If
ICPTID is left blank, then the current couple type will be used
(see command CPTYPE).
3-66
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
CREORDER, NC1(1), NC2(NC1), NCINC(1), ICSYS(1), DIROPT
or
CREORDER, /DONE/UNDO/: Reorders the cell list in the given range by sorting
their centroidal coordinates in the specified local coordinate system and direction.
Sorted cells are written to a scratch file and deleted. CREORDER, DONE first asks
if the user wishes to compress out all deleted cells and then reads the cells in the new
order back from the scratch file. CREORDER, UNDO aborts the entire process.
The command version using a cell range can be used as many times as necessary
until the entire model is covered.
NC1, NC2,
NCINC
– Reorders cells in the range NC1 to NC2 by NCINC.
ICSYS
– Local coordinate system to interpret centroids.
DIROPT
– Any one, two or three combinations of X, –X, Y, –Y, Z, –Z or
NOCHANGE. Sorting is done in the plus or minus X, Y or Z
directions. If more than 1 direction is indicated, then multiple
sorts are performed. If DIROPT = NOCHANGE, then the cells
in the set are written out in their current numeric order.
CRSE, CTYPE, OPTION(1): Generates a coarser mesh from the cells in the
current cell set.
CTYPE
– The cell type to be given to the cells of the coarser mesh.
OPTION
– 1. Act only on the core of the CSET.
– 2. Act only on the boundary of the CSET.
– 3. Act on both the core and the boundary of the CSET.
CSHELL, ICTID, NC1, NC2, NCINC: Associates shells (and baffles) with
adjacent fluid cells. This command is useful to redefine imported shells for use in
commands such as CPCREATE with the SHELL option. Location 7 of each
shell/baffle description will contain the associated cell number and location 8 will
contain the associated cell face. (Note that the associated face numbers will be
different in STAR models from what they are in ANSYS models.)
ICTID
Version 3.26
– Shells of this type will be associated with adjacent fluid cells.
Keyword ALL can be used to indicate all shells in the model.
3-67
MESH MODULE
Chapter 3
Cell Commands
NC1, NC2,
NCINC
– Range of fluid (or solid) cells to be considered for the
association. This limits the search procedure so that the
command can run faster.
CSPLINE, NSPL1(1), NSPL2(NSPL1), NSPLINC(1): Defines line cells at
splines. The currently active cell type must be of type LINE.
NSPL1,
NSPL2,
NSPLINC
– Splines from NSPL1 to NSPL2 in increments of NSPLINC
will be selected. SPLSET and SCRS are valid keywords for
this command.
CTABLE, ICTID(1), COPTION, ICOL, IPOR(0), IMAT(1), ISPIN(1),
IGROUP(0), LIMAT(1), IPROC(0), RADI, THICK(0.), FSMAT: Defines a cell
table entry.
3-68
ICTID
– Arbitrary reference ID for this entry. All cells generated with
this ICTID will have the characteristics associated with this
entry.
COPTION
– FLUID for fluid cells;
– SOLID for solid cells. These are only taken into account for
conjugate heat transfer problems.
– BAFFLE for four-noded wall cells (essentially zero thickness
walls).
– SHELL for dummy three-, four-, five- or six-noded cells. This
option is useful for some mesh generation functions (surface
representations) and post-processing functions (displays of
boundary data) but has no actual bearing on any STAR
analysis.
– LINE for dummy two-noded cells. This option is useful for
some mesh generation functions (wire-frame representations),
but has no actual bearing on any STAR analysis.
– POINT for dummy one-node cells. This option is useful for
some mesh generation functions (reference locations), but has
no actual bearing on any STAR analysis.
ICOL
– Colour table index for all cells referenced to this table.
IPOR
– Porous material property reference for all (FLUID) cells
referenced to this table. Use IPOR = 0 to indicate completely
free flowing fluid.
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
IMAT
– Material property (fluid or solid) reference number.
ISPIN
– Spin index used for implicit treatment of multiple rotating
frames of reference.
IGROUP
LIMAT
– Light material number (used in the LMATERIAL command to
determine material properties for light shading).
IPROC
– Processor (cpu) number to assign all cells referenced to this
cell table when using the manual decomposition method with
the distributed memory parallel version of (HPC) STAR. This
is not needed for serial versions of STAR.
RADI
– OFF. Radiation is off for the cells referenced to this table.
– ON. Radiation is on for the cells referenced to this table.
Radiation boundaries (see command RDEFINE) must be
placed between fluid cells with radiation on and fluid cells
with radiation off. When radiation boundaries are placed on a
couple interface between radiation and non-radiation fluid
cells, they must be placed on the cell with radiation on.
(Note: This option is meaningful for FLUID and SOLID cells
only.)
THICK
– Conduction thickness. Cells are considered to have this
thickness when calculating heat conduction. This option is
particularly useful for extruded baffles (see command
CBEXTRUDE) when extrusion to the actual thickness
interferes with the model. (Note: This number is meaningful
for SOLID cells only.)
FSMAT
– /LIGHT/HEAVY/. Initial free surface material (see command
FSURFACE). (Note: This option is meaningful for FLUID
cells only and only when free surface modelling is on.)
Example in tutorial: 2.5, 2.6, 2.7, 3.1, 4.2, 7.1, 7.3, 7.4, 7.5, 9.3, 9.6, 10.1, 10.2,
10.3, 11.1, 12.1, 13.1, 14.1, 14.2, 15.1
CTCOMPRESS: Compresses undefined/deleted cell table numbers out of the
model. Cell definitions are renumbered in accordance with the compressed list.
CTDELETE, ICTID1, ICTID2, ICTINC: Deletes cell table entry definitions. (In
order to delete any table entry, all cells referencing this entry must first be deleted
or modified to a different entry.)
Version 3.26
3-69
MESH MODULE
Chapter 3
Cell Commands
ICTID1,
ICTID2,
ICTINC
– Deletes table entries ICTID1 to ICTID2 by ICTINC.
CTLIST, ICTID1(1), ICTID2(ICTID1), ICTINC(1): Lists cell table entry
definitions.
ICTID1,
ICTID2,
ICTINC
– Lists table entries ICTID1 to ICTID2 by ICTINC.
CTMODIFY, ICTID1(1), ICTID2(ICTID1), ICTINC(1), OPTION: Modifies
cell table properties.
ICTID1,
ICTID2,
ICTINC
– Cell tables from ICTID1 to ICTID2 in increments of ICTINC
will be modified.
OPTION
– FLUID/SOLID/BAFFLE/SHELL/LINE/POINT/. The selected
range of cell tables will be modified to be fluid, solid, baffle,
shell, line or point.
– /COLOR/POROSITY/MATERIAL/SPIN/GROUP/LIMAT/
/THICK/,/IVAL/VAL/. The colour number, porosity index,
material number, spin index, group number, lighting material
number or conduction thickness of the selected range of cell
tables will be modified to value IVAL or VAL.
– PROCESSOR,IPROC. The processor number (CPU number
for manual decomposition of HPC STAR) of the selected range
of cell tables will be modified to value IVAL.
– /NAME, name. The name of the selected range of cell tables
will be modified to the specified name (maximum 80
characters, with no blanks or commas).
– RADIATION,/OFF/ON/. Radiation will be turned off or on for
the selected range of cell tables.
– FSMATERIAL,/LIGHT/HEAVY/. Initial free surface material
will be defined as light or heavy for the selected range of cell
tables.
3-70
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
CTNAME, ICTID, NAME: Defines an alphanumeric identifier for a CTABLE
entry.
ICTID
– Cell table entry number. The default is the currently active cell
table (see command CTYPE).
NAME
– A name of up to 80 characters to attach to this cell table. The
name may not have embedded blanks or commas.
CTRIM, ISTYPE, NV1, NV2, …, NVN: Defines a single trimmed cell (see Figure
3-34) of the same type as the currently active cell type.
ISTYPE
– If ISTYPE is 1 to 6 or 8, it is the trimmed type (trimmed type 8
is equivalent to trimmed type 6). The number of vertices
required is dependent on the trimmed type as follows:
Trimmed Cell Type
1
2
3
4
5
6 (8)
Number of Vertices
10
10
10
10
8
12
If ISTYPE is 0, the vertices are to be entered with ‘missing’
vertices denoted explicitly (by zeros), as in a CLIST. The
trimmed cell type will be determined based on the vertex
pattern. Note that not all vertex patterns are valid. Note further
that one cannot enter cells of trimmed type 6 or 8 this way, as
there are not enough fields.
NV1, NV2,
…, NVN
– Vertex numbers.
CTYPE, ICTID(1): Changes the currently active cell table number.
ICTID
– Pointer to an entry in the cell table (see command CTABLE).
14.2, 15.1
Version 3.26
3-71
MESH MODULE
Chapter 3
Cell Commands
CUNDELETE, NC1, NC2, NCINC, OPTION: Undeletes a set of cells. Any
deleted cell can be undeleted (reinstated) until the CCOMPRESS command has
been used. Note that CSET cannot be used as a range substitute in this command.
NC1, NC2,
NCINC
– Undeletes cells NC1 to NC2 by NCINC.
OPTION
– ALL. All deleted cells in the above specified range will be
reinstated.
– TYPE,ICTID. Only cells of type ICTID in the above specified
range will be reinstated.
CVREFLECT, ICSYS(1), IDIR(1), NVOFF(MAXN+1), CRANGE: Generates
cells by reflecting a given set of cells about a given local coordinate system axis.
New vertices and couples corresponding to vertices and couples belonging to the
original set of cells will also be generated. (Note: Couples will be generated
according to the tolerances set in the CPTOLERANCE command. Bad couples in
the original set of cells might not be generated.)
ICSYS
– Predefined local coordinate system number.
IDIR
– Axis of reflection (1, 2 or 3).
NVOFF
– Offset to add to vertex numbers of the original cells to form the
new cells. The default offset is the maximum vertex number
plus one.
CRANGE
– CSET (default). Cells in the current cell set will be reflected.
– ALL. All cells will be reflected.
– NC1,NC2(NC1),NCINC(1). Cells from NC1 to NC2 by
NCINC will be reflected.
CWRITE, LF(case.cel), NVOFF, NC1, NC2, ICTID(ALL), FOPT: Writes
a set of cell connectivity data to a file.
3-72
LF
– File name to which cells are written.
NVOFF
NC1, NC2
– Writes out only cells between NC1 and NC2 (default = all).
ICTID
– To write out only those cells of a specific type.
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
FOPT
(I9,6X,9I9,1X,I4).
CZONE, OPTION, ZOPTION: Modifies, deletes, or places a shell or baffle on
cells within a user-defined zone on the plot. If a normal (see-through) plot of the
cells is showing, then all cells with surfaces within the zone will be selected. If a
QHIDDEN or EHIDDEN plot is showing, then only the cells having surfaces within
in the zone pointing towards the user will be selected.
OPTION
– MODIFY,ICTID (default). Changes the cell table number of
the selected cells to type ICTID. ICTID defaults to the
currently active cell table number.
– DELETE. Deletes the selected cells.
– BAFFLE,ICTID(3). Adds a baffle to each selected face in the
selected cells. The baffles will have cell table number ICTID,
which must be previously defined.
– SHELL,ICTID(3). Adds a shell to each selected face in the
selected cells. The shells will have cell table number ICTID,
which must be previously defined. Shells are defined such that
their outward normals are consistent with the cell face on
which they are added (assuming that the starting cells are
right-handed).
ZOPTION
– ZONE (default). The zone is defined by an up to 20-sided
polygon drawn using the cursor. Mouse clicks define the
corners of the polygon.
– ALL. The zone is defined as the entire plot window.
FLIST, NCELL, NFACE(ALL): Lists the vertices on a cell face.
NCELL
– Cell number for which to list vertices.
NFACE
– Face number for which to list vertices. If NFACE is ALL or
left blank, vertices will be listed for all faces of cell NCELL.
Version 3.26
3-73
MESH MODULE
Chapter 3
Cell Commands
FWRITE, LF(case.fac), NVOFF, NC1, NC2, ICTID(ALL), FOPT: Writes
the cell face definitions to a file. The output is cell id, face id, and up to six vertices
defining the face.
LF
– File name to which faces are written.
NVOFF
NC1, NC2
– Writes out only faces for cells between NC1 and NC2
(default = all).
ICTID
– To write out only those faces for cells of a specific type.
FOPT
(I9,6X,7I9).
SHREFINE, NC1(1), NC2(NC1), NCINC(1), EDGOPT(SET,,),
DIVOPT(DIVIDE): Refines a surface or portion of a surface defined by shell cells,
thereby creating a smoother surface representation.
The refine range must be such that no two shells in the range have only one
vertex in common.
3-74
NC1, NC2,
NCINC
– Refines shells NC1 to NC2 by NCINC. NC1 may be replaced
by ALL, CSET or CCRS. If NC1 is CSET, the new cell set will
consist of the newly formed shells.
EDGOPT
– SET,,. Model edges are defined by line cells in the current cell
set while set-boundary corners are defined by vertices in the
current vertex set. Edge-defining line cells are automatically
refined as well.
– ANGLE,TOLANGE(180),TOLANGC(180). Model edges are
defined by physical angles greater than TOLANGE degrees
while set-boundary corners are defined by physical angles
greater than TOLANGC degrees. An angle of 180˚ entered for
TOLANGE or TOLANGC indicates that no model edges or
set-boundary corners are present in the refine range. An angle
of 0 entered for TOLANGE or TOLANGC indicates that all
edges or set-boundary vertices in the refine range are model
edges or set-boundary corners, i.e. there will be no surface
smoothing.
DIVOPT
– DIVIDE. Shells adjacent to the refine range are divided to
maintain connectivity of the surface.
– NODIVIDE. Shells adjacent to the refine range are not
divided.
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
TETALIGN, NC1(1), NC2(NCMAX), NCINC(1): Reorders the vertex
definitions of tetrahedral cells in a way which cuts the memory and time
requirements for the STAR solver for meshes which are all or predominantly
tetrahedral.
NC1, NC2,
NCINC
– Reorders tetrahedral cells NC1 to NC2 by NCINC. NC1 may
be replaced by ALL or CSET.
TETGENERATE, GOPTION: Generates a tetrahedral or hybrid mesh, or
smooths the vertices in the current cell set, depending on the option chosen.
GOPTION
Version 3.26
– SIZEOPT,VALUE,SMOOTHOPT,SWAPOPT,FILLOPT,
NREMSH,CHECKOPT,INTOPT. Discretises the
three-dimensional domain bounded by the shells or occupied
by the fluid or solid cells in the current cell set into
unstructured tetrahedral cells using the advancing front
technique. The shells in the cell set must form a closed surface.
If the cell set does not form a closed faceted surface (made by
triangles and/or quadrilaterals), the mesh will grow infinitely.
The normals of these shells should point outward from the
domain. The user should check that the surface is properly
closed before invoking TETGENERATE, for instance by using
the command SCHECK,ALL or letting ammbatch create a
valid surface with BAMM,SURFACE,DB1,DB2. However, as
a default, a surface check is executed on the initial shells and
the mesh generation is started only if the initial front pass the
check. The cell set may contain line cells to indicate explicitly
the edges. The vertices of the line cells may move only along
the edges specified by the line cells if surface smoothing is
selected.
– SIZEOPT. /SIZE/CELL/.
– VALUE. The desired cell size if SIZEOPT is SIZE or the
number of cells to be generated if SIZEOPT is CELL. The
default cell size is the size of the cells not too close to the
boundary of the domain. If SIZEOPT is CELL, a default cell
size is estimated such that the specified number of cells will be
generated. However, the number of actually generated cells
may differ significantly from the specified number.
3-75
MESH MODULE
Chapter 3
Cell Commands
GOPTION
3-76
– SMOOTHOPT. /NOSMOOTH/SMOOTH/. If SMOOTHOPT
is SMOOTH, local shell reconstruction and surface smoothing
operation will be carried out prior to the generation of
tetrahedra.
– SWAPOPT. /NOSWAP/SWAP/. If SWAPOPT is SWAP, edge
swap operation will be carried out.
– FILLOPT. /NOFILL/FILL/. If FILLOPT is FILL, the most
inner part of the domain will be filled with tetrahedra of the
same specified size and the same quality which is equal to
0.92951, which is the highest tetrahedral quality achievable for
a connected set of tetrahedra completely filling a domain.
– NREMSH. Number of times of local remeshing to be carried
out after the discretisation is completed. Typically, not more
than 100 tetrahedral cells of the worst quality (e.g. < 0.40) are
selected as well as the cells containing the vertices of these 100
cells. The volume occupied by these cells is then rediscretised.
If the quality of the regenerated cells is worse than that of the
original cells the original cells are recovered.
– CHECKOPT. /CHECK/NOCHECK/. If CHECKOPT is
CHECK, a surface check is performed before starting the mesh
generation. The generation starts only if the surface pass the
checks. If CHECK is NOCHECK, no surface check is
executed.
– INTOPT. This value is the cell table index of any internal shell
features within the surface. If INTOPT is a positive number,
shells with this cell type are treated as internal features during
the mesh generation. Note: Only one cell type can be used for
this function meaning that all internal shells must have the
same cell type.
– SMOOTH,ITERATION,RECOPT,SAVEOPT,CHECKOPT.
Smooth the vertices of the cells in the current cell set. If the
current cell set contains fluid and/or solid cells, the internal
vertices of the current cell set will be smoothed. If the current
cell set contains only shell and/or baffle cells, the vertices
which are not on corners and unmatched edges will be
smoothed. The shell or baffle cells do not have to form closed
surfaces. The cell set may contain line cells to explicitly
indicate the edges. The vertices of the line cells move only
along the edges specified by the line cells.
– ITERATION. Number of smoothing iterations to perform.
– RECOPT. /NORECO/RECO. If RECOPT is RECO, local shell
reconstruction will be carried out.
– SAVEOPT. /ADD/MODI/. If SAVEOPT is ADD, a set of
vertices and cells will be created and no modification will be
made to the cells in the cell set and their vertices. Otherwise,
the cells in the cell set and their vertices will be modified.
Version 3.26
Chapter 3
MESH MODULE
Cell Commands
GOPTION
– CHECKOPT. /CHECK/NOCHECK/. If CHECKOPT is
CHECK, a surface check is performed before starting the
smoothing. The smoothing starts only if the surface passes the
checks. If CHECK is NOCHECK, no surface check is
executed.
– HYBRID,NLAYER(1),SMOOTHOPT,SWAPOPT,CTYPE.
Invokes the hybrid mesher option. The current cell set must
contain the core hexahedral cells from a classification, plus the
polyhedral surface or subsurface. pro-STAR will proceed to
produce a ‘hybrid’ mesh, where the volume between the
hexahedral cells and the surface/subsurface is filled with
tetrahedral elements. Pyramid cells are used in the transition
area between the hexahedral and tetrahedral cells.
The surface or subsurface mesh to be used must be
completely enclosed, oriented, and composed of uniformly
shaped tetrahedral or hexahedral elements. The classified
hexahedral mesh should not contain any cell matches or
hanging nodes.
– NLAYER(1). The number of layers to strip off from the core
classified hexahedral mesh before making the pyramid
transition cells. A value of 0 is also allowed, meaning that the
first layer of hexahedral cells closest to the surface/subsurface
will be replaced by the pyramid cells.
– SMOOTHOPT. /NOSMOOTH/SMOOTH/. If the SMOOTH
option is chosen, surface smoothing and reconstruction will be
carried out prior to the tetrahedral mesh generation. This
option should not be used for subsurface meshes.
– SWAPOPT. /NOSWAP/SWAP/. If the SWAP option is chosen,
the edge swap operation will be carried out prior to tetrahedral
mesh generation. This option should not be used for subsurface
meshes.
– CTYPE. Specify the cell type of the new tetrahedral and
pyramid elements for the hybrid mesh. This cell table must
exist prior to mesh generation and must a FLUID or SOLID
cell type.
TETREFINE, NC1(1), NC2(NC1), NCINC(1), MEROPT: Refines all
tetrahedral cells in the specified range by a factor of 2 along each edge. New cells
and vertices are put at the end of the lists. All tetrahedral cells in the range are
deleted as they are processed. New cells are given in the same type ID as their
parent.
NC1, NC2,
NCINC
Version 3.26
– Refines tetrahedral cells NC1 to NC2 by NCINC. NC1 may be
replaced by ALL, CSET or CCRS.
3-77
MESH MODULE
Chapter 3
Coupled Cell Commands
MEROPT
automatically after all new cells and vertices have been
vertices.
to merge newly subdivided cells to create continuity.
CP, NCP(MAXCP+1), OPTION: Defines or adds cells to a couple. A couple
allows the faces of several slave (small) cell faces to connect to one master (large)
face. This can be used to simplify transitions between a coarse mesh and a fine
mesh. pro-STAR will determine if the cells can be coupled; if so, it then determines
the faces of the cells that will be so coupled. Values used to determine the validity
of potential couples can be set in the CPTOLERANCE command. A new couple
will be given the current couple type (see command CPTABLE). An existing couple
to which slave cells are being added will not change its couple type. A couple may
have up to NCPDIM–1 slaves, where NCPDIM is a parameter defined in
param.prp.
NCS1
NCS2
NCS3
NCS4
NCM
Figure 3-38
3-78
Slave cells
Master cell
Coupled set definition
NCP
– Couple number (default is the current maximum couple
number plus one).
OPTION
– NCM,NCS1,NCS2,…,NCS17. Defines couple number NCP
with master cell NCM and up to 17 slave cells (NCS1 to
NCS17). Couple NCP must not already be defined.
– ADD,NCS1,NCS2, …, NCS17. pro-STAR will attempt to add
up to 17 entered slave cells to couple NCP, which must already
be defined.
Version 3.26
Chapter 3
MESH MODULE
OPTION
– CCRS. A master cell and slave cells that define couple NCP
will be picked by the cursor. Couple NCP must not already be
defined.
– ACCRS. pro-STAR will attempt to add cursor-picked slave
cells to couple NCP, which must already be defined.
CPCHECK, TOLIN, NCP1(1), NCP2(NCP1), NCPINC(1), SETOPTION,
TOLAR(0.05), FOPT: Performs a set of checks on the given range of couples to
help determine their validity. The command checks that:
1.
2.
3.
4.
5.
6.
7.
8.
All cells in a couple exist and are either fluid or solid.
All slave faces in a couple overlap the master face.
All fluid cells in a couple have the same porosity index.
A master face of a couple is not also a slave face in any other couple.
A master cell of a couple is not also a slave cell in the same couple.
There are no invalid partial boundaries (see TOLAR option below).
If CPFLAG is EXCLUDE, couples do not have both fluid and solid cells.
If MFRAME is IMPLICIT, all fluid cells in a couple have the same spin
index.
9. For couples with partial boundaries turned on, the cells in the couple are
either all fluid or all solid.
pro-STAR will also calculate the total master, slave and overlap areas for all the
correctly matched couples in the range.
Note: It is recommended that the CPMERGE command should be used to catch and
fix certain couple problems (such as duplicate couple definitions and duplicate slave
definitions) before using the CPCHECK command.
TOLIN
– Tolerance value for determining whether a vertex on a slave
face falls within the bounds of the master face (i.e. the master
face is expanded by a factor of 1 + TOLIN when checking).
The default is set by the CPTOLERANCE command.
NCP1, NCP2, – Searches through couples NCP1 to NCP2 by NCPINC. NCP1
NCPINC
can be replaced with ALL or CPSET.
SETOPTION – NOSET (default). The CPSET is not altered by this
command.
– NEWSET. A new CPSET will be built from all couples which
fail the CPCHECK.
Version 3.26
3-79
MESH MODULE
Chapter 3
TOLAR
– Partial boundary checking ratio. pro-STAR will check all cell
faces in couples in the specified range that do not allow
partial boundaries and issue a warning for any of these cell
faces that have an uncovered area more than TOLAR times its
total face area. Setting TOLAR to 1.0 (or using the keyword
OFF) turns this check off.
FOPT
– NOFIX (default). Slave cells that do not overlap their master
cells will be flagged as errors. The couple definition will not
be changed.
– FIX. Non-overlapping slave cells will be removed from
couples. Couples that have no slave cells overlapping the
master cell will be deleted.
CPCOMPRESS: Compresses deleted couples out of the list.
CPCREATE, OPTION, ICPTID: Creates couples by finding matches based upon
the selection option described below. Tolerances used to determine whether cells
match are described in the CPTOLERANCE command.
OPTION
3-80
– NC1(1),NC2(NC1),NCINC(1). Searches through cells NC1 to
NC2 by NCINC to create matches.
– ALL. Searches through all cells to create matches.
– CSET. Searches through all cells in the current cell set to
create matches.
– TYPE,IMTYPE,ISTYPE. Searches through the current cell
set, matching master cells with cell type IMTYPE to slave
cells with cell type ISTYPE. IMTYPE and ISTYPE must be
either fluid or solid cell types. It is important to note that cells
that are not in the current cell set will not be matched using this
option.
– GROUP,IMGROUP,ISGROUP. Searches through the current
cell set, matching master cells with cell group IMGROUP to
slave cells with cell type ISGROUP. It is important to note that
cells that are not in the current cell set will not be matched
using this option.
Version 3.26
Chapter 3
MESH MODULE
OPTION
– SHELL,IMTYPE,ISTYPE. With this option, the user first
applies two layers of shell cells to the master/slave interface.
One layer (with cell type IMTYPE) should cover the potential
master faces, while the second layer (with cell type ISTYPE)
should cover the potential slave faces. It does not matter
whether or not these shells are in the current cell set when this
command is given. However, the fluid or solid cells to be
matched must be in the current cell set; fluid and solid cells
that are not in the current cell set will not be matched using this
option. The shell cells specified when using this option must
be created using the CFIND, CZONE, or CCROSS commands
on the existing fluid or solid cells. If they are not, the shells
must first be associated with the neighbouring fluid or solid
cells using the CSHELL command.
ICTID
– Couple table to which the new couples will belong. The default
is the current couple type (see command CPTYPE).
CPDELETE, NCP1(1), NCP2(NCP1), NCPINC(1), OPTION: Deletes a range
of couples.
NCP1, NCP2, – Deletes couples numbered NCP1 to NCP2 by NCPINC.
NCPINC
OPTION
– NOSET. Current CELL set is not used to decide whether to
delete the couples.
– CSET,ANY. Couple is deleted if any of its cells are in the
current cell set.
– CSET,ALL. Couple is deleted only if all of its cells are in the
current cell set.
CPFACE, NCP(MAXCP+1), NC1, NF1, NC2, NF2, …, NC9, NF9: Defines a
couple using cell numbers and face numbers.
NCP
Version 3.26
– Couple number. The user can add more faces to the defined
couple by using the couple number over again. Each couple
can contain up to NCPDIM faces (including the master or
prime face).
A new couple will be given the current couple type (see
command CPTABLE). An existing couple to which slave cells
are being added will not change its couple type.
3-81
MESH MODULE
Chapter 3
NC1, NF1, – The connected cell numbers and their corresponding face
NC2, NF2, … numbers. The first cell defined is the master or prime cell face.
If additional slave faces are required, the CPFACE command
can be issued subsequently with the same couple number.
Note: The CPFACE command does not check that the entered cells overlap, nor
does it check that a couple is unique. It is recommended that the CPMERGE and
CPCHECK commands be used to determine the validity of a couple.
CPFLAG, OPTION: Sets flag that allows/disallows fluid and solid cells in the
same couple.
OPTION
– INCLUDE. Solid-fluid interfaces will be included in the
creation of couples.
– EXCLUDE. Solid-fluid interfaces will be excluded from the
creation of couples.
CPFREEZE, LF(case.cpfz), OPTION: Freezes the location of vertices
attached to the slave faces of couples (CP command) with respect to the vertices of
the appropriate master face. The user can then move the master vertices and, by
applying the MAP option, force the slave face vertices back into their frozen
positions but relative to the new master locations. For example, if slave vertex 1 is
located exactly half way between master vertices 10 and 11, then after 10 and/or 11
are moved, vertex 1 will be forced back to the half way position between the new
positions of vertices 10 and 11.
LF
– File containing the relative position information. The file is
binary and sequential.
OPTION
– SAVE. The data pertaining to the positions of each vertex on
all slave faces is calculated with respect to the vertices of the
appropriate master face and written to file LF.
– MAP,TOL. The previously saved relative position data is read
from file LF and all slave vertices are forced back to their
original relative positions. pro-STAR also calculates a measure
of vertex distances from master edges or corners. If TOL is
greater than 0., any vertex whose distance measured from a
master edge or corner is within TOL will be moved to lie
exactly on the edge or corner (0. < TOL < 1.).
3-82
Version 3.26
Chapter 3
MESH MODULE
CPGENERATE, NREP, NCINCM, NCINCS, NCP1, NCP2, NCPINC,
OPTION: Generates additional couples by offsetting previously defined couples.
New couples are given the same couple type as the original couples. Values used to
determine the validity of potential couples can be set in the CPTOLERANCE
command.
NREP
– Generates NREP sets. The initial set is included in the NREP
count.
NCINCM,
NCINCS
– Increment each master cell number by NCINCM and each
slave cell by NCINCS.
NCP1, NCP2, – Initial couple range defined by NCP1 to NCP2 by NCPINC.
NCPINC
OPTION
– FINDFACE. The program increments cell numbers and then
attempts to find the correct master/slave matching faces. It
must be used when the second set of cells are not oriented the
same as the original cell set.
– KEEPFACE. The face numbers of the cells of the newly
created couples are identical to those of the original pattern.
No checks are made, so it is up to the user to ensure that the
orientations of the new cells are identical to the original cell
patterns.
CPLIST, NCP1(1), NCP2(NCP1), NCPINC(1), OPTION1, OPTION2: Lists
couple definitions.
NCP1, NCP2, – Lists couples NCP1 to NCP2 by NCPINC. NCP1 can be
NCPINC
replaced with CPSET or ALL.
OPTION1
– NOFACE (default). The list shows only cell numbers defined.
– FACE. The list shows cell numbers and the face numbers
found by pro-STAR for each match.
OPTION2
– NOSET (default). Current cell set is not used to decide
whether to list the couples.
– CSET,ANY. Couple is listed only if any of its cells are in the
current cell set.
– CSET,ALL. Couple is listed only if all of its cells are in the
current cell set.
CPMERGE, NCP1(1), NCP2(NCP1): Finds and merges couples with identical
Version 3.26
3-83
MESH MODULE
Chapter 3
master cell faces and removes duplicate couples. Also removes duplicate slaves
within a couple and slaves that are also defined as the master of the same couple.
NCP1, NCP2 – Searches through couples NCP1 to NCP2.
CPMODIFY, NCP, OPTION: Modifies a couple definition.
NCP
– A predefined couple number. If OPTION = TYPE or
REVERSE, then NCP can be replaced with CPSET or ALL.
OPTION
– TYPE,ICPTID (default). Changes the couple type of the
indicated couple(s). If ICPTID is left blank, the current couple
type will be used (see command CPTYPE).
– REVERSE. Creates new couples by switching the master and
slave cells of the indicated couple(s). The new couples will be
given the couple type of the original couple(s) they are created
from, and the original couple(s) will be deleted. It is
recommended that the CPMERGE command be run after
using this option in order to merge new couples with the same
master face.
For the next three options, ICPTID can be specified to change
the couple type of couple NCP. If ICPTID is left blank for these
options, the couple type will not change.
OPTION
3-84
– MASTER,NCNEW,NFNEW,ICPTID. Changes the master
cell/face of couple NCP. The new master will be cell NCNEW,
face NFNEW. If NCNEW is left blank, the master cell number
will not change. If NFNEW is left blank, the master face
number will not change. If CALC is substituted for NFNEW,
the face number will be calculated.
– SLAVE,ADD,NCNEW,NFNEW,ICPTID. Adds a slave to
couple NCP. The new slave will be cell NCNEW, face
NFNEW. NCNEW and NFNEW may not be left blank. If
CALC is substituted for NFNEW, the face number will be
calculated.
– SLAVE,NSL,NCNEW,NFNEW,ICPTID. Changes slave NSL
in couple NCP. The new slave NSL will be cell NCNEW, face
NFNEW. If NCNEW is left blank, the slave NSL cell number
will not change. If NFNEW is left blank, the slave NSL face
number will not change. If CALC is substituted for NFNEW,
the face number will be calculated.
– SLAVE,DELETE,NSL1,NSL2,…,NSL16. Removes a list of
up to 16 slave numbers from the definition of couple NCP.
Version 3.26
Chapter 3
MESH MODULE
OPTION
– SLAVE,DELCELL,NC1,NC2,…,NC16. Removes a list of up
to 16 slave cell numbers from the definition of couple NCP.
Values used to determine the validity of potential couples can be set in the
CPTOLERANCE command.
CPREAD, LF(case.cpl), NCP1(1), NCP2(NCP1), NCPOFF(0), NCOFF(0),
OPTION, FOPT, TOPT, NTOFF(0): Reads couples from a file.
LF
– File name from which to read couples.
NCP1, NCP2 – Couples from NCP1 to NCP2 in the file will be read. NCP1
can be replaced by ALL. If NCP1 and NCP2 are left blank, all
couples in the file will be read.
NCPOFF
– Offset for couple numbers. This is ignored if OPTION is
ADD.
NCOFF
– Offset for cell numbers.
OPTION
– ADD. Adds the couples to the end of the couple list, regardless
of the couple numbers on the file.
– MODIFY. Uses the couple numbers on the file (plus the offset
NCPOFF) to overwrite current couple definitions.
FOPT
– CODED. File LF is a coded (ASCII) file in the following
format: (I8,1X,I5,1X,I8/,7(I9,I2)) for
NCP,NCELL,ICPTID/CELL1, FACE1,CELL2,FACE2,…/.
– BINARY. File LF is a binary file.
TOPT
– TYPE (default). Reads couple type numbers from the file. This
option should not be used if one is reading an older (pre
version 3.01) couple file (The coded format for the older file is
(I8,1X,I5/,7(I9,I2)).)
– NOTYPE. Does not read couple type numbers from the file.
Couples read in will be assigned the current couple type. This
option should be used if one is reading an older (pre version
3.01) couple file.
NTOFF
– Offset for couple table numbers. This is ignored if TOPT is
NOTYPE.
Note: The CPREAD command does not check that the cells of a couple overlap, nor
does it check that the couples read in are unique. It is recommended that the
CPMERGE and CPCHECK commands be used to determine the validity of a
couple.
Version 3.26
3-85
MESH MODULE
Chapter 3
CPSET, LOPT1, LOPT2: Builds a couple set. The set is used to define the range
of plotted couples (see command CPDISPLAY). The set can also be used in lieu of
any couple range commands throughout the program.
3-86
LOPT1
– ALL. Selects all couples for the couple set.
– NONE. Zeros out the current couple set.
– NEWSET. First clears the current couple set, then acts like
ADD.
– ADD. Adds a group of couples to the current set.
– DELETE. Deletes a group of couples from the current set.
– SUBSET. Re-selects a (smaller) group of couples from those
in the current set.
– INVERT. Inverts the current set (i.e. selects all unselected
couples and unselects all currently selected couples).
LOPT2
If LOPT1 is NEWSET, ADD, DELETE or SUBSET, then this
option may take any of the following forms:
– CLIST,LOPT3,NC1,NC2,NC3,…,NC16. Modifies the set by
selecting couples based on a list of up to 16 cells.
– COLOR,ICOL1(1),ICOL2(ICOL1),ICOLINC(1),COPTION.
Modifies the set by selecting only couples with the specified
master, slave, and/or overlap colours ICOL1 to ICOL2 by
ICOLINC. COPTION can be one of ANY (default),
MASTER, SLAVE, or OVERLAP. One may use the keywords
MCOLOR, SCOLOR, or OCOLOR in place of COLOR in lieu
of using a COPTION.
– CPLIST,NCP1,NCP2,…,NCP17. Modify the set using a list of
up to 17 couples.
– CPRANGE,NCP1(1),NCP2(NCP1),NCPINC(1). Modifies the
set using couples NCP1 to NCP2 by NCPINC. This is the
default LOPT2.
– CRANGE,LOPT3,NC1(1),NC2(NC1),NCINC(1). Modifies
the set by selecting couples based on a range of cells NC1 to
NC2 by NCINC.
– CSET,LOPT3. Modifies the set by selecting couples based on
the CSET.
– GROUP,IGRP1(0),IGRP2(IGRP1),IGRPINC(1). Modifies the
set by selecting only couples with the specified couple table
group numbers IGRP1 to IGRP2 by IGRPINC.
– NAME,CPTNAME1,CPTNAME2,…,CPTNAME16.
Modifies the set by selecting couples with couple table names
that appear in the list (CPTNAME1,…). Up to 16 names may
be entered, and they are not case-sensitive.
– NSLAVE,N(1). Modifies the set by selecting all couples with
N slaves.
– PBTOL,/OFF/ON/. Modifies the set by selecting all couples
with partial boundaries off or on. One may also use the
keyword PBOFF for PBTOL,OFF and the keyword PBON for
PBTOL,ON.
Version 3.26
Chapter 3
MESH MODULE
LOPT2
– TYPE,ICPTID1(1),ICPTID2(ICTID1),ICPTIDINC(1).
Modifies the set by selecting couples with the specified types
ICPTID1 to ICPTID2 by ICPTIDINC.
LOPT3
If LOPT2 is CLIST, CRANGE or CSET, then this option may
take any of the following forms:
– ANY (default). Modifies the set by selecting couples with any
cells in the cell set/range/list.
– ALL. Modifies the set by selecting couples with all cells in the
cell set/range/list.
– NONE. Modifies the set by selecting couples with no cells in
the cell set/range/list.MASTER. Modifies the set by selecting
couples with master cells in the cell set/range/list.
– NOMASTER. Modifies the set by selecting couples with
master cells not in the cell set/range/list.
– ANYSLAVES. Modifies the set by selecting couples with any
slave cells in the cell set/range/list.
– ALLSLAVES. Modifies the set by selecting couples with all
– NOSLAVES. Modifies the set by selecting couples with no
CPTABLE, ICPTID(1), IGROUP(1), MCOLOR(2), SCOLOR(4),
OCOLOR(3), POPTION: Defines a couple table entry.
Version 3.26
ICPTID
– Arbitrary reference ID for this entry. All couples given this
ICPTID will have the characteristics associated with this entry.
IGROUP
MCOLOR
– Master face colour.
SCOLOR
– Slave face colour.
OCOLOR
– Master/slave overlap colour.
POPTION
– OFF (default). No partial boundaries allowed for this couple
type.
– ON,TOL(0.02). Partial boundaries are allowed for this couple
type. TOL is a tolerance used with couples to determine
whether faces that differ in area are classified as partial
boundaries and must be between 0 and 1. A partial boundary is
assumed when an area of more than TOL*(face area) cannot be
projected onto the matching faces. Setting TOL = 1.0 is the
same as disabling partial boundary capabilities for the couple
type.
3-87
MESH MODULE
Chapter 3
CPTDELETE, ICPTID1(1), ICPTID2(ICPTID1), ICPTINC(1): Deletes couple
table entry definitions. (In order to delete any table entry, all couples referencing
this entry must first be deleted or modified to a different entry.)
ICPTID1,
ICPTID2,
ICPTINC
– Deletes table entries ICPTID1 to ICPTID2 by ICPTINC.
CPTLIST, ICPTID1(1), ICPTID2(ICPTID1), ICPTINC(1): Lists couple table
entry definitions.
ICPTID1,
ICPTID2,
ICPTINC
– Lists table entries ICPTID1 to ICPTID2 by ICPTINC.
CPTMODIFY, ICPTID1(1), ICPTID2(ICPTID1), ICPTINC(1), OPTION:
Modifies couple table entry definitions.
ICPTID1,
ICPTID2,
ICPTINC
– Modifies table entries ICPTID1 to ICPTID2 by ICPTINC.
OPTION
– GROUP,IGROUP(1). Table entry group numbers will be
changed to IGROUP.
– MCOLOR,ICOLOR(2). Master face colour will be changed to
ICOLOR.
– SCOLOR,ICOLOR(4). Slave face colour will be changed to
ICOLOR.
– OCOLOR,ICOLOR(3). Overlap colour will be changed to
ICOLOR.
– PBTOL,/OFF/ON,TOL(0.02)/. Partial boundaries will be
turned off, or turned on with an area tolerance of TOL.
CPTNAME, ICPTID, NAME: Defines an alphanumeric identifier for a
3-88
Version 3.26
Chapter 3
MESH MODULE
CPTABLE entry.
ICPTID
– Couple table number. The default is the currently active couple
table (see command CPTYPE).
NAME
– A name of up to 80 characters to attach to this couple table.
The name may not have embedded blanks or commas.
CPTOLERANCE, TOLIN(0.01), TOLPL(0.25), TOLANG(15.0): Sets global
tolerance values used in the creation and checking of couples. These values are used
in the CP, CPCREATE, CPGENERATE and CPMODIFY commands (as well as in
the GEOMWRITE command when CHECKOPT = CHECK) and are used as
default values for the CPCHECK command.
TOLIN
face is expanded by a factor of 1 + TOLIN when checking).
TOLPL
– Tolerance value for determining whether the centroid of a slave
face falls on the plane of the master face (i.e. the out of plane
distance is limited by TOLPL multiplied by the average
thickness of the master cell perpendicular to the master face).
TOLANG
– Tolerance angle (in degrees) for matching the normal to a slave
face with the normal to the corresponding master face. The
normals ideally should match exactly (TOLANG = 0.), but the
effects of face warpage may require a higher number.
For each tolerance, an ‘F’ in its field will leave the current value unchanged. If
‘LIST’ is typed in the TOLIN field, the current values of the tolerances will be listed
without changing any of the values.
CPTYPE, ICPTID(1): Changes the currently active couple type ID.
ICPTID
– Pointer to an entry in the couple table (see command
CPTABLE).
CPWRITE, LF(case.cpl), NCP1(1), NCP2(NCP1), NCPOFF(0),
NCOFF(0), FOPT: Writes a range of couples to a file.
Version 3.26
3-89
MESH MODULE
Chapter 3
LF
NCP1, NCP2
– File name to which the matches are written.
Couples from NCP1 to NCP2 will be written. NCP1 can be
replaced with CPSET or ALL. If NCP1 and NCP2 are left
blank, all couples will be written.
NCPOFF
– Offset for couple numbers.
NCOFF
– Offset for cell numbers.
FOPT
– CODED. Writes a coded (ASCII) file in the following format:
(I8,1X,I5,1X,I8,/,7(I9,I2)) for NCP,NCELL,ICPTID/CELL1,
FACE1,CELL2,FACE2,…/.
3-90
Version 3.26
Chapter 4
CONVERT MODULE
Foreign Formats
Chapter 4
CONVERT MODULE
HELP
or
Foreign Formats
ANSYS, LE(case.elem), LN(case.node), ANSYSV: Reads or writes nodes
and elements using the ANSYS(1), PREP7, EWRITE and NWRITE command
format into/from pro-STAR data. pro-STAR will accept triangles and quads as shell
or baffle cells. It accepts tetrahedra, wedges and hexahedral (brick) elements as
fluid or solid cells. It also accepts two-noded elements as line cells and one- noded
elements as point cells. pro-STAR uses the ANSYS element type, material and real
constant fields to create a pointer to an entry in the cell table.
Note: The DIRECTION command determines whether data are to be read from
or written to the ANSYS file.
LE
– File name to read/write elements.
LN
– File name to read/write nodes.
ANSYSV
– /55/54/53/. Reads/writes in ANSYS 5.5, 5.4, or 5.3 (and older)
formats.
CGNS, LF(case.cgns), CELLFLAG: Reads grid data and writes grid and post
data in CGNS format. To read a grid, set DIRECTION = READ (DIRECTION
command). Existing cells, vertices, boundary regions and cell table entries are not
overwritten. A new (unique) cell table entry with a fluid cell type is created for each
CGNS zone. Each CGNS boundary region is assigned its own boundary region
number and is set to a boundary region type that is similar to the original CGNS
Version 3.26
4-1
CONVERT MODULE
Chapter 4
Foreign Formats
prescription. The original CGNS boundary type is listed in the Region Name. Cell
centred and vertex centred post data are read using the CGGCELL and
CGGVERTEX commands, respectively.
To write grid and post data, set DIRECTION = WRITE (DIRECTION
command) and load a post data file (LOAD command or TRLOAD and STORE
commands). All vertices and fluid cells are written to a single CGNS zone.
Trimmed cells are split into shapes supported by CGNS. All data on the post data
file (or all data at the stored iteration, for transient flows) is written to a single,
cell-centred CGNS solution.
LF
– File name of CGNS file.
CELLFLAG – /STANDARD/ALL/.
– STANDARD. Only the standard CGNS cell shapes are
considered valid for exporting. This option will cause the
export to abort if non-CGNS cell shapes are encountered in
the model or in the decomposed trimmed cells.
– ALL. All pro-STAR supported cell shapes are considered
valid for exporting. This option will force all cells to be
written, including non-CGNS cell shapes such as
tetpyramids and pinched hexahedra.
CGSTATS, LF(case.cgns): Lists the contents of the specified CGNS file.
DIRECTION, OPTION: Sets program to either read or write files for the ANSYS,
PATRAN, NASTRAN, IDEAS and CGNS commands.
OPTION
– /READ/WRITE/.
ENSIGHT, LF(case.geo) (READ ONLY)
or
ENSIGHT, OPTION (WRITE ONLY): Reads geometry data or writes out
geometry and/or post data in a form which can be read by the Ensight
post-processing visualisation program. Post data can be either cell, vertex, boundary
or wall data. A typical sequence of commands to write data might be:
cset news type 1
setwrite case.set
4-2
Version 3.26
Chapter 4
CONVERT MODULE
Foreign Formats
cset invert
setwrite case.set
load case.pst
ensi root
mymodel
ensi form bina
ensi all cell case.set
ensi done
The following option only applies when DIRECTION = READ (DIRECTION
command).
LF
– Name of Ensight geometry file. At present, only ASCII
(coded) files can be read.
The following options only apply when DIRECTION = WRITE (DIRECTION
command).
OPTION
Version 3.26
– ROOT. Prompts the user for a root name. Ensight files are
labelled:
root00001.case root00001.geo, …
The default root is ‘ENSI’.
– FORM,/BINA/CODE/. Determines whether Ensight files are
written in binary or coded (ASCII) representation. Binary files
read/write faster but may not be transportable between
different types of machines.
– GEOM,LFSET. Writes out the currently stored geometry (cell
and vertex data). If the user has written a set file (see command
SETWRITE), then each cell set is read in turn and assigned to
a different Ensight part number. In this way, the user can use
pro-STAR to identify different parts to the Ensight
post-processor.
– POST,LFSET. Writes out any post items stored in registers 1 to
6. The user can use the POST option as often as necessary to
dump out multiple post data items.
– BOTH,LFSET. Writes out both geometry and post data. If
LFSET is given, then look for a ‘SET’ file by that name.
– ALL,/VERT/CELL/CAVG/,LFSET. Writes out the geometry
data and ALL post data existing on the post file or all the data
existing on the transient post file for the currently stored time
step. Either cell data or vertex data can be written out as per the
option CELL or VERT. If option CAVG is specified,
cell-averaged cell data is written out, without the boundary
data. If LFSET is given, it looks for a ‘SET’ file by that name
as above. If a set file is specified, then each Ensight part will
correspond exactly to the user’s set. If no set file is given then
all fluid/solid cells will be written as part 1 and all
shells/baffles will be written as part 2.
4-3
CONVERT MODULE
Chapter 4
Foreign Formats
OPTION
– DONE. Signals to pro-STAR that the user is finished writing
out Ensight data. This causes the ‘.case’ file to be written
which identifies all the other geometry and post data items
written out.
ERANGE, NEMIN, NEMAX: Sets program to read/write elements within a
specified range.
NEMIN,
NEMAX
– Element (cell) range (default is all elements). CSET may be
used for the range on output only.
FV, OPTION: Writes geometry and post data in a form which can be read by the
Fieldview post-processing visualisation program.
OPTION
– ROOT,ROOTNAME(case). Specifies the root name for the
Fieldview files. The files are labelled ROOTNAME.uns (for
steady-state models) or ROOTNAME_stepnumber.uns (for
transient models). The default ROOTNAME is the current
pro-STAR case name. ROOTNAME can be up to 80 characters
long.
– WRITE. Writes both geometry and post data in the Fieldview
unstructured file format. The post data can only be vertex data.
GAMBIT, LF (case.neu): Reads in geometry data from the Gambit
pre-processing package.
LF
– File name of GAMBIT ASCII (coded) neutral file.
GR3D, LF(case.g3d), NBOFF(0), FOPT: Reads (only; cannot write in this
format) GRID3D formatted files of vertices and implied cell definitions. Each block
read in is given a new (unique) entry in the CTABLE.
LF
4-4
– File name from which to read data.
Version 3.26
Chapter 4
CONVERT MODULE
Foreign Formats
NBOFF
– Offset to apply to the CTABLE for each block. (i.e. the
CTABLE entry is BLOCK NUMBER + NBOFF.
FOPT
– CODED. Reads the data in coded (ASCII) form.
ICEM, LF(case.domain), /GEOM/POST/, /CELL/VERT/, /GETV/CAVE/,
WALL, HCOE, TBULK: Writes geometry and post data out in the ICEM domain
format. Post data can be vertex-centred or cell-centred.
IDEAS, LUNIV(case.unv), CTYPEOPT (READ ONLY)
or
IDEAS, LUNIV(case.unv), TOPT (WRITE ONLY): Reads or writes nodes
and elements using the IDEAS(4) Universal data file format into/from pro-STAR
data. pro-STAR will accept thin shell linear triangles and quads as shell or baffle
cells. It accepts linear tetrahedra, wedges and hexahedral solid elements as fluid or
solid cells. pro-STAR uses SUPERTAB’s PID as the pointer to an entry in the cell
table. The user may then modify the cell table as needed to identify fluid versus
solid (live versus dead) cells and/or baffles versus shell cells. IDEAS pressure
boundary definitions can also be interpreted. The load set ID is used for pro-STAR
region numbers while the actual pressure values are ignored. The user may also
write any currently loaded post data out in PATRAN neutral format.
LUNIV
– IDEAS Universal file name.
The following options only apply when DIRECTION = READ (DIRECTION
command).
CTYPETOPT – CTUNIQUE. pro-STAR will create cell types that preserve
the IDEAS material property id and colour id.
– CTPID. pro-STAR will create cell types that match the
IDEAS physical property id on a one-to-one basis.
The following options only apply when DIRECTION = WRITE (DIRECTION
command).
TOPT
– GEOM. The geometry data (nodes and elements) are written
out.
– POST. The currently loaded post data are written out.
Version 3.26
4-5
CONVERT MODULE
Chapter 4
Foreign Formats
NASTRAN, LBULK(case.nas) ROPTION (READ ONLY)
or
NASTRAN, LBULK(case.nas), WOPTION (WRITE ONLY): Reads or
writes nodes and elements using the NASTRAN(3) bulk data file format into/from
pro-STAR data. Fluid or solid (live or dead) cells must be CHEXA, CPENTA or
CTETRA elements. Baffles or shells may be CQUAD4 or CTRIA elements. Line
elements may be CBAR, CBEAM, CBEND, CGAP or CROD when reading in.
Line elements are always written out as CROD elements. pro-STAR uses
NASTRAN’s NPID as the pointer to an entry in the cell table. New cell table entries
are automatically defined in addition to the current ones when reading a NASTRAN
bulk data file. All nodes must be defined using the global Cartesian coordinate
system.
LBULK
– NASTRAN bulk data file name.
The DIRECTION command determines whether data are to be read from or written
to the NASTRAN file. The following option apply only when DIRECTION =
READ:
ROPTION
– TYPE (default). The NASTRAN NPID field is mapped to
pro-STAR cell table entries. NPID must be unique for each cell
type (i.e. fluid, shell, point, …).
– MATERIAL. The NASTRAN NPID field is mapped to
pro-STAR material numbers so that each unique NPID
represents a different fluid stream or solid material ID.
pro-STAR will create new cell table entries as necessary.
The following options apply only when DIRECTION = WRITE:
WOPTION
– STANDARD (default). All data fields are eight characters
wide. This may result in a loss of precision for vertex
coordinates.
– EXTENDED. All data fields are 16 characters wide. This
allows greater accuracy for vertex coordinates at the cost of a
larger file.
NRANGE, NMIN, NMAX: Sets program to read/write nodes within a specified
range.
NMIN,
NMAX
– Node (vertex) range (default is all nodes). VSET may be used
for the range on output only.
4-6
Version 3.26
Chapter 4
CONVERT MODULE
Foreign Formats
OFFSET, NVOFF, NCOFF: Sets program to offset nodes and/or elements before
input or output.
NVOFF
– Offset to add to nodes (vertices).
NCOFF
– Offset to add to elements (cells).
PATRAN, LP(case.pat) (READ ONLY)
or
PATRAN, LP(case.pat), TOPTION (WRITE ONLY): Reads or writes nodes
and elements using the PATRAN(2) neutral data file format into/from pro-STAR
data. pro-STAR will accept triangles and quads as shell or baffle cells. It accepts
tetrahedra, wedges and hexahedral elements as fluid or solid cells. pro-STAR uses
PATRAN’s PID as the pointer to an entry in the cell table. The user may then
modify the cell table as needed to identify fluid versus solid (live versus dead) cells
and/or baffles versus shell cells. PATRAN pressure boundary definitions can also
be interpreted. The load set ID is used for pro-STAR region numbers while the
actual pressure values are ignored. The user may also write any currently loaded
post data out in PATRAN neutral format. Wall data cannot be converted.
LP
– PATRAN neutral file name.
The DIRECTION command determines whether data are to be read from or written
to the PATRAN file. The following options apply only when DIRECTION =
WRITE:
TOPTION
– GEOM. The geometry data (cells and vertices) are written to
the file.
– POST,/CODED/BINARY/. The currently loaded post data are
written to the file in either coded (ASCII) or binary format.
TECPLOT, LF(/case.dat/case.plt/), FORMAT: Writes grid and post
data in Tecplot format. If a steady flow solution file is loaded (LOAD command),
grid coordinates, all post variables on the loaded file, and grid connectivity are
written to a single Tecplot zone. If a transient flow solution file is loaded (TRLOAD
command), all data at each time step is written to a separate Tecplot zone. Moving
grids and events (EVFILE command) are also accounted for. Each time step on the
transient flow solution file MUST contain the same post variables as all other time
steps.
Version 3.26
4-7
CONVERT MODULE
Chapter 4
IGES/VDA Commands
LF
– File name of Tecplot file. Default file name extensions
correspond to coded and binary data, respectively.
FORMAT
– /CODED/BINARY/. Only CODED (ASCII) format is
supported at this time. Use the Tecplot preplot utility to convert
to binary.
TGRID, LF(case.msh): Reads nodes and cells from a TGRID format file.
LF
– File name of Tgrid ASCII (coded) mesh file.
VRML, LF(case.vrml): Writes shells to a VRML style file. The range of shells
written to the file is determined by the ERANGE command. Only shells within this
range will be written. If vertex data exists in post register 4, it will be used for
contouring. Otherwise, only geometry data will be written.
LF
– File name on which to write data.
IGES/VDA Commands
CADHIDDEN: Modifies hidden parameters for the IGES/VDA conversion. It
should be used only if advised to do so by pro-STAR support.
CADSET, NVSTART(MAXV+1), NCSTART(MAXC+1),
NSPSTART(MAXS+1), CTSTART(MAXT), STSTART(MAXST),
GROPT(NONE), GRSTART(1), GRLAST(GRSTART), CLRSTART(2),
CLRLAST(7): Sets parameters used by the IGES and VDA commands to interpret
an IGES or VDA data file.
4-8
NVSTART
NCSTART
– Starting cell number.
NSPSTART
– Starting spline number.
Version 3.26
Chapter 4
CONVERT MODULE
IGES/VDA Commands
CTSTART
– Starting cell table ID number.
STSTART
– Starting spline table ID number.
GROPT
– NONE. All entities will be assigned to one group (GRSTART).
– /COLOR/ENTITY/FONT/LABEL/LEVEL/VIEW/UNIQUE/.
Created entities will be assigned group numbers such that all
entities belonging to a specified class of objects will have the
same group. For example, if three surfaces are represented in
IGES by one level and two by another, then the shells
representing these surfaces will be split into two groups.
GRSTART,
GRLAST
– First and last group numbers. If the number of groups required
is greater than (GRLAST – GRSTART + 1), then the group
number is rolled over starting again at GRSTART. The range
of group numbers used is important because the highest cell
table ID used is equal to CTSTART + 3 * (GRLAST –
GRSTART + 1) – 1.
CLRSTART, – First and last colour indices used. If the number of colours
CLRLAST
required is greater than (CLRLAST – CLRSTART + 1), then
the colour index is rolled over starting again at CLRSTART.
All entities of a single group are given the same colour index.
CADTRANSLATE, MAXSIZE(50.0), MINSIZE(5.0), DEVIAT(0.02),
MINANG(165.0), MXSLEN, SPLINE1D(Y/N/BOTH), OUTWHL(Y/N),
UNBLANK(N/Y): Sets geometrical parameters used by the IGES and VDA
commands to translate an IGES or VDA data file.
Version 3.26
MAXSIZE
– Maximum shell size.
MINSIZE
– Minimum shell size.
DEVIAT
– Difference between trim curve and facets.
MINANG
– Minimum angle (degrees between grid edges on curved
surfaces).
MXSLEN
– Maximum length of a surface (default = 10000.0).
SPLINE1D
– YES (default). All one-dimensional linear entities (lines, arcs,
splines) are converted to splines.
– NO. All one-dimensional linear entities are converted to
segmented line elements.
– BOTH. All one-dimensional linear entities are converted to
segmented line elements and splines.
4-9
CONVERT MODULE
Chapter 4
IGES/VDA Commands
OUTWHL
– YES (default). Puts out the entire surface entity if trimming
fails.
– NO. Does not put out the entire surface entity if trimming fails.
UNBLANK
– NO (default). Does not unblank the blanked IGES/VDA
entities.
– YES. Unblanks the blanked IGES/VDA entities. It is highly
recommended to set this option to YES if it is possible that part
of the model has not been translated by pro-STAR and the
number of blanked entities is greater than zero.
IGES, LF(case.iges), POPTION(VERBOSE): Reads IGES data from file LF
and translates them into pro-STAR entities. The translation is controlled by the
values set with the CADSET, CADTRA and IGNORE commands.
LF
POPTION
– BRIEF. Short summaries of converted entities are printed.
– VERBOSE. Much more comprehensive data about converted
entities are printed.
IGNORE, OPTION: Allows the user to selectively ignore (not convert) one or
more IGES or VDA entity types.
OPTION
– NONE. All entity types will be converted.
– ENTITY1,ENTITY2,…,ENTITY15. A list of up to 15 entity
types will not be converted.
– ALLEXCEPT,ENTITY1,ENTITY2,…,ENTITY15. Only
those entity types listed will be converted.
Valid entity types are: BSPLINE, BSURFACE, CIRCLE, CONIC, COPIOUS,
ELEMENT, LINE, OFFSET, POINT, PSPLINE, PSURFACE, REVOLSURF,
RULEDSURF, TABUCYL, and TRIMSURF.
STL, LF(case.stl), FOPT, MEROPT: Reads in a stereolithography (.stl)
file as a series of triangular shells.
LF
4-10
Version 3.26
Chapter 4
CONVERT MODULE
pro-STAR/STAR File Conversions
FOPT
– CODE. Reads the data in coded (ASCII) form.
– BSTL. Reads the data in a special binary format for STL files.
MEROPT
automatically after all new shells and vertices have been
vertices.
to merge the newly created vertices.
VDA, LF(case.vda), POPTION(VERBOSE): Reads VDA data from file LF
and translates them into pro-STAR entities. The translation is controlled by the
values set with the CADSET, CADTRA and IGNORE commands.
LF
POPTION
– BRIEF. Short summaries of converted entities are printed.
– VERBOSE. Much more comprehensive data about converted
entities are printed.
GENERIC, LF(case.gen): Allows the user to write out any generic command
that will be repeated for every vertex, cell or boundary in the current set. The user
will be prompted for a command string. Within that string must be one or more
keywords as defined below. The program will loop through either the cell set, vertex
set or boundary set replacing the keywords by the appropriate numbers. Integers
will be written in I9 format, and real numbers will be written in G16.9 format.
Version 3.26
Set
Keyword
Definition
Any
COUNT
– Counter.
Cell
ELEM
NE1, NE2, …, NE8
RE1, RE2, …, RE6
NER1, NER2, …, NER8
– Cell number.
– Associated vertex numbers.
– Currently stored cell post data.
– Currently stored vertex (post register 4)
data for any of the cell vertices.
Vertex
NODE
RN1, RN2, …, RN6
– Vertex number.
– Currently stored vertex post data.
4-11
CONVERT MODULE
Chapter 4
Set
Keyword
Definition
Boundary
BOUND
NB1, NB2, NB3, NB4
NBR
NBP
– Boundary number.
– Associated vertex numbers.
– Region number.
– Patch number.
LF
– File name on which to write out data.
PSTAR, INPOPT, LFIN(case.pst), OUTOPT, LFOUT(case.pstc):
Reads a STAR post data file in either coded or binary format and converts to binary
or coded format (as appropriate). Options INPOPT and OUTOPT must be different.
At least one of the binary files must correspond to the current computer type for
conversion.
INPOPT
– /BINARY/IEEE/CRAY/ALPHA/CODED/. Type of input file.
Types IEEE, CRAY and ALPHA are binary files.
LFIN
– Input post file name.
OUTOPT
– /CODED/BINARY/IEEE/CRAY/ALPHA/. Type of output file
desired.
LFOUT
– Output post file name.
PTCONVERT, INPOPT, LFIN(case.trk), OUTOPT,
LFOUT(case.trkc): Reads a STAR droplet track or particle track data file in
either coded or binary format and converts to binary or coded format (as
appropriate). Options INPOPT and OUTOPT must be different. At least one of the
binary files must correspond to the current computer type for conversion.
INPOPT
LFIN
– Input track file name.
OUTOPT
– /CODED/BINARY/IEEE/CRAY/ALPHA. Type of output file
desired.
LFOUT
– Output track file name.
4-12
Version 3.26
Chapter 4
CONVERT MODULE
RDPR, LF(case.proc), NOFF: Reads in a table of cell number versus processor
number. pro-STAR then creates a new cell table entry for each processor and
reassigns each cell to the correct cell table. Each CTABLE entry is given a colour
index equal to its processor number + 1 (colour = 1 is white and is not allowed).
After reading in this file, use the GEOM,,,,,MANUAL,NPROC to write out the
decomposed files.
LF
NOFF
– Offset in the CTABLE to start assigning new table entries. For
example, if NOFF = 20 then the cells for processor 1 are stored
as type 21, processor 2 as 22, etc.
SMCONVERT, INPOPT, LFIN(case.rsi), OUTOPT,
LFOUT(case.rsic): Reads a STAR solution monitoring file in either coded or
binary format and converts to binary or coded format (as appropriate). Options
INPOPT and OUTOPT must be different. At least one of the binary files must
correspond to the current computer type for conversion.
INPOPT
LFIN
– Input file name.
OUTOPT
desired.
LFOUT
– Output file name.
TSTAR, INPOPT, LFIN(case.pstt), OUTOPT, LFOUT(case.pttc),
ITSTART(1), ITFIN(99999), ITINC(1), AOPT(N/Y): Reads a STAR transient
post data file in either coded or binary format and converts to binary or coded format
(as appropriate). Options INPOPT and OUTOPT must be different. At least one of
the binary files must correspond to the current computer type for conversion.
Version 3.26
INPOPT
LFIN
– Input transient file name.
OUTOPT
desired.
LFOUT
– Output transient file name.
4-13
CONVERT MODULE
Chapter 4
ITSTART
– Initial time step to translate.
ITFIN
– Last time step to translate.
ITINC
– Time step increment.
AOPT
– If Y, an existing output file will be appended to.
Example in tutorial: None.
4-14
Version 3.26
Chapter 5
PLOT MODULE
Housekeeping
Chapter 5
PLOT MODULE
Housekeeping
HELP, OPTION
or
OPTION
– ACTION. Help for action commands.
– DATA. Help for data base commands.
– CHARACTERISTICS. Help for plot characteristics
commands.
– POST. Help for commands specifically related to
post-processing.
– COMBINATIONS. Prints a chart of all legal combinations of
terminal type, plot type and plot option.
NFILE, LF(case.plot), FILETYPE: Specifies the file to be used for the
neutral plot file.
LF
– File name. If the file has been used previously, then it will be
closed before the new file is opened, unless the old file is the
same as LF.
FILETYPE
– CODED (default). Neutral plot will be coded and is thus
machine-independent.
– BINARY. Neutral plot will be binary and is thus
machine-dependent, but will provide faster access.
RESET: Sets all plot specifications to their initial values.
Version 3.26
5-1
PLOT MODULE
Chapter 5
Housekeeping
SCDUMP, OPTION, FSTART(1): Turns the screen dump facility off/on.
OPTION
– OFF. No screen dumps take place.
– /XWD/GIF/PS1/PS2/EPS1/EPS2/. Screen dumps take place
after every screen plot in the specified formats to file
‘casename’f4no.extension where ‘frno’ is an incremental
number and ‘extension’ is the image format specified in lower
case. Note that the user can temporarily change the case name
using the CASE command.
FSTART
– Default frame number to start the screen dumps.
STATUS: Displays the status of all plot settings.
TERMINAL, IMODE, TERMINAL TYPE, MODE: Defines terminal type and
characteristics. Certain combinations of POPTION, PLTYPE, TERMINAL type
(vector/raster) and data type (cell or vertex) are not possible. For a complete list of
legal combinations, type HELP,COMBINATIONS.
IMODE
– For X-based terminals this option can be set to either
STANDARD or ALTERNATE. Most machines will plot faster
in STANDARD mode. However, a few older machines plot
faster if ALTERNATE is selected. The only effect that
changing this option has is on the speed of plotting. For
non-X-based screens (machines using OpenGL, for example)
this option has no meaning.
TERMINAL – /X/FILE/EXTENDED. Use X on any mainframe running
X-Windows software to indicate any eight-plane, colour, raster
output device. Use FILE to write subsequent plots to a neutral
file (default is case.plot, which can be changed using the
NFILE command), which can be plotted later on another
device using an auxiliary program supplied by your STAR-CD
representative. Use EXTENDED to enter OpenGL extended
mode. This mode provides faster plotting speed and allows
enhanced plotting options such as translucency to be used.
5-2
Version 3.26
Chapter 5
PLOT MODULE
Housekeeping
MODE
– This key defines how certain plots will look and the way in
which the neutral plot file will be written. The options are:
– VECTOR. VECTOR style plotting will be used (see
discussion of command PLTYPE). Hard copy devices like
pen plotters work only in VECTOR mode, while all other
devices can be driven in this mode if necessary. This is
generally the slowest (most CPU intensive) plotting mode.
– RASTER. RASTER style plotting will be used (see
discussion of command PLTYPE). All eight (or more) bit
workstations, and hard copy devices like POSTSCRIPT
colour laser plotters, will work in RASTER mode. Hidden
line plots are significantly quicker in RASTER mode than
VECTOR mode and filled polygons are used for all contour
plotting.
Note: For on-screen plots, the number of colour pens is restricted to NCAVAI (the
available number for the monitor) and, for hardcopy (FILE) plots, the number of
colour pens that can be used is 1000. Use the CLRPEN command to set the number
of pens to the desired value.
TSCALE, IFONT(1), PSIZE(DEFAULT): Allows resizing of text fonts used in
pro-STAR. Four fonts are used for various screen labels:
Font
Used For
Pointsize
1
Plot title, plot legend, graph title, main axes
14
2
Contour and vector scale
12
3
Secondary contour and vector scale (for droplets and
particle ribbons)
10
4
Entity numbers (NUMBER command), x and y tic labels
for graphs, local coordinate system axes
10
In addition, any of these fonts may be used for labels defined using the PLLABEL
command.
The pointsize is not written to the neutral file and will have no effect on plots that
are not rendered immediately on the screen. On many machines, the system
command xfontsel may be available to list available fonts. By default,
pro-STAR uses:
adobe-helvetica-medium-r-normal--PSIZE
This can be overridden with the use of environment variables STARFONT0,
STARFONT1, STARFONT2 or STARFONT3 to use any locally available font.
Version 3.26
5-3
PLOT MODULE
Chapter 5
Colour Table
IFONT
– Font number to resize (1, 2, 3, 4 or ALL).
IPOINTSIZE – Point size of a replacement font. The keyword DEFAULT can
be used to choose the default size for the font (listed above).
The size chosen must be available on your machine.
Colour Table
CLRFILL, OPTION, INDEX1, INDEX2, TYPE: Fills colour values between
two colour indices.
OPTION
– GEOM. Indicates that the following INDEX should modify
GEOMETRY pens.
– POST. Indicates that the following INDEX should modify
POST pens.
INDEX1,
INDEX2
– Pens between INDEX1 and INDEX2 will be modified.
TYPE
– RGB. The colours are filled by interpolating with the
Red/Green/Blue scale.
– CMY. The colours are filled by interpolating with the
Cyan/Magenta/Yellow scale.
– HLS. The colours are filled by interpolating with the
Hue/Lightness/Saturation scale.
– YIQ. The colours are filled by interpolating with the YIQ
(colour television) scale.
CLRLIST, OPTION, INDEX1(0), INDEX2(INDEX1), TYPE: Lists the
currently-defined colour map entries.
5-4
OPTION
– GEOM. Indicates that the following list refers to GEOMETRY
plots.
– POST. Indicates that the following list refers to POST (vector
and contour) plots.
INDEX1,
INDEX2
– Lists all RGB triplets for this range of indices.
Version 3.26
Chapter 5
PLOT MODULE
Colour Table
TYPE
– RGB. The list indices define a colour using the
– CMY. The list indices define a colour using the
– HLS. The list indices define a colour using the
– YIQ. The list indices define a colour using the YIQ (colour
television) scale.
CLRMODE, OPTION: Reverses the standard background/foreground colour
combination used for successive (colour) terminal plots.
OPTION
– STANDARD yields white lines and text on a black
background.
– REVERSE yields black lines and text on a white background.
CLRPENS, NSHADES(4), NCPENS(NCAVAI), POPTION: Sets the number of
colour pens for plotting.
NSHADES
– Number of colour shades to be used for light shadings. The
number of shades can be from 1 to 19.
NCPENS
– Total number of colour pens to use in a plot. For on-screen
plots, the number of colour pens is restricted to NCAVAI (the
available number for the monitor). NCAVAI is 59 for the
shared colourmap (default), 160 for the 8-bit colourmap and
1000 for the 12-bit colourmap. The 12-bit colourmap is only
available to those who have the hardware to support it. For
hardcopy (FILE) plots, the number of colour pens that can be
used is 1000. Each shade will be contoured using
NCPENS/NSHADES pens.
POPTION
– /NOPLOT/PLOT/. If the PLOT option is used, the current
colour table will be plotted.
Note: The PS file increases significantly in size as the number of pens per shade
increases.
Version 3.26
5-5
PLOT MODULE
Chapter 5
Colour Table
CLRTABLE, OPTION1, TRD
or
CLRTABLE, OPTION2, INDEX, R, G, B, TRNSLU, TYPE: Allows users to
supply their own table of RGB values for pre- or post-processing plots.
5-6
OPTION1
– PLOT. Produces a plot of the current colour table on the
screen.
– DEFAULT. Sets all colours back to the original definitions
supplied with pro-STAR.
– RGB. Sets the geometry colours to the original definitions and
the post colours to a smooth scale of colours from red to blue
depending on the number of pens used (CSCALE command).
– GRAY. Sets the geometry colours to the original definitions
and the post colours to a smooth grey scale depending on the
number of pens used (CSCALE command).
– ALT20. Sets the geometry colours to the original definitions
and the post colours to an alternate scale of colours useful for
post plots with more than 14 colours used (CSCALE
command).
TRD
– Translucency value to apply to the entire colour map.
(0. = completely transparent, 1. = completely opaque
(default)). Translucency is available only on machines using
GL graphics.
OPTION2
– GEOM. Indicates that the following INDEX and RGB triplet
should modify GEOMETRY plots.
– POST. Indicates that the following INDEX and RGB triplet
should modify POST (vector and contour) plots
INDEX
– An index into the colour map. INDEX 0 is background
(usually black) and INDEX 1 is foreground (usually white).
Indices 24-99 are used for light shading. Indices 2-21 can be
used for post-processing where 2 is the highest contour value
and 21 is the lowest. Geometry plots generally use indices 2-7
(red, green, blue, cyan, purple, yellow). Specifying F or blank
for an RGB or translucency value leaves the current value
unchanged.
R
– Red component of colour (0. ≤ R ≤ 1.).
G
– Green component of colour (0. ≤ G ≤ 1.).
B
– Blue component of colour (0. ≤ B ≤ 1.).
TRNSLU
– Translucency of this colour index (0. = completely transparent,
1. = completely opaque (default)) Translucency is available
only on machines using GL graphics.
Version 3.26
Chapter 5
PLOT MODULE
Action
TYPE
– RGB. The RGB indices define a colour using the
– CMY. The RGB indices define a colour using the
– HLS. The RGB indices define a colour using the
– YIQ. The RGB indices define a colour using the YIQ (colour
television) scale.
Action
BLKPLOT: Makes a plot of mesh blocks in accordance with the user-defined
block set and any other pertinent parameters. BLKPLOTS may be made with
PLTYPE = NORMAL, QHID or EHID (in raster terminal mode).
CLEAR: Clears the graphics screen.
CPLOT: Makes a plot of cells in accordance with the user-defined cell set and any
other pertinent parameters.
PAN, SX, SY: Centres a plot using either screen coordinates or the cursor. The
screen will automatically replot after issuing this command (see also command
CENTER). See Figure 5-1 on page 5-11.
SX, SY
– Screen coordinates of the new centre. Use the keyword HOLD
in place of either coordinate to leave the centre unchanged in
that coordinate direction. If both coordinates are left blank, the
screen cursor will be used to pick an arbitrary point on the
screen as a new plot centre.
PLTBACK, STATUS: Controls how the current plot is displayed on the screen.
Version 3.26
5-7
PLOT MODULE
Chapter 5
Action
STATUS
– OFF. The plot image is displayed on the screen as it is plotted.
– ON. The plot image is created in memory and then transferred
to the display. This gives the effect of the image popping onto
the screen.
REPLOT: Plots the last plot over again as long as current set of selected cells
(CSET) or vertices (VSET) has not changed. This command is generally much
quicker than VPLOT or CPLOT, but the program will not recognise changes to the
selected sets.
SCRDELETE, INDEX: Deletes the currently stored image in the area identified
by INDEX and de-allocates the memory used to store it.
INDEX
– The area where the image is stored (1-20).
SCRIN, INDEX, LINDEX, NTIMES, MININT, PAUSE: Displays an image
stored using the SCROUT command. Animation with up to 20 frames can be done
by storing the frames sequentially using the SCROUT command and then
specifying the start and end frames with the INDEX and LINDEX parameters of
this command.
5-8
INDEX
– The area where the image is stored (1-20). Also the first image
in a sequence if LINDEX is not zero.
LINDEX
– The index of the last image in an animation sequence (1-20).
NTIMES
– The number of times to repeat the animation. Use zero for a
continuous display that is terminated with control-c.
MININT
– The minimum number of intervals between each frame. An
interval is 1/60th of a second. For example, specifying this
parameter as 3 means that each frame will be displayed for at
least 1/20th of a second. Note: This feature may not be
implemented on all machines.
PAUSE
– The number of seconds to pause before repeating the
animation sequence. Note: this feature may not be
Version 3.26
Chapter 5
PLOT MODULE
Action
SCROUT, INDEX: Copies the current image to a storage area identified by
INDEX. Up to 20 images can be stored. The SCRIN command is used to re-display
the image.
INDEX
– The area where the image is stored (1-20).
SPLOT: Makes a plot of splines in accordance with the user defined spline set and
any other pertinent parameters.
TPLOT, T1, T2, TINC, ITSTRT(0), ITINC, /NOPLOT/: Calls the ‘NEWXYZ’
user subroutine to update and redisplay mesh geometry. This allows the user to
check the subroutine logic without the need to actually run STAR.
T1, T2, TINC – NEWXYZ is called from time T1 until time T2, incrementing
by TINC.
ITSTRT,
ITINC
– The time step number passed to NEWXYZ at time = T1 is
ITSTRT. Each subsequent time step number is incremented by
ITINC.
NOPLOT
– If the keyword NOPLOT is used in the seventh field then the
NEWXYZ subroutine is called and coordinates are updated but
no actual plotting occurs.
VPLOT: Makes a plot of vertices in accordance with the user defined vertex set and
any other pertinent parameters.
WHOLE, OPTION: Sets the plot window size and turns on/off the plot window
GUI.
Version 3.26
5-9
PLOT MODULE
Chapter 5
Action
OPTION
– ON. Removes most of the GUI surrounding the plot window
while expanding the window to the maximum screen size. This
is helpful when making animations because it uses the largest
number of pixels, thereby making the plotting resolution as
high as possible.
– OFF (default). Puts back the plot window GUI and returns the
window to its default size.
WPLOT: Makes a plot of the wall shells in accordance with the user-defined cell
set and any other pertinent parameters. Only WALL data items may be plotted on
these surfaces (see command GETWALL).
ZOOM, STATUS, SX1, SY1, SX2, SY2: Allows the user to zoom in on a portion
of the plot using either screen coordinates or the cursor device to define the region.
The screen coordinate system is defined in Figure 5-1.
STATUS
– /OFF/ON/BACK/. OFF returns the screen to the default (entire
picture) settings. ON re-draws the plot based on the given
screen coordinates. BACK re-draws the plot based on the
previous ZOOM command settings.
SX1, SY1
– Screen coordinates of one corner of the region to be enlarged.
SX2, SY2
– Screen coordinates of the opposing corner of the region to be
enlarged. If SX1, …, SY2 are all blank, then the terminal
crosshairs (cursor) will appear and the user should mark any
two opposite corners, respectively, of the region to be enlarged.
5-10
Version 3.26
Chapter 5
PLOT MODULE
Data Base Commands
(SX=10,SY=10)
(SX=13,SY=10)
Label
Info
Triad
(SX=0,SY=1)
SY
Plot title
Default window
SX
Figure 5-1
Screen coordinate system
Data Base Commands
BLKSET, LOPT1, LOPT2: Builds a block set. The set is used to define the range
of plotted blocks. The set can also be used in lieu of any block range commands
throughout the program.
LOPT1
Version 3.26
– ALL. Selects the entire block set.
– NONE. Zeros out the current block set.
– NEWSET. First clears the current block set, then acts like
ADD.
– ADD. Adds a group of blocks to the current set.
– DELETE. Deletes a group of blocks from the current set.
– SUBSET. Re-selects a smaller group of blocks from those in
the current set.
– INVERT. Inverts the current set (i.e. select all unselected
blocks and unselect all currently selected blocks).
5-11
PLOT MODULE
Chapter 5
Data Base Commands
LOPT2
– BLCRS. Modifies the set using the cursor to select a list of
blocks.
– BLKLIST,NBL1,NBL2,…,NBL15. Modifies the set using a
list of up to 15 blocks.
– BLKRANGE,NBL1,NBL2,NBLINC. Modifies the set using
blocks NBL1 to NBL2 by NBLINC.
– GRANGE,XMIN,XMAX,YMIN,YMAX,ZMIN,ZMAX,
IGSYS(1). Modifies the set using only blocks that fall
completely within the given geometric range, interpreted in
the local coordinate system IGSYS. Default ranges are
handled as follows: If any coordinate pair is left blank or the
value 0 is entered for both the MIN and MAX of that pair,
then the range for that axis defaults to the entire axis. If any
individual value is left blank (not zero), then that individual
value is set to -1.E30 if it is a MIN value or 1.E30 if it is a
MAX value.
– VSET,/ANY/ALL/. Modifies the set by choosing blocks with
vertices in the current VERTEX set. Use ANY if blocks with
any vertex in the VERTEX set are to be selected or ALL if
only blocks with all vertices in the VERTEX set should be
taken.
– ZONE. Modifies the set using the cursor to draw a polygon
around the selected blocks.
BSET, LOPT1, LOPT2: Builds a boundary set. The set is used to define the range
of plotted boundaries. The set can also be used in lieu of any boundary range
commands throughout the program.
LOPT1
5-12
– ALL. Selects the entire boundary set.
– NONE. Zeros out the current boundary set.
– NEWSET. First clears the current boundary set, then acts like
ADD.
– ADD. Adds a group of boundaries to the current set.
– DELETE. Deletes a group of boundaries from the current set.
– SUBSET. Re-selects a (smaller) group of boundaries from
those in the current set.
boundaries and unselect all currently selected boundaries).
Version 3.26
Chapter 5
PLOT MODULE
Data Base Commands
LOPT2
Version 3.26
– BCRS. Modifies the set using the cursor to select a list of
boundaries.
– BLIST,NB1,NB2,…,NB16. Modifies the set using a list of
up to 16 boundaries.
– BRANGE,NB1,NB2,NBINC (default). Modifies the set
using boundaries NB1 to NB2 by NBINC.
– CIRANGE,NCIN1(1),NCIN2(NCIN1),NCINC. Modifies
the set using boundaries that fall in the regions associated
with the couple interfaces NCIN1 to NCIN2 by NCINC.
– CYRANGE,NCY1,NCY2,NCYINC. Modifies the set using
boundaries that fall in the cyclic sets NCY1 to NCY2 by
NCYINC.
IGSYS(1). Modifies the set using only boundaries that fall
completely within the given geometric range, interpreted in
the local coordinate system IGSYS. Default ranges are
handled as follows: If any coordinate pair is left blank or the
value 0 is entered for both the MIN and MAX of that pair,
then the range for that axis defaults to the entire axis. If any
individual value is left blank (not zero), then that individual
value is set to –1.E30 if it is a MIN value or 1.E30 if it is a
MAX value.
– NAME,REGNAME1,REGNAME2,…,REGNAME16.
Modifies the set by selecting boundaries with region names
that appear in the list (REGNAME1,…). Up to 16 names
may be entered, and they are not case-sensitive.
– PATCH,NBP1(0),NBP2(NREG1),NBPINC(1). Modifies the
set by selecting only boundaries with the specified radiation
patch numbers NBP1 to NBP2 by NBPINC.
– REGION,NREG1(0),NREG2(NREG1),NREGINC(1).
Modifies the set by selecting only boundaries with the
specified region numbers NREG1 to NREG2 by NREGINC.
– RLIST,NREG1,NREG2,…,NREG16. Modifies the set by
selecting boundaries with region numbers that appear in the
list (NREG1,…). Up to 16 region numbers may be entered.
5-13
PLOT MODULE
Chapter 5
Data Base Commands
LOPT2
– SLIDE,/BOTH/MASTER/SLAVE/. Modifies the set by
selecting boundaries that are involved in the current sliding
event.
– VSET,/ANY/ALL/. Modifies the set by choosing boundaries
with vertices in the current vertex set. Use ANY if
boundaries with any vertex in the vertex set are to be selected
or ALL if only boundaries with all vertices in the vertex set
should be taken.
around the selected boundaries.
– /ATTACH/BAFFLE/CYCLIC/DEGAS/FREESTREAM/
/INLET/INTERNAL/NRPRESSURE/NRSTAGNATION/
/OUTLET/PRESSURE/RADIATION/RIEMANN/
/STAGNATION/SYMPLANE/TRANSIENT/WALL/.
Modifies the set by selecting all boundaries of the given
region type, regardless of region number.
CSET, LOPT1, LOPT2: Builds a cell set. The set is used to define the range of
plotted cells. The set can also be used in lieu of any cell range commands throughout
the program.
5-14
LOPT1
– ALL. Selects the entire cell set.
– NONE. Zeros out the current cell set.
– NEWSET. First clears the current cell set, then acts like ADD.
– ADD. Adds a group of cells to the current set.
– DELETE. Deletes a group of cells from the current set.
– SUBSET. Re-selects a (smaller) group of cells from those in
the current set.
– INVERT. Inverts the current set (i.e. select all un-selected cells
and un-select all currently selected cells).
– SURFACE. Selects all cells lying on the surface (of the most
recent plot) and make them the current set.
LOPT2
– ATSHELL. Modifies the set by selecting all baffles/shells
attached to the current cell set. Note that the current cell set
must contain the fluid/solid cells that the required shells are
connected to. The baffles/shells have been created a priori
using either CCROSS, CZONE, or CFIND or must be wall
shells created by the GETWALL/GETBOUNDARY
commands.
– BAFFLE. Modifies the set by selecting all baffle cells.
– BLKSET. Modifies the set by choosing cells defined by the
blocks in the current block set.
Version 3.26
Chapter 5
PLOT MODULE
Data Base Commands
LOPT2
Version 3.26
– BSET. Modifies the set by choosing cells attached to
– CCRS. Modifies the set using the cursor to select a list of
cells.
– CLIST,NC1,NC2,…,NC15. Modifies the set using a list of
up to 15 cells.
– COLOR,ICOL1(1),ICOL2(ICOL1),ICOLINC(1). Modifies
the set by selecting only cells with the specified colour
indices ICOL1 to ICOL2 by ICOLINC.
– CONNECTIVITY,/VERTEX/CELL/,NSEED(1),
/WHOLE/CSET/. Modifies the set by selecting cells that are
connected together by common vertices. NSEED is either a
seed vertex number or a seed cell number, depending on the
chosen option, at which the connectivity search will start.
Use the WHOLE option to search the entire model, and use
the CSET option to search only the current cell set.
– CPRANGE,NCP1(1),NCP2(NCP1),NCPINC(1),/BOTH/
/MASTER/SLAVE/. Modifies the set by selecting cells
contained in couples NCP1 to NCP2 by NCPINC. BOTH
(default) will select all cells in the couples, MASTER only
master cells and SLAVE only slave cells.
– CPSET,/BOTH/MASTER/SLAVE/. Modifies the set by
selecting cells contained in couples that are in the current
couple set. BOTH (default) will select all cells in the couples,
MASTER only master cells and SLAVE only slave cells.
– CRANGE,NC1,NC2,NCINC (default). Modifies the set
using cells NC1 to NC2 by NCINC.
– DSET. Modifies the set by selecting cells that contain
droplets that are in the current droplet set.
– FLUID. Modifies the set by selecting all fluid cells.
– FSMATERIAL,/LIGHT/HEAVY/. Modifies the set by
selecting cells with light or heavy initial free surface
material.
IGSYS(1). Modifies the set using only cells that fall
completely within the given geometric range as interpreted in
local coordinate system IGSYS. Default ranges are handled
as follows: if any coordinate pair is left blank or the value 0
is entered for both the MIN and MAX of that pair, then the
range for that axis defaults to the entire axis. If any individual
value is left blank (not zero), then that individual value is set
to –1.E30 if it is a MIN value or 1.E30 if it is a MAX value.
– GROUP,IGRP1(0),IGRP2(IGRP1),IGRPINC(1). Modifies
the set by selecting only cells with the specified group
numbers IGRP1 to IGRP2 by IGRPINC.
– HEXAHEDRON. Modifies the set by selecting all
hexahedral fluid and solid cells.
5-15
PLOT MODULE
Chapter 5
Data Base Commands
LOPT2
5-16
– LAYER,NC1,NV1,NV2,NV3. Modifies the set by choosing
what can be thought of as a ‘layer’ of cells. The layer is
described using a starting cell (NC1) and two or three
vertices. If NV1, NV2, and NV3 are all non-zero, then the
layer is propagated in the plane of the face of cell NC1
defined by the three vertices. If NV3 = 0, then the edge of
cell NC1 defined by vertices NV1 and NV2 points in the
direction that the layer is NOT propagated.
– LIMAT,ILM1(0),ILM2(ILM1),ILMINC(1). Modifies the set
by selecting only cells with the specified lighting material
numbers ILM1 to ILM2 by ILMINC.
– LINE. Modifies the set by selecting all line cells.
– MATERIAL,IMAT1(1),IMAT2(IMAT1),IMATINC(1).
Modifies the set by selecting only cells with the specified
materials IMAT1 to IMAT2 by IMATINC.
– NAME,CTNAME1,CTNAME2,…,CTNAME16. Modifies
the set by selecting cells with cell table names that appear in
the list (CTNAME1,…). Up to 16 names may be entered,
and they are not case-sensitive.
– NEIGHBOR,NOPTION. Modifies the set by selecting cells
that neighbour (share a vertex with) selected cells.
– NOPTION.
– CLIST,NC1,NC2,…,NC15. Selected cells are a list of up
to 15 cells.
– CRANGE,NC1(1),NC2(NC1),NCINC(1). Selected cells
are a range of cells NC1 to NC2 by NCINC. (Note that
CSET is not a valid replacement for NC1 here.)
– CSET. Selected cells are the current cell set. This option
may only be used with LOPT1 = ADD.
– PHEXAHEDRON. Modifies the set by selecting all pinched
(zero-length edge) hexahedral fluid and solid cells.
– POINT. Modifies the set by selecting all point cells.
– POROUS,IPOR1(0),IPOR2(IPOR1),IPORINC(1). Modifies
the set by selecting only cells with the specified porous
property indices IPOR1 to IPOR2 by IPORINC.
– PPERCENT,IREG(4),PCUT. Modifies the set using only
cells that fall within the top PCUT percent of the post data
using the data stored in post register IREG.
– PRANGE,IREG(4),VMIN(-1.0E30),VMAX(1.0E30).
Modifies the set using only cells that fall within the given
post data range using the data stored in post register IREG.
– PRISM. Modifies the set by selecting all prism
(wedge-shaped) fluid and solid cells.
– PROCESSOR,IPROC1(0),IPROC2(IPROC1),IPINC(1).
Modifies the set by selecting only cells with the specified
processor numbers IPROC1 to IPROC2 by IPINC.
Version 3.26
Chapter 5
PLOT MODULE
Data Base Commands
LOPT2
Version 3.26
– PTRACK,IPFILE(case.trk),NP1(1),NP2(NP1),
NPINC(1),TIME1(0.0),TIME2(1.0E30). Modifies the set by
selecting cells that particles NP1 to NP2 by NPINC have
passed through between times TIME1 and TIME2. The
particle tracks are read from file IPFILE.
– PYRAMID. Modifies the set by selecting all pyramidal fluid
and solid cells.
– RADIATION,/OFF/ON/. Modifies the set by selecting cells
with radiation off or on.
– SHELL,NVER. Modifies the set by selecting all shell cells
with NVER distinct vertices (either 3, 4, 5, or 6). If NVER is
3, then only legally defined three-sided shell cells will be
selected. If NVER is blank, then all shell cells will be
selected.
– SOLID. Modifies the set by selecting all solid cells.
– SPIN,ISPN1(0),ISPN2(ISPN1),ISPNINC(1). Modifies the
set by selecting only cells with the specified spin indices
ISPN1 to ISPN2 by ISPNINC.
– SURFACE,NCSEED(1),EDGE(/ON/OFF/),FANGLE(31.),
/NOCREATE/CREATE/,ICTID(1) or NEWTYPE. Modifies
the set by selecting only cells on a specified surface. The
surface is identified by selection of a cell face on the desired
surface. The boundary of the surface can be defined by
setting the EDGE option to ON and by setting an appropriate
value for the feature edge angle, FANGLE. Use the
NOCREATE option to search only for existing shells. The
CREATE option can be used to create new shells on the
selected surface of cell type ICTID or a new cell type if
NEWTYPE is entered.
– TETRAHEDRON. Modifies the set by selecting all
tetrahedral fluid and solid cells.
– THICK,THK1(0.),THK2(THK1). Modifies the set by
selecting only cells within the specified conduction thickness
range THK1 to THK2.
– TRIMMED,STYPE(/ALL/1/2/3/4/5/8/). Modifies the set by
selecting all trimmed fluid and solid cells, with type given by
STYPE.
– TYPE,ICTID1(1),ICTID2(ICTID1),ICTIDINC(1). Modifies
the set by selecting cells with the specified types ICTID1 to
ICTID2 by ICTIDINC.
– VISIBLE. Modifies the set by choosing only those cells that
are currently visible in the plot window.
– VSET,/ANY/ALL/FACE/. Modifies the set by choosing cells
with vertices in the current VERTEX set. Use ANY if cells
with any vertex in the VERTEX set are to be selected or ALL
if only cells with all vertices in the VERTEX set should be
taken. Use FACE if all vertices on any face are in the
VERTEX set for the cell to be selected.
5-17
PLOT MODULE
Chapter 5
Data Base Commands
LOPT2
around the selected cells.
The following options are allowed only if a current event is selected:
LOPT2
– EACTIVATED. Modifies the set using activated cells from the
current event step.
– ECFLUID,/ALL/NFL/. Modifies the set using cells with
changed fluid stream numbers from the current event step.
– EDEACTIVATED,/ALL/IFACE(1-6)/. Modifies the set using
deactivated cells from the current event step.
– EECELL. Modifies the set using excluded cells from the
current event step.
– EICELL. Modifies the set using included cells from the current
event step.
The following options are allowed only if events are loaded:
LOPT2
– ACTIVE. Modifies the set using all active cells up to the
current event loading time.
– ATTACH. Modifies the set using all cells that have attachments
up to the current event loading time.
– DEACTIVE,/ALL/IFACE(1-6)/. Modifies the set using all
deactivated cells up to the current event loading time.
DSET, LOPT1, LOPT2: Builds a droplet set. The set is used to define the range of
plotted droplets. The set can also be used in lieu of any droplet range commands
throughout the program. Note that because droplets are not part of the physical
model but are loaded from post or track data files, droplet set information is not
saved in the model file.
LOPT1
5-18
– ALL. Selects the entire droplet set.
– NONE. Zeros out the current droplet set.
– NEWSET. First clears the current droplet set, then acts like
ADD.
– ADD. Adds a group of droplets to the current set.
– DELETE. Deletes a group of droplets from the current set.
– SUBSET. Re-selects a (smaller) group of droplets from those
in the current set.
droplets and unselect all currently selected droplets).
Version 3.26
Chapter 5
PLOT MODULE
Data Base Commands
LOPT2
Version 3.26
– CSET. Modifies the set using only droplets that are contained
within the physical space of the current cell set. If droplets
were loaded using GETD,TRACK, all tracks whose initial
positions fall within the current cell set will be selected.
– DLIST,NDR1,NDR2,…,NDR15. Modifies the set using a
list of up to 15 droplets. If droplets were loaded using
GETD,TRACK, the list will refer to a list of track numbers
instead.
– DRANGE,NDR1,NDR2,NDRINC (default). Modifies the
set using droplets NDR1 to NDR2 by NDRINC. If droplets
were loaded using GETD,TRACK, the range will refer to a
range of track numbers instead.
IGSYS(1). Modifies the set using only droplets that fall
completely within the given geometric range as interpreted in
local coordinate system IGSYS. Default ranges are handled
as follows: If any coordinate pair is left blank or the value 0
is entered for both the MIN and MAX of that pair, then the
range for that axis defaults to the entire axis. If any individual
value is left blank (not zero), then that individual value is set
to -1.E30 if it is a MIN value or 1.E30 if it is a MAX value. If
droplets were loaded using GETD,TRACK, all tracks whose
initial positions fall within the given geometric range will be
selected.
If droplets were loaded using GETD, POST or GETD, INIT, the
following additional options are available:
– DCRS. Modifies the set using the cursor to select a list of
droplets.
– TYPE,ICTD. Modifies the set using only droplets with the
specified type ICTD.
around the selected droplets.
If droplets were loaded using GETD,POST only, the following
additional options are available:
– ACTIVE. Modifies the set using only active droplets.
– AGE,AMIN,AMAX. Modifies the set using only droplets
whose ages fall between AMIN and AMAX. Droplet ages
can be loaded using the DAGE command.
– DIAMETER,DMIN,DMAX. Modifies the set using only
droplets whose diameters fall between DMIN and DMAX.
– MASS,MMIN,MMAX. Modifies the set using only droplets
whose masses fall between MMIN and MMAX.
– STUCK. Modifies the set using only droplets that have stuck
to a wall and become immobilised.
– TEMP,TMIN,TMAX. Modifies the set using only droplets
whose temperatures fall between TMIN and TMAX.
5-19
PLOT MODULE
Chapter 5
Data Base Commands
LOPT2
– VMAG,VMIN,VMAX. Modifies the set using only droplets
whose velocity magnitudes fall between VMIN and VMAX.
SETADD, STATUS, ITEM: Sets whether or not newly created items (boundaries,
cells, couples, and splines) are to be added to the current item set. For example, after
issuing the command ‘SETADD, ON, CELL’, all newly created cells will be
automatically added to the current cell set.
STATUS
– OFF (default). Newly created items will not be added to the
current item set.
– ON. Newly created items will be added to the current item set.
ITEM
– /ALL/BOUNDARY/CELL/COUPLE/SPLINE/. The default
ITEM is ALL.
SPLSET, LOPT1, LOPT2: Builds a spline set. The set is used to define the range
of plotted splines. The set can also be used in lieu of any spline range commands
5-20
LOPT1
– ALL. Selects the entire spline set.
– NONE. Zeros out the current spline set.
– NEWSET. First clears the current spline set, then acts like
ADD.
– ADD. Adds a group of splines to the current set.
– DELETE. Deletes a group of splines from the current set.
– SUBSET. Re-selects a (smaller) group of splines from those in
the current set.
splines and unselect all currently selected splines).
LOPT2
– COLOR,ICOL1(1),ICOL2(ICOL1),ICOLINC(1). Modifies
the set by selecting only splines with the specified colour
indices ICOL1 to ICOL2 by ICOLINC.
Version 3.26
Chapter 5
PLOT MODULE
Data Base Commands
LOPT2
IGSYS(1). Modifies the set using only splines that fall
completely within the given geometric range, interpreted in the
local coordinate system IGSYS. Default ranges are handled as
follows: If any coordinate pair is left blank or the value 0 is
entered for both the MIN and MAX of that pair, then the range
for that axis defaults to the entire axis. If any individual value
is left blank (not zero), then that individual value is set to
-1.E30 if it is a MIN value or 1.E30 if it is a MAX value.
– GROUP,IGRP1(1),IGRP2(IGRP1),IGRPINC(1). Modifies the
set by selecting only splines with the specified group numbers
IGRP1 to IGRP2 by IGRPINC.
– SCRS. Modifies the set using the cursor to select a list of
splines.
– SPLLIST,NSPL1,NSPL2,…,NSPL15. Modifies the set using a
list of up to 15 splines.
– SPLRANGE,NSPL1,NSPL2,NSPLINC. Modifies the set
using splines NSPL1 to NSPL2 by NSPLINC.
– TYPE,ISTID1(1),ISTID2(ISTID1),ISTINC(1). Modifies the
set by selecting only splines with the specified types ISTID1 to
ISTID2 by ISTINC.
– VSET,/ANY/ALL/. Modifies the set by choosing splines with
vertices in the current VERTEX set. Use ANY if splines with
any vertex in the VERTEX set are to be selected or ALL if
only splines with all vertices in the VERTEX set should be
taken.
ZONE. Modifies the set using the cursor to draw a polygon
around the selected splines.
VSET, LOPT1, LOPT2: Builds a vertex set. The set is used to define the range of
plotted vertices. The set can also be used in lieu of any vertex range commands
LOPT1
Version 3.26
– ALL. Selects the entire vertex set.
– NONE. Zeros out the current vertex set.
– NEWSET. First clears the current vertex set, then acts like
ADD.
– ADD. Adds a group of vertices to the current set.
– DELETE. Deletes a group of vertices from the current set.
– SUBSET. Re-selects a (smaller) group of vertices from those
in the current set.
– INVERT. Inverts the current set (i.e. select all un-selected
vertices and un-select all currently selected vertices).
5-21
PLOT MODULE
Chapter 5
Data Base Commands
LOPT2
5-22
– BLKSET. Modifies the set by choosing vertices attached to
blocks in the current block set.
– BSET. Modifies the set by choosing vertices attached to
– CORNER,FANGLE(31.0). Modifies the set by choosing
vertices on the corners of the current cell set. Corners are
defined as vertices that belong to more than two edges (regular
corners) or to one edge (isolated corner), where an edge is
defined by adjacent surface faces whose normals differ by an
amount greater than or equal to the feature angle (FANGLE).
– CPSET,/BOTH/MASTER/SLAVE/. Modifies the set by
choosing vertices attached to all cell faces, master cell faces, or
slave cell faces in the current couple set.
– CSET,/ALL/FACE,NFACE/MIDSIDE/NOMIDSIDE/
– /POSITION,NPOS/. Modifies the set by choosing vertices
attached to cells in the current cell set. The user may choose to
select all vertices on these cells (default), to select only
vertices on face NFACE of these cells, to select only midside
or only non-midside vertices on these cells, or to select only
vertices at position NPOS on these cells.
– EDGE,FANGLE(31.0). Modifies the set by choosing vertices
on the edges of the current cell set. Edges are defined by
adjacent surface faces whose normals differ by an amount
greater than or equal to the feature angle (FANGLE).
IGSYS(1). Modifies the set using only vertices that fall within
the given geometric range, interpreted in the local coordinate
system IGSYS. Default ranges are handled as follows: If any
coordinate pair is left blank or the value 0 is entered for both
the MIN and MAX of that pair, then the range for that axis
defaults to the entire axis. If any individual value is left blank
(not zero), then that individual value is set to –1.E30 if it is a
MIN value or 1.E30 if it is a MAX value.
– GREGISTER,IGREG(1). Modifies set by using the values in
graph register IGREG. pro-STAR will use the integer
representation of each value in the register (although the values
in the graph register should be integer vertex numbers).
– PARTICLE,/ALL/IPART1,IPART2,IPARTINC/. Modifies the
set by choosing all vertices corresponding to initial particle
positions, or initial particle positions IPART1 to IPART2 by
IPARTINC.
– PRANGE,IREG,VMIN,VMAX. Modifies the set using only
vertices that fall within the given post data range using the data
stored in post register IREG.
Version 3.26
Chapter 5
PLOT MODULE
Plot Characteristics
LOPT2
– SENSOR,/ALL/ISENS1,ISENS2,ISENSINC/. Modifies the
set by choosing all sensor vertices, or sensors ISENS1 to
ISENS2 by ISENSINC.
– SPLSET. Modifies the set by choosing vertices attached to
splines in the current spline set.
– SURFACE. Modifies the set by choosing vertices on the
surface of the current cell set.
– VCRS. Modifies the set using the cursor to select a list of
vertices.
– VLIST,NV1,NV2,…,NV15. Modifies the set using a list of up
to 15 vertices.
– VRANGE,NV1(1),NV2(NV1),NVINC(1). Modifies the set
using vertices NV1 to NV2 by NVINC.
around the selected vertices.
ABSURFACE, STATUS: Turns the attach boundary surface display off or on.
When faces of a sliding mesh interface are defined as attach boundaries, the cells on
both sides of the interface are connected. Therefore, the attach boundary faces
become ‘hidden’ faces even if the mesh moves so as to expose them. Unless it is
specified that these faces are to be displayed (via ABSURFACE), they will not be
plotted.
STATUS
– OFF. Attach boundary surfaces are not plotted.
– ON. Attach boundary surfaces are plotted.
ANGLE, ANGROT(0.): Rotates the plot on the screen without changing the view.
The default orientation places the Y axis vertically unless VIEW = (0.,1.,0.), in
which case the X axis lies horizontally to the right.
ANGROT
– Angle in degrees to rotate the plot counter-clockwise.
AXISUP, AXIS(Y): Sets the default up axis direction for plots. The various
rotations allowed accumulate on top of this basic starting position.
Version 3.26
5-23
PLOT MODULE
Chapter 5
AXIS
– /X/Y/Z/.
BDISPLAY, STATUS: Adds a representation of user-defined boundary conditions
to the plot. The plot can be of any type other than a section plot. The boundary
conditions will show up on hidden-line plots, but are not taken into account during
the hidden-line process. If boundary numbering is activated (NUMB,BOUND,ON),
then numbers representing the boundary number will be shown. Similarly, if region
or patch numbering is turned on, then the associated boundary region number or
patch number will be shown. The boundary faces to be plotted can be selected by
the BSET command.
STATUS
5-24
– OFF. No boundaries are displayed.
– ON. Boundaries will be displayed and colour coded by
boundary type (i.e. all wall boundaries have 1 colour, outlets
another, etc.).
– PATCH. Boundaries will be displayed and colour coded by
radiation patch number (i.e. all boundaries in patch 1 will have
one colour, patch 2 another, etc.).
– CONTOUR,NREGION,TYPE. Boundary type will be colour
coded by contour value.
– NREGION. The region number to which the following types
will be applied.
– TYPE.
– (INLET)/U/V/W/T/DEN/TE/ED/UU/VV/WW/UV/VW/
/UW/
– (OUTLET)FSORMF
– (WALL)/U/V/W/TORTF/RESWT/NSC(1)/
– (STAGNATION)/PSTAGB/TSTAG/DCX/DCY/DCZ/
/TINTB/TLSCB/NSC(1)/
– (BAFFLE)/U/V/W/TORHF/RESWT/NSC(1)/
– (PRESSURE)/PR/T/TE/ED/NSC(1)/
– (FREE STREAM)/UINF/VINF/WINF/PINF/TINF/
/TEINF/EDINF/
– (TRAN SHOCK)/UINF/VINF/WINF/PINF/TINF/
/TEINF/EDINF/
– (RIEMANN)/UINF/VINF/WINF/TINF/PINF/
/TEINF/EDINF/NSC(1)/
– (NRPRESSURE)/PR/TE/ED/
– (NRSTAGNATION)/PSTAGB/TSTAG/DCX/DCY/DCZ/
/TINTB/TLSCB/NSC(1)/
– Note: The NREGION specified must also be included in the
BSET. When multiple regions of the same TYPE are defined,
they must all be reading values from the same table.
Version 3.26
Chapter 5
PLOT MODULE
CDISPLAY, STATUS, OPTION: Enables the user to overlay other plot types
over a cell plot.
STATUS
– /OFF/ON/.
OPTION
– ALL. Displays all of the following. The boundary display type
used is BREGION. The couple display type used is
CPMASTER.
– BREGION. Displays boundaries according to region
definitions.
– BPATCH. Displays boundaries according to patch definitions.
– SPLINE. Displays splines from the current spline set.
– BLOCK. Displays blocks from the current block set.
– BLKFACTORS. Displays block factors on blocks in the
current block set. Block factors show the number of cells and
spacing along each edge.
– VERTEX. Displays vertices from the current vertex set.
– CPMASTER. Displays couples in the current couple set.
Master coupled cell faces will be overlaid on slave coupled cell
faces. This is the same as CPDISPLAY, ON, SLAVE,
MASTER.
– CPSLAVE. Displays couples in the current couple set. Slave
coupled cell faces will be overlaid on master coupled cell
faces. This is the same as CPDISPLAY, ON, MASTER,
SLAVE.
– DROPLET. Displays droplets from the current droplet set. If
the plot is a contour plot and the droplets are filled according to
a physical property, a secondary scale will be displayed for that
droplet property. If the droplets are filled with a single arbitrary
colour and droplet velocity vectors are displayed, the
secondary scale will correspond to droplet velocity magnitude,
as represented by the vector colours. Note that if particle
ribbons are to appear on the same plot, the droplet scale will be
superseded by the particle ribbon scale.
Example in tutorial: 1.1, 3.1, 3.2, 4.1, 5.1, 8.1, 9.1, 10.1, 10.2, 10.3, 16.2, 17.2
CENTER, OPTION: Defines the plot centre (see also command PAN).
OPTION
Version 3.26
– AUTO (default). The plot will be auto-centred.
– CX,CY,CZ,ICSYS(1). The plot centre is at coordinates CX,
CY and CX in local coordinate system ICSYS.
5-25
PLOT MODULE
Chapter 5
OPTION
– SPOINT. The plot centre is at the point used to define the plane
of the last section plot.
– VERTEX,NV. The plot centre is at the coordinates of vertex
NV.
– CELL,NC. The plot centre is at the centroid of cell NC.
CPDISPLAY, STATUS, OPTION: Adds a representation of couples to cell faces
on the plot. If the couple number is activated (NUMB, COUPLE, ON), the couple
number will also be displayed. The colour used for master, slave and overlap
regions correspond to the colours defined for each couple type (see CPTABLE
command). Any master-slave combinations that do not overlap will be flagged as
errors.
STATUS
– OFF. No couples will be displayed.
– ON. Couples in the current CPSET will be displayed. (Only
faces of those couples that are on cells in the current CSET
will be displayed.)
OPTION
– SLAVE, MASTER (default). Slave faces will be plotted first,
master faces will be plotted last. Areas of overlap will be
plotted in the overlap colour.
– SLAVE. Only slave faces will be plotted.
– MASTER,SLAVE. Master faces will be plotted first, slave
faces will be plotted last. Areas of overlap will be plotted in the
overlap colour.
– MASTER. Only master faces will be plotted.
DISTANCE, PDIST: Changes the distance (and scale) of the plot.
PDIST
– User defined distance (if blank, plot will be auto-scaled to fill
the viewport).
EDGE, STATUS, FANGLE(31.): Turns on or off plotting of edges only.
STATUS
5-26
– /OFF/ON/.
Version 3.26
Chapter 5
PLOT MODULE
FANGLE
– Feature angle. Edges are defined by adjacent faces whose
normals differ by this angle or greater.
HRSDUMP, OPTION: Performs a high-resolution screen dump of the extended
mode plotting window. A sequence of tiles is generated and composited to form an
image of arbitrary resolution. The final image size is specified either in terms of a
resolution and page size for postscript output or an actual pixel size for .gif and
.png output.
OPTION
– PS/EPS,FILENAME,LEVEL(1). Writes a postscript or
encapsulated postscript image to file FILENAME. The image
will have the page properties specified by the
HRSDUMP,PAGE command. The LEVEL option selects
between level 1 and level 2 postscript — level 2 postscript will
create a smaller file but may cause incompatibilities with
certain printers.
– GIF/PNG,FILENAME. Writes a .gif or .png image to file
FILENAME. The image will have size specified by the
HRSDUMP,IMAGE command.
– PAGE,DPI(150),WIDTH(11.0),HEIGHT(8.5),MARGIN(0.5),
LANDSCAPE(TRUE). Sets the page properties for
subsequent calls to HRSDUMP with the PS or EPS option.
DPI specifies the resolution of the resulting postscript image.
WIDTH, HEIGHT, and MARGIN specify the size in inches of
the final postscript page and the margin around the image. The
LANDSCAPE option specifies whether the image should be
rotated 90 degrees on the page. The default sizes will generate
a postscript document that will best print on a sheet of
legal-sized paper.
– IMAGE,WIDTH(1600),HEIGHT(1200). Sets the image
properties for subsequent calls to HRSDUMP with the GIF or
PNG option. WIDTH and HEIGHT specify the size of the final
image in pixels. The actual image size will vary slightly to
maintain the aspect ratio of the pro-STAR plotting window.
LAYER, NAME, OPTION: The LAYER command takes the objects rendered to
the screen in extended mode pro-glm and stores them to a layer. These objects can
include cells, vertices, particle tracks, or any other plotting primitive. These layers
can then be hidden, shown, or cleared to create an arbitrary overlay of plotting
objects. The opacity of the objects in a stored layer can also be modified with this
command.
Version 3.26
5-27
PLOT MODULE
Chapter 5
OPTION
– STORE. Stores the current plot objects into layer NAME. The
current plot objects include all cells, vertices, particle tracks,
boundaries, splines, isosurfaces, etc. Objects stored in other
layers via the LAYER,STORE command will not be
duplicated — only the objects corresponding to the current
plot will be stored.
If a layer with the specified NAME already exists, it will be
overwritten by the new layer. Otherwise, a new layer will be
created with the given name.
– SHOW. Sets the visibility of layer NAME to visible.
– HIDE. Sets the visibility of layer NAME to invisible.
– DELETE. Deletes layer NAME.
– OPACITY,VALUE. Sets the opacity of layer NAME. All filled
faces in the layer will have their translucency value multiplied
by VALUE. A value of 1.0 will make the object fully opaque,
while a value of 0.0 will make the object invisible.
LIGHT, LNUM(1), STATUS, XL, YL, ZL, INTENSITY(1.0): Turns on or off
Phong style surface lighting effect for hidden-line plots. This command will work
only in raster mode (see command TERMINAL) with PLTYPE = EHID, CHID or
IHID. It also requires devices capable of showing more than 16 colours (more than
four-colour bit planes).
LNUM
– Light number from 1 to 10.
STATUS
– /OFF/ON/REVERSE/. If STATUS is blank, then it defaults to
the current STATUS (either OFF or ON). The following
arguments are applicable if STATUS is ON.
XL, YL, ZL
– Location of a point defining the direction that the light source
is coming from. The light source is assumed to be located at
an infinite distance. Alternatively, XL can have one of the
following values that describe the light position in terms of
the viewing direction or screen: TOP, TOPLEFT,
TOPRIGHT, LEFT, CENTER, RIGHT, BOTTOM,
BOTLEFT or BOTRIGHT. If all three fields are blank, the
default is TOPLEFT. Specifying “LX” in lieu of XL will
enable cursor picking of a face of a cell and the light source
direction will be set so that light hitting the cell face is
reflected in the viewing direction.
INTENSITY
– Value of intensity (0-1).
5-28
Version 3.26
Chapter 5
PLOT MODULE
LMATERIAL, LIMAT(1), PAMBIENT, PDIFFUSE, PSPECULAR, NEXP:
Sets the options for light shading. Light shading will work only in raster mode (see
command TERMINAL) with PLTYPE = EHIDDEN. It also requires devices
capable of showing more than 16 colours (more than four-colour bit planes). The
values of PAMBIENT, PDIFFUSE, PSPECULAR and NEXP are unchanged if the
field is left blank.
LIMAT
– Material number from 1 to 99 corresponds to the lighting
material number used in the cell table (CTAB) entry.
PAMBIENT
– Per cent light energy due to ambient lighting. If DEFAULT is
entered here, the following values are set: PAMBIENT = .2,
PDIFFUSE = .6, PSPECULAR = .2, NEXP = 7.
PDIFFUSE
– Per cent light energy due to diffuse lighting.
PSPECULAR – Per cent light energy due to specular lighting. (PAMBIENT +
PDIFFUSE + PSPECULAR) should add up to 1.
NEXP
– Specular lighting exponent (1 < N < 10).
LSWITCH, LOPT, EOPT: Turns light shading on and off without disturbing the
lighting parameters.
LOPT
– OFF. Turns light shading off.
– SHADE. Turns on PHONG style shading on a per face basis.
– SMOOTH. Turns on light shading but adds Gouraud
smoothing to produce more realistic lighting effects at the cost
of more time to produce the image.
EOPT
– /NOEDGE/EDGE/. If the EDGE option is used, the current
vertex set will be used as the basis on which to define the edges
of the object. A previously issued VSET, NEWSET, EDGE
will make the plots appear crisper at the edges.
MULTISWEEP, NSWEEP(10), NREP(1), EDGOPT, SPLOPT, NSPL: Sweeps
through the model in numerous ways. If the current picture is an isosurface, then
multiple isosurfaces are created from lowest value to highest. Otherwise, sections
(either planar or in a local system) are passed sequentially through the model.
Finally, if the SPLOPT is used, then sections are passed which track the spline and
remain perpendicular to the spline at each cut.
NSWEEP
Version 3.26
– Number of sections or isosurfaces to pass through the model.
5-29
PLOT MODULE
Chapter 5
NREP
– Number of times to pass through the model.
EDGOPT
– If EDGOPT = YES, then an edge plot will be overlaid for each
section. Otherwise, no edge will be produced and the sections
will overlay whatever the last plot type produced was.
SPLOPT
– If SPLOPT = SPLINE, then swept sections follow spline
number NSPL. If SPLOPT is blank, then sections are passed
corresponding to the current definitions used for the SPOINT
and SNORM commands.
NUMBER, OPTION, STATUS: Turns on or off numbering of items on plots. The
size of the font used for the numbers (on-screen plots) can be set in the TSCALE
command (font number 4).
OPTION
– /ALL/BLOCK/BOUNDARY/CELL/COUPLE/DROPLET/
/FACE/MAGNITUDE/PATCH/REGION/SPLINE/TYPE/
/VERTEX/VSET/. Defines item to be numbered. The
MAGNITUDE option refers to the magnitude of a contoured
scalar. The VERTEX option refers to all vertices on the plot,
while the VSET option refers to only the vertices in the current
vertex set. Turning the VSET option on turns the VERTEX
option off.
STATUS
– /OFF/ON/.
OVERLAY, STATUS: Allows user to overlay two or more plots without erasing
the screen in between.
STATUS
– /OFF/ON/.
PLARROW, LNUM, STATUS, NPEN(1), SXTAIL1, SYTAIL1, SXTAIL2,
SYTAIL2, SXHEAD, SYHEAD: Allows the user to add up to 100 different arrows
to the plot using screen coordinates or the cursor device to define the locations.
Arrows are not rotated, scaled or moved from their given positions unless
specifically relocated by the user. They also reappear until specifically turned off.
If all screen coordinates are blank then the program will prompt the user with the
cursor crosshairs to locate the three points of the arrow.
5-30
Version 3.26
Chapter 5
PLOT MODULE
LNUM
– Arrow identifier (1 < LNUM < 100).
STATUS
– /OFF/ON/.
NPEN
– Pen number (colour) to be used for this arrow.
SXTAIL1,
SYTAIL1
– Screen coordinates for arrow tail starting position.
SXTAIL2,
SYTAIL2
– Screen coordinates for arrow tail middle position.
SXHEAD,
SYHEAD
– Screen coordinates for arrow head position.
PLDISPLAY, STATUS, DOPTION: Sets which legend items to plot. Some items
can be moved to user-specified screen coordinates (SX,SY), where SX = 0 along
the left side of the screen and SY = 0 along the bottom of the screen. For these items,
SX may be replaced with the keyword CURSOR to enable screen picking of the
location.
.
Version 3.26
STATUS
– /ON/OFF/.
DOPTION
– ALL. All individual items listed below (at their default
locations).
– BOX. The box around the plot.
– DATE. The date.
– HEADING. On post plots, the two lines below the date (what
is plotted and the units).
– INFO. On post or geometry plots, everything except for the
box, logo, title and triad.
– ITERATION. The iteration or time data line.
– LOGO. The STAR-CD logo.
– MINMAX. On post plots, the MIN/MAX information.
– SCALE, SX(10.1), SY, WIDTH(0.5). On post plots, the
contour or vector scale, which can be moved to another
location (along with the post HEADING and MINMAX
information). The default for SY is directly underneath any
other plot information that is to be displayed. WIDTH is the
width of the scale boxes.
– TITLE, SX(0.15), SY(0.7), SPC(0.25). The title and subtitles,
which can be moved to another location. SPC is the spacing
between lines.
– TRIAD, SX(11.25), SY(1.0). The main coordinate system
triad, which can be moved to another location.
5-31
PLOT MODULE
Chapter 5
PLFACE, STATUS: Plots cell faces with colours keyed to the face numbers. It
works for fluid, solid, shell and baffle type cells. This plot can only be used for
PLTYPE = EHID, on colour raster type devices.
STATUS
– /OFF/ON/.
PLFIX, STATUS: Fixes the plot distance and centre at the location defined by the
previous plot (sets user-defined distance and centre) until overridden with
DISTANCE, CENTRE, ZOOM or PAN.
STATUS
– /OFF/ON/.
PLLABEL, LNUM, STATUS, NPEN(1), IFONT(1), SX, SY, OPTION: Allows
the user to add up to 20 different labels to the plot, using screen coordinates (see
Figure 5-1 on page 5-11) or the cursor device to define label starting locations.
Labels are not rotated, scaled or moved from their given positions unless
specifically relocated by the user. They also reappear until specifically turned off.
This command will prompt for the label text.
5-32
LNUM
– Label identifier (1 ≤ LNUM ≤ 20).
STATUS
– OFF. Label LNUM is no longer plotted on the screen.
– ON. Label LNUM will be plotted on the screen. The user will
be prompted for label text.
– FORMAT. Label LNUM will be plotted on the screen. The
user will first be prompted for a list of numeric parameters (see
command *SET) and then for an appropriate FORTRAN
format statement which will be used in conjunction with the
parameter values to create a label. The format statement must
use real number formats (D,E,F,G) and not integer formats (I).
NPEN
– Pen number (colour) to be used for this label.
IFONT
– Font number to be used to plot this label (1, 2, 3 or 4). For
screen plots, the size of the chosen font can be set using the
TSCALE command. For external plots, the default size of the
font will be used.
Version 3.26
Chapter 5
PLOT MODULE
SX, SY
– Screen coordinates for label starting position. If SX and SY are
blank, then the terminal crosshairs (cursor) will appear for the
user to mark the label position.
OPTION
– GLOBAL. Screen coordinates are in global screen units.
– LOCAL. Screen coordinates are with respect to the bottom left
hand corner of the currently defined window.
PLLOCALCOOR, STATUS, ICSYS1(1), ICSYS2(ICSYS1), ICSINC(1),
NPEN(1): Adds or removes coordinate axis triads to subsequent plots. The triads
are drawn at the origins and with the orientations of the individual local coordinate
systems.
STATUS
– /OFF/ON/.
ICSYS1,
ICSYS2,
ICSINC
– Turns triad drawing off/on for coordinate systems numbered
ICSYS1 to ICSYS2 by ICSINC.
NPEN
– The specified triads will be drawn with colour pen number
NPEN. This field is ignored if STATUS is OFF.
Note: Global coordinate systems 2 and 3 have the same location and orientation as
global coordinate system 1; their triads are not plotted if the triad for system 1 is
plotted. The triad for system 3 is also not plotted if the triad for system 2 is plotted.
PLMESH, STATUS, MESHPN(1), THICKNESS: Sets whether or not the cell
mesh lines are to be plotted. Also sets the mesh line colour. The colour chosen for
the mesh lines is also the colour used for any entity numbers to be plotted (see the
NUMBER command).
STATUS
– /ON/OFF/.
MESHPN
– Colour index to use for the mesh lines and entity numbers.
THICKNESS – Sets the thickness of the mesh lines (extended mode only). The
thickness can be set to a value less than one to produce thinner
mesh lines in high-resolution screen dumps with the
HRSDUMP command.
Version 3.26
5-33
PLOT MODULE
Chapter 5
PLRECALL, OPTION: Recalls the plot attributes saved in a plot table (see
command PLSAVE).
OPTION
– IPLOT. Recalls plot attributes from plot table IPLOT (min = 1,
max = 50).
– PLNAME. Recalls plot attributes from the plot table named
PLNAME.
PLSAVE, OPTION: Saves current plot attributes into a plot table or lists available
plot tables. The plot attributes in a saved plot table can be used using the
PLRECALL command. Attributes saved include view, angle, centre, distance,
section point and normal, plot type, colour scale, window size, lights and plot
display.
OPTION
– IPLOT,PLNAME. Saves current plot attributes into plot table
IPLOT (min = 1, max = 50). PLNAME is an optional name for
the plot table. PLNAME may not include any blanks or
commas and should not be more than 80 characters.
– LIST,/ALL/IPLOT/PLNAME/. The ALL option (default) lists
all the saved plot tables. Otherwise, the plot attributes in plot
table IPLOT or in the plot table named PLNAME are listed.
– CLEAR,/ALL/IPLOT1,IPLOT2(IPLOT1),IPINC(1)/
/PLNAME/. Clears all plot tables, plot tables IPLOT1 to
IPLOT2 by IPINC or the plot table named PLNAME.
PLTYPE, OPTION: Defines the type of plot. Certain combinations of POPTION,
PLTYPE, TERMINAL type (vector/raster) and data type (cell or vertex) are not
possible. For a complete list of legal combinations, type HELP, COMBINATIONS.
5-34
Version 3.26
Chapter 5
PLOT MODULE
OPTION
– /EHIDDEN/QHIDDEN/IHIDDEN/CHIDDEN/SECTION/
/NORMAL/.
– EHIDDEN (default). Hidden line plots using the ‘EXACT’
method. This procedure removes all hidden lines. It is only
moderately slower than the QHIDDEN procedure on raster
type terminals. It can be very CPU intensive for large models
on vector type output devices.
– QHIDDEN. Hidden line plot using the ‘QUICK’ method.
This procedure takes the exterior surfaces and throws away
all faces pointing away from the viewer. Except in the
simplest cases, it will not remove all hidden lines. It is,
however, much less CPU intensive (quicker) than the exact
method and will often yield helpful plots.
– IHIDDEN. Hidden line plots using the ‘EXACT’ method,
however only those surfaces for which all vertices are
contained in the current VSET are plotted. This allows the
user to extract and display the inner surface of an object.
– CHIDDEN. Clipped hidden plots where the plot is
EHIDDEN up to some predefined plane, and then clipped
beyond that section. The clipping plane is defined as a plane
passing through a point defined by the SPOINT command
and normal to the SNORMAL command definition. It may
be alternatively defined as a surface of constant value in any
local coordinate system by using the ‘LOCAL’ option of the
SPOINT command.
– SECTION. Plot a section cut through the model. The cut is
defined exactly as the clipping plane is defined in the
CHIDDEN option above.
– NORMAL. Standard see-through plots. No lines will be
hidden.
PROMPT: Allows the user to place up to three lines of character strings in the
message area underneath the plotting window. This can be used in user-defined
macros to prompt the user to supply required data or mouse click on an appropriate
item. PROMPT will ask for as many as three lines, but will stop asking for lines
after a completely blank line is entered. The message box can be cleared by entering
either PROMPT$ $ (PROMPT command followed by one blank line) or
PROMPT,CLEAR.
PSCREATE, ID(1), OPTION, NAME: Creates shells for both section and
Version 3.26
5-35
PLOT MODULE
Chapter 5
isosurfaces to be stored as a named collection of shells and vertices. This enables
features such as multiple hidden line surfaces, light shaded and PMAP (for example
map T on Pressure isosurfaces) be added to such surfaces.
ID(1)
– An identifier number assigned specifically to
Section/Isosurface shell collections, linked internally to cell
table ID.
OPTION
– /SECTION/ISOSURFACE/. Plot type option.
NAME
– Cell table name to be used for each section.
PSDELETE, OPTION: Deletes a range of section/isosurface shells.
OPTION
– ID1(1),ID2(ID1),IDINC(1),/NAME/ALL. The range can be
defined by a range of ids, or cell table name, or ALL.
QDRAW, OPTION: Turns on/off ‘quick draw’ mode. In this mode, a much
simpler representation of the picture is drawn during dynamic (mouse driven)
rotations/translations/zooms. When the mouse button is released, the full picture is
redrawn.
OPTION
– OFF. Quick mode is turned off. The full plot is drawn at all
times.
– BOX. During dynamic movement, the plot is replaced by a
simple box whose corners span the min/max x,y,z of the
picture.
– EDGE. During dynamic movement, the plot is replaced by an
outline of the edges of the picture. Edges are recalculated
during each CPLOT for which a hidden line/surface option is
selected. The edges require additional storage but yield a
picture that is easier to interpret than the basic BOX option.
Finding the edges also adds some time to the CPLOT
command.
RENDEROPT, OPTION: Sets advanced rendering options for extended mode
plotting.
5-36
Version 3.26
Chapter 5
PLOT MODULE
OPTION
– DEFAULT. Returns all advanced rendering options to default.
These options are: external plotting off, memory mode
medium.
– EXTERNAL,ON/OFF. Toggle external rendering mode.
If external rendering mode is on, non-cell features such as
particle tracks, droplets, vectors, and vertices will be hidden if
they are behind a solid-shaded surface. This is useful for
external aerodynamics such as flow around an automobile
body, since particle tracks will be properly obscured when they
pass behind the body. It can also be used in internal flows
along with translucency.
If external rendering mode is off (the default), all non-cell
features listed above will be rendered regardless of their true
visibility.
– MEMORY,LOW/MEDIUM/HIGH. Set extended mode
memory usage.
The extended mode pro-glm provides three different
memory models. Selecting the medium or high memory model
causes caching of graphical data such as face and vertex
normals. This can significantly speed up plotting time,
especially when smooth lighting is enabled with the
LSWITCH,SMOOTH command and when plotting edges.
As the memory model increases from LOW to MEDIUM to
HIGH, more data is cached leading to faster plotting but
increased memory usage. The initial, default value is
MEDIUM.
ROTATE, AXIS, ANGROT: Rotates the plot about the screen axis (see Figure 5-1
on page 5-11). This is an alternative to the VIEW command.
AXIS
– /X/Y/Z/.
ANGROT
– Angle in degrees to rotate picture.
SECMOVE, RATIO, OPTION: Moves the section definition and performs a
replot.
RATIO
Version 3.26
– The ratio to be used for the following options. Must be
between 0 and 1.
5-37
PLOT MODULE
Chapter 5
OPTION
– NORMAL (default). Moves the current section in its normal
direction, so that the new section is parallel to the current
section. The location of the new section is defined by RATIO,
which is the dimensionless distance of the minimum and
maximum coordinate values of the current cell set in the
section normal direction.
– SPLINE,NSPL,/REVERSE/. Moves the section to spline
NSPL, at a dimensionless distance of RATIO along its arc
length. Using the keyword REVERSE flips the direction of a
CHIDDEN plot; it has no meaning for other plots.
SECSCALE, STATUS: Turns on or off automatic scaling of section or clipped
plots. If off, the sections are scaled to the entire plot range of cells selected. When
on (default), the program calculates the exact plot distance and centre for each
individual section. Using a user-defined distance or centre overrides the setting of
this command.
STATUS
– /ON/OFF/.
SHRINK, STATUS, FACTOR(.8): Shrinks the size of each cell by the specified
factor so that each cell boundary may be seen separately from its adjoining
neighbours (see Figure 5-2).
STATUS
/OFF/ON/.
FACTOR
Factor by which each cell is shrunk (0. < FACTOR < 1.).
5-38
Version 3.26
Chapter 5
PLOT MODULE
Original mesh
Figure 5-2
After application of command SHRINK
Effect of applying command SHRINK
SNORMAL, OPTION: Defines the direction of the normal to the section plane
(used for SECTION and CHIDDEN plots).
OPTION
– X, Y, Z, ICSYS (0.,0.,1.,1). The normal is defined from these
three vector components in local system ICSYS.
– VERTEX,NV1,NV2. The normal is defined by a line running
from vertex NV1 to vertex NV2.
– PLANE,NV1,NV2,NV3. The section plane is defined directly
as passing through vertices NV1, NV2, NV3. The SPOINT
command is not required.
– REVERSE. Reverses the direction of the currently defined
section normal.
14.2
SPOINT, OPTION: Defines the point through which the section plane passes,
perpendicularly to the SNORMAL specification or a surface of constant value in
any predefined local coordinate system.
Version 3.26
5-39
PLOT MODULE
Chapter 5
OPTION
– X, Y,Z,ICSYS(1). Point is defined at coordinates X, Y and Z in
coordinate system ICSYS.
– VERTEX,NV. Point is defined at the coordinates of vertex NV.
– LOCAL,ICSYS(1),IDIR(1),CVAL(0.0). Defines a surface
with constant value CVAL in coordinate direction IDIR (1 for
X, 2 for Y, 3 for Z) in local coordinate system ICSYS.
– CURSOR. The user will be prompted to ‘draw’ a line on the
current plot which will then define the section. The normal will
be defined perpendicular to this line in the plane of the screen.
Example in tutorial: 2.1, 2.3, 2.4, 3.1, 3.2, 4.1, 4.2, 5.1, 7.3, 9.2, 9.3, 9.4, 9.5, 9.6,
11.1, 14.1, 14.2
SURFACE, STATUS: Turns on or off the drawing of the exterior surface only,
while plotting the selected cells. The first time this command is turned on with any
given set of cells, CPLOT must be used. As long as the set of cells does not change,
this option can be turned on or off and REPLOT may be used to save time.
STATUS
– /OFF/ON/.
TICMARK, STATUS, TSTART(0.), TSPACE(1.): Causes a grid referenced to
the global Cartesian system to be plotted over the current plot. The grid is tick
marked every TSPACE units starting at TSTART in every direction.
STATUS
– /OFF/ON/.
TSTART
– Location of starting grid mark.
TSPACE
– Distance between grid tick marks.
VIEW, OPTION: Defines the viewing direction.
OPTION
5-40
– X,Y,Z,ICSYS(1). The view is determined by a vector passing
through coordinates X, Y and Z in local coordinate system
ICSYS and the origin of coordinate system ICSYS. If the view
is defined at the origin of ICSYS (for example, X, Y and Z are
all zero in a Cartesian system or X and Z are zero in a
cylindrical system), then it will be reset to (0, 0, 1) in ICSYS.
Version 3.26
Chapter 5
PLOT MODULE
OPTION
– SNAP. The view is changed to the closest axis or isometric
view to the current view.
– SNORMAL. The view is the same as the current section
normal. In other words, the view is perpendicular to the given
section.
– REVERSE. The view is the reverse of the current view.
VSTYLE, ICOLOR(3), ISIZE(1), ISTYLE(1): Defines symbols that mark vertex
locations.
ICOLOR
– Colour pen to be used (from 1 to 20; default = 3).
ISIZE
– Symbol size (default = 1). This is the percentage of the
window size.
STYLE
– Vertex symbol style (default = 1).
Current symbol styles available:
Style
Description
1
2
3
4
5
6
7
8
9
10
solid circle
open circle
solid square
open square
solid triangle
open triangle
solid diamond
open diamond
solid inverted triangle
open inverted triangle
WINDOW, /SX1,SY1,SX2,SY2/DEFAULT(0.,1.,10.,10.)/DIVIDE, NROW(2),
NCOL(2)/ACTIVATE, /FIRST/NEXT/NROW(1),NCOL(1)/: Enables the user
to resize the portion of the screen used for displaying the plot. The screen coordinate
system is shown in Figure 5-1 on page 5-11.
SX1, SY1
Version 3.26
– Coordinates of one corner of the plot window.
5-41
PLOT MODULE
Chapter 5
Post-processing Plot Characteristics
SX2, SY2
– Coordinates of the opposite corner of the plot window. If
SX1,…,SY2 are all blank, then the cursor will appear in order
for the user to mark two opposite corners of the new plot
region.
DEFAULT
– If the user types the word ‘DEFAULT’, the window will move
back to the normal full screen setting. (0,1,10,10) (see Figure
5-1 on page 5-11).
DIVIDE,
NROW,
NCOL
– This option causes the plot window to be divided into
NROW*NCOL equally spaced sub-windows. The most
recently defined window coordinates (SX1,SY1,…) are used to
compute sub-window sizes.
ACTIVATE, – After using the DIVIDE option, the user can pick any
NROW,
sub-window identified by row and column number
NCOL
(NROW,NCOL) for plotting. If (NROW,NCOL) = (1,1) then
OVERLAY is turned off and the complete window will be
cleared before starting the next plot. If (NROW,NCOL) is
anything else other than (1,1), then OVERLAY is
automatically turned on. If the user types WIND,ACTI,NEXT
then the program will activate each sub-window in turn,
reading left to right, top to bottom. On issuing
WIND,ACTI,NEXT after plotting the last row, last column
window, overlay is turned off and the window is again cleared
before beginning again at (1,1), the sub-window which is
located in the top left corner of the screen.
Note: For picking cells, vertices, boundaries, etc. from the screen, only the last
(most recently plotted) sub-window can be used.
ARROW, PERCENTL(.20), CONEANGLE(20 DEG), LINEWIDTH(1),
ARROWSTYLE(WIRE): Changes the default representation of vector arrows.
The two numbers define the size of arrowhead in proportion to each vector length
and the angle between one edge of the arrowhead and the body of the arrow,
respectively. The third number defines the width of the lines representing the
arrows.
PERCENTL
– Percentage length of the arrowhead with respect to the
entire vector length (0 < PERCENTL < 1.).
CONEANGLE – Half angle of the cone defining the arrowhead
(0 < CONEANGLE < 90).
LINEWIDTH
5-42
– Relative width of lines defining the arrow.
Version 3.26
Chapter 5
PLOT MODULE
ARROWSTYLE – (extended mode only). Set the rendering style of the arrow
to one of WIRE (default), PYRAMID, or CONE. The latter
two options display more detailed arrows especially when
lit, but can slow down rendering if a large number of arrows
are to be drawn.
CSCALE, NPEN, SOPTION, ROPTION, EOPTION: Defines the colour scale
used for VECTOR or CONTOUR post-processing plots. This command also affects
the colour scale for droplet plots made using the DPLOT command, when the
droplets are colour-coded according to a physical property.
NPEN
– Number of different light shading pens to use. The default is
based on the number of different colours available on the
device in use (hardware dependent). The current limit is four
shades and 40 pens per shade with eight-colour planes and
terminals with four or more colour planes. Workstations with
four-colour planes are limited to a maximum NPEN = 20.
SOPTION
– AUTOMATIC. The minimum and maximum colour scale
values VMIN and VMAX are based on the current cell/vertex
set for non-section plots or the current section for section and
clipped hidden plots.
– LOCAL. VMIN and VMAX are based on local values of the
current CSET.
– GLOBAL. VMIN and VMAX are based on global values.
– PFIX. NPEN, VMIN and VMAX are fixed at the values used
in the previous plot.
– USER,VMIN,VMAX,VINC. The user specifies any three of
NPEN, VMIN, VMAX and VINC to define the colour scale.
The remaining value is calculated and must be left blank.
VINC is the colour scale increment.
ROPTION
– STANDARD. The colour scale puts red on top and blue on the
bottom.
– REVERSE. The scale is reversed (blue on top and red on the
bottom).
EOPTION
– SMOOTH (extended mode only). The colour scale uses
smooth interpolation of values.
– DISCRETE (extended mode only). The colour scale uses
discrete colour bands to display values.
Version 3.26
5-43
PLOT MODULE
Chapter 5
HEADING: Changes the heading and units labels on a post plot. The user is
prompted for appropriate character strings.
SCENE, FILENAME: The SCENE command takes the current extended mode
plot window and records it into a platform independent 3-D STAR-CD Scene file.
This file can then be read with the external application STAR-view. Unlike standard
neutral plot files produced with the TERM,,FILE command, standard view
manipulations can be performed on scene files using STAR-view allowing the
model to be interactively viewed from any orientation.
POPTION, OPTION, FORMAT: Defines what type of plot will be rendered next.
Certain combinations of POPTION, PLTYPE, TERMINAL type (vector/raster) and
data type (cell or vertex) are not possible. For a complete list of legal combinations,
type HELP, COMBINATIONS.
OPTION
– /GEOMETRY/VECTOR/CONTOUR/BOTH/
/ISOSURFACE,VALUE /
The first option is for plotting the model geometry only.
Vector, contour and isosurface plots are post-processing
facilities. The form and information developed on each plot is
also a function of which data are stored (cell or vertex, vectors
and/or scalar) with the GETCELL/GETVERTEX command of
the POST module. The ISOSURFACE option also requires
input of the scalar value being represented by the plotted
surface. Vertex data are interpolated to provide exact values at
any given location or section. Cell data are treated as constant
within each given cell. Keyword BOTH will cause an
uncoloured set of vectors representing velocity direction and
magnitude to overlay a contour plot of the currently stored
scalar quantity.
FORMAT
– FORTRAN format for legend numbers.
THIN, TSFAC(1.): ‘Thins out’ the number of vectors plotted for vector plots or the
frequency of contour line labels for contour plots (TERMINAL in VECTOR mode
– RASTER mode not affected).
5-44
Version 3.26
Chapter 5
PLOT MODULE
Droplet Plot Characteristics
TSFAC
– Thinning factor. 0. < TSFAC < 1. If TSFAC = 0., no vectors
will be plotted. If TSFAC = .5, then every other vector will be
plotted etc.
UGRID, STATUS, NPSX(25), NPSY(.9*NPSX): Allows the user to map a
uniformly spaced grid over a section for purposes of vector solution display. This
feature is helpful in reducing the problem of visual distortion of a display surface
caused by irregularly spaced computation meshes.
STATUS
– /OFF/ON/.
NPSX
– Number of points to be placed in the screen SX direction.
NPSY
– Number of points to be placed in the screen SY direction.
VESCALE, VSFAC(1.), OPTION: Changes the size of all vectors by multiplying
by a constant factor or fixes all vectors to a constant length.
VSFAC
– Scale factor constant.
OPTION
– PROPORTIONAL. All vectors have lengths proportional to
their respective magnitudes. The longest vector length is
VSFAC (in screen units).
– FIXED. All vectors are drawn the same length regardless of
magnitude. The length is VSFAC (in screen units).
– VMAG. A vector of magnitude VSFAC has length 1.0 in
screen units. All other vectors will be scaled accordingly.
Example in tutorial: 3.1, 3.2, 4.1, 4.2, 5.2, 7.1, 7.2, 7.3, 7.4, 8.1, 8.2, 11.1, 13.1
DOPTION, LOPT: Selects the plot options for droplet plots.
LOPT
Version 3.26
– DEFAULT. Sets the default droplet parameters. These options
are: no edge plot, the perimeter colour index is set to 1 (the
foreground colour), the radius is set to a constant size of 0.1
screen units, the fill colour is set to colour index 0 (the
background), the velocity vector is set to u, v and w with a
maximum length of 1 screen unit.
5-45
PLOT MODULE
Chapter 5
LOPT
5-46
– EDGE,EOPTION. Specifies the cell edge plot option.
– EOPTION
OFF. Do not overlay a cell edge plot on the droplet plot.
ON (or AFTER), /HIDDEN/NOHIDDEN/,
/CPLOT/REPLOT/. Overlays a cell edge plot after the
droplets are plotted. The edge plot will be either an exact
(HIDDEN) or see-through (NOHIDDEN) edge plot and will
be generated using the equivalent CPLOT or REPLOT
command. If hardware graphics are available (e.g. Silicon
Graphics or IBM RS/6000), a normal CPLOT will be done
instead of an edge plot. This can make an especially effective
presentation if the surface is made transparent by using the
TRNSLU parameter of the CLRTABLE command
Note that a special effect of having the droplets appear to be
‘inside’ the model (hiding the far edges and being hidden by
the near edges) can be obtained for a wireframe cell plot by
using the following combination of settings:
– DOPTION,EDGE,AFTER,HIDDEN
– CDISPLAY,ON,DROPLET
– PLTYPE,NORMAL
– EDGE,ON
– PERIMETER,/OFF/LCOLOR/. Specifies the droplet
perimeter colour for raster plots. The perimeter colour can be
OFF (default) or colour pen LCOLOR.
– RADIUS,ROPTION,SIZE. Specifies the droplet plot radius.
– ROPTION
CONSTANT. Droplet radii are constant.
/COUNT/DIAMETER/MASS/. Droplet radii are
proportional to the specified droplet variable. COUNT is the
number of real-life droplets being represented by the plotted
droplet.
SIZE. The maximum radius of a droplet, in model
coordinates.
– RADMAX,MAGNITUDE. If a RADIUS option other than
CONSTANT is selected, the size of the droplets depends on
both the size parameter in the RADIUS option and the
maximum value of the count, diameter or mass. Because this
maximum value can change for each plot, the size of the
droplets can change without a change in the plotting
parameters. This is especially noticeable during animation.
This option makes the droplet size consistent for all plots, by
specifying a MAGNITUDE corresponding to a value of count,
diameter or mass. If MAGNITUDE is zero or less, this feature
is turned off, in which case, the number used for the last plot is
displayed by the DSTATUS command.
Version 3.26
Chapter 5
PLOT MODULE
LOPT
– FILL,FOPTION. Specifies the droplet fill colour for raster
plots. The colour pens can be changed with the CLRTABLE
command. If a contouring option is chosen, the number and
range of the contours can be changed with the CSCALE
command.
– FOPTION
COLOR,LCOLOR(0). Droplets will be filled with colour
pen LCOLOR.
/COUNT/DENSITY/DIAMETER/MASS/
/TEMPERATURE/. Droplets will be contoured according to
the specified droplet variable.
TYPE. Droplets will be coloured based on the droplet type.
POST,IREG(4). Droplets will be contoured according to the
cell or vertex data stored in post register IREG. The droplet
location will be used to find the appropriate cell or vertex
post value.
VMAG. Droplets will be contoured according to the velocity
magnitude of the droplet.
– VECTOR,/ALL/NONE/U/V/W/,SIZE. Identifies which
component(s) of the droplet velocity will be plotted. The size
parameter is the maximum length of the vector in screen units.
– VECMAX,MAGNITUDE. The size of the vectors depends on
both the size parameter in the VECTOR option and the
maximum velocity magnitude. Because this maximum value
can change for each plot, the size of the vectors can change
without a change in the plotting parameters. This is especially
noticeable during animation. This option makes the vector size
consistent for all plots, by specifying an appropriate velocity
MAGNITUDE. If MAGNITUDE is zero or less, this feature is
turned off, in which case, the number used for the last plot is
displayed by the DSTATUS command.
DPLOT: Makes a plot of droplets in accordance with the user-defined droplet set
and any other pertinent parameters. Please note that while plotting tracks (using the
GETD, TRACK, … command), the option DOPT, EDGE, BEFORE, … is invalid.
DSTATUS: Displays the current droplet plot options in effect.
Version 3.26
5-47
Chapter 6
UTILITIES MODULE
Command Descriptions
Chapter 6
UTILITIES MODULE
ACROSS: Calculates the total and individual surface area of cell faces picked by
the cursor. Some form of SURFACE,ON plot (NORMAL, QHIDDEN, or
EHIDDEN) must appear on the screen for this command to function. A running
total of area is kept until the AREA,INITIALIZE command is issued.
AREA, OPTION: Calculates the surface area within a polygon defined by vertices
or the area of one or more boundaries, boundary regions or boundary patches. A
running total of area is kept until the user reinitialises the total to zero with the
INITIALIZE option.
OPTION
Version 3.26
– INITIALIZE. Reinitialises the area running total to zero. This
is the default option if AREA is entered without any
arguments.
– VCRS. Uses the cursor to pick vertices that define the polygon.
A minimum of three vertices are required. The vertices should
be in the same plane and be picked in order around the
polygon.
– NV1,NV2,NV3,[NV4],…,[NV19]. A list of up to 19 existing
vertices that define the polygon. A minimum of three vertices
are required. The vertices should be in the same plane and be
listed in order around the polygon.
– BCRS. Uses the cursor to pick boundaries.
– BSET. Calculates the total area of all boundaries in the
boundary set.
– BLIST,NB1,[NB2],…,[NB18]. Calculates the areas of a list of
up to 18 boundaries.
– BRANGE,NB1(1),NB2(NB1),NBINC(1). Calculates the total
area of a range of boundaries from NB1 to NB2 by NBINC.
– RLIST,NR1,[NR2],…,[NR18]. Calculates the total areas of all
boundaries in a list of up to 18 boundary regions.
– RRANGE,NR1(1),NR2(NR1),NRINC(1). Calculates the total
area of all boundaries in a range of boundary regions from
NR1 to NR2 by NRINC.
– PLIST,NP1,[NP2],…,[NP18]. Calculates the total areas of all
boundaries in a list of up to 18 boundary patches.
6-1
UTILITIES MODULE
Chapter 6
OPTION
– PRANGE,NP1(1),NP2(NP1),NPINC(1). Calculates the total
area of all boundaries in a range of boundary patches from
NP1 to NP2 by NPINC.
AZONE, OPTION: Automatically identifies every face within a user-defined zone
on the preceding plot to use for area calculations. The user may pick all faces on the
plot or may draw a (up to 20-sided) polygon, using the cursor device to mark its
corners, that contains the region. If a NORMAL (see-through) plot of the surfaces
is showing, then all surfaces will be included in the total area calculation. If the plot
is of type QHIDDEN or EHIDDEN, then only the surfaces pointing towards the
viewer will be identified. (In other words, the command acts the same whether the
user has chosen QHIDDEN or EHIDDEN.) A running total of area is kept until the
AREA,INITIALIZE command is issued.
OPTION
– If OPTION = ALL, then all the faces showing in the plot will
be identified. If OPTION is blank, then the crosshairs will
appear and the user can begin drawing a polygon marking the
zone limits. To abort the operation, pick a location outside the
plot window. To finish the operation, pick the starting point.
COUNT, OPTION, SOPT: Provides a summary count of the current numbers of
blocks, boundaries, cells, couples, splines and/or vertices.
OPTION
– /ALL/BLOCK/BOUNDARY/CELL/COUPLE/SPLINE/
/VERTEX.
SOPT
– If SOPT is SET, then boundary regions, boundary patches, cell
tables, couple tables and/or spline tables will be listed only if
they contain items that are in the current item set.
CPCELL, NC1(1), NC2(NC1), NCINC(1): Prints a list of all couples attached to
each cell in the given range.
NC1, NC2,
NCINC
– Cells are NC1 to NC2 by NCINC.
6-2
Version 3.26
Chapter 6
UTILITIES MODULE
CVERTEX, NV1(1), NV2(NV1), NVINC(1): Prints a list of all cells attached to
each vertex in the given range.
NV1, NV2,
NVINC
– Vertices are NV1 to NV2 by NVINC.
DBASE, FUNCTION: The database is used to store and retrieve mesh sets. A
mesh set is made up of a description of the mesh, the cells and vertices that make
up the mesh and the corresponding cell table entries, splines and couples which
describe the cells in the mesh set. Examples of a mesh set would be the shell surface
of an object or the cells and vertices making up the rear view mirror in a internal car
flow model.
The database is stored in a file and is not internal to pro-STAR. Sets of cells must
be specifically put into the database. To work on a mesh set, it must first be brought
into internal pro-STAR storage before the normal pro-STAR commands can be
used.
The database is used extensively by the BAMM command. You identify the
surface by giving the BAMM command its identification in the database and the
BAMM command returns the mesh it generates into the database.
In the DBASE functions, the following parameters are commonly used:
Version 3.26
ID
– The mesh set in the database is identified by an id number.
The mesh id is a positive integer.
TYPE
– The mesh type describes the type of cells in the mesh set
and can have the following values:
– SURFACE. A surface mesh composed of shells.
– SUBSURFACE. A shell mesh created by ammbatch from
a surface mesh.
– TRIM. Trimmed cells generated by ammbatch.
– POLYGON. A surface mesh composed of polygons, used
for ammbatch extrusion.
– STAR. Hexahedral cells used for the custom mesh.
EOPTION
– /NEW/OVERWRITE/. The EOPTION tells pro-STAR what
to do if a mesh set or file already exist. If the NEW
EOPTION is chosen and the entry already exists, the
function is aborted and an error condition is generated. Use
OVERWRITE to delete the existing entry and replace it
with the new one.
6-3
UTILITIES MODULE
Chapter 6
FUNCTION
– /ADD/CLEAR/CLOSE/COMPRESS/DELETE/GET/LIST/
/OPEN/PUT/UNDELETE/.
DBASE, ADD, – The ADD function retrieves the mesh set identified by ID
ID, VERTEX
from the database into the corresponding arrays. The
OFFSET, CELL retrieved entries are added to the current arrays starting at
OFFSET, CELL corresponding offsets. If these values are left blank, the
TABLE
retrieved entries are added after the last entries in the arrays.
OFFSET,
This function is different from the GET function in that the
CP MATCH
arrays are not cleared before retrieving the mesh set.
OFFSET,
CP TABLE
OFFSET,
SPLINE
OFFSET,
SPLINE TABLE
OFFSET,
BOUNDARY
OFFSET,
REGION
OFFSET
DBASE,
CLEAR
– Clears all the arrays internal to the program associated with
mesh storage. Executing this command before saving the
model file can significantly reduce the amount of disk space
the model file requires. Make sure the information stored
internally in pro-STAR is saved in a database or do not
execute this command. All internal mesh data is lost.
DBASE, CLOSE – Closes the current database file.
6-4
DBASE,
COMPRESS
– Removes deleted entries from the database. The mesh set
ids are not changed.
DBASE,
DELETE, ID
– Delete the mesh set identified by ID from the database. This
set can be retrieved by using the UNDELETE function and
then using ADD or GET but only if the COMPRESS
function has not been done.
DBASE, GET,
ID
– The GET function retrieves the mesh set identified by ID
from the database into the cell, cell table and vertex arrays.
These arrays are cleared before the mesh set is retrieved.
The equivalent of a CSET,ALL command is done after the
mesh set has been retrieved.
Version 3.26
Chapter 6
UTILITIES MODULE
DBASE, LIST,
ID(0), TYPE,
LOPTION,
DOPTION
– Lists information about the mesh set entries in the database.
The parameters are used to limit the sets listed.
– ID. If no ID is given, all the mesh sets are listed.
– TYPE. /ALL/SURFACE/SUBSURFACE/TRIM/
/POLYGON/STAR/. Only the mesh type specified will be
listed. The default is to list all types.
– LOPTION. /SHORT/LONG/. Specifying the LONG
options causes the command to output the parameters
used in ammbatch when the mesh was generated.
– DOPTION. /NODELETE/DELETE/. The default is to list
only those mesh sets which have not been deleted. Specify
DELETE to list all the mesh sets.
DBASE, OPEN, – Opens the database file. You do not need to explicitly open
FILENAME
the database file if its name is casename.dbs. If you
would like to use a different filename, execute this
command. FILENAME without double quotes (") around it
becomes FILENAME.dbs, otherwise FILENAME is used
as is.
DBASE, PUT,
ID, TYPE,
EOPTION
– Copies the current mesh set into the database. The mesh set
is defined as the current cell set, the current vertex set and
any vertices attached to cells of the current cell set
(e.g. VSET,ADD,CSET), and any cell tables of cells in the
current cell set. This function also prompts the user to enter
a description of the mesh set which can be up to 80
characters long.
– TYPE. /SURFACE/SUBSURFACE/TRIM/POLYGON/
/STAR/. See above.
– EOPTION. /NEW/OVERWRITE/. See above.
DBASE,
– Undeletes a deleted mesh set from the database.
UNDELETE, ID
FLUXSUM, OPTION: Finds the cumulative mass flux crossing a user defined set
of cell faces. A running total of flux and area is kept until the user reinitialises the
totals to zero with the INITIALIZE option.
Version 3.26
6-5
UTILITIES MODULE
Chapter 6
OPTION
– INITIALIZE (default). Initialises the cumulative flux and
cumulative area values to zero.
– CCRS. Cell faces for which to find the flux are selected using
the crosshair. Flux is defined as positive out of a cell.
– ZONE. Cell faces for which to find the flux are selected by
drawing a polygon around the selected cells. If a normal
(see-through) plot of the surfaces is showing, then all surfaces
will be included in the total area calculation. If the plot is of
type QHIDDEN or EHIDDEN, then only the surfaces pointing
towards the viewer will be identified. Flux is defined as
positive out of a cell.
– ZONE,ALL. Same as the ZONE option, except all cell faces
fully within the current plot screen are used.
– CSET,ITYPE. The program will sum all the mass fluxes
passing through a pre-generated set of shells or baffles of type
ITYPE. Flux is positive if it passes through the shell or baffle
in the same direction as the shell normal (as determined by the
right-hand rule). The user must have defined a cell set of fluid
cells which touch the shells on either one or both sides. This
cell set is used to search for fluid faces that are identical to the
given shells. Using a larger cell set will not change the answer;
it only affects the time needed to find the correct set of faces.
FSTAT, LF(case.set): Prints summaries of data sets stored on surface
(SRFWRITE) and set (SETWRITE) files.
LF
– File to check. ALL prints a summary of all open files.
HELP
or
LIVE, OPTION1, OPTION2: Creates or writes out surface shells or edge lines for
the currently selected set of cells. Newly created cells are given a cell type of one
plus the current maximum cell type. Shells are oriented such that their normal
directions point outward from the starting cell set.
6-6
Version 3.26
Chapter 6
UTILITIES MODULE
OPTION1
– SURFACE (default). Surface shells will be generated.
– PARTIAL. Surface shells will be generated on the uncovered
areas of partially covered couples (boundaries).
– EDGE. Edge lines will be generated. IDOPTION (below) is
ignored.
– CORNER. Corners are defined and point cells will be
generated.
OPTION2
– CREATE,SOPTION (default). The above cells will be created
within the pro-STAR database. SOPTION is defined below.
– LFC(case.cel),LFV(case.vrt),SOPTION,FOPT.
Instead of creating the cells and vertices within pro-STAR, the
cells and vertices will be written to files LFC and LFV,
respectively. The format for LFC is (I9, 6X, 9I9, 1X, I4), as in
CWRITE. The format for LFV is (I9, 6X, 3G16.9), as in
VWRITE. SOPTION and FOPT are defined below.
SOPTION
Note: The ID/NOID sub-options apply only for SURFACE and
PARTIAL options. The FANGLE sub-option applies only for the
EDGE and CORNER options.
– ID (default). This is the default sub-option for SURFACE and
PARTIAL. For shells, the cell and cell face numbers on which
the shell is located are placed in vertex locations 7 and 8.
– NOID. This is the alternate sub-option for SURFACE and
PARTIAL. Vertex locations 7 and 8 are set to 0.
– FANGLE (31.0). This is the only sub-option for EDGE and
CORNER. The feature angle defaults to an angle of 31.0
degrees. Edges are defined by adjacent surface faces whose
normals differ by an amount greater than or equal to the
feature angle. Corners are defined as vertices that belong to
more than two edges (regular corners) or to one edge (isolated
corner).
FOPT
– CODED (default). Files LFC and LFV will be written as
coded.
– BINARY. Files LFC and LFV will be written as binary.
RANGE, OPTION: Finds the geometric range of a given set of cells, vertices,
boundaries or splines. The minimum and maximum value of each coordinate is
given in the global Cartesian system and the currently active local system.
Version 3.26
6-7
UTILITIES MODULE
Chapter 6
OPTION
– CELL,/ALL/CSET/NC1,NC2,NCINC/. Scans all cells, all
cells in the current cell set or a range of cells from NC1 to NC2
by NCINC.
– VERTEX,/ALL/VSET/NV1,NV2,NVINC/. Scans all vertices,
all vertices in the current vertex set or a range of vertices from
NV1 to NV2 by NVINC.
– BOUNDARY,/ALL/BSET/NB1,NB2,NBINC/. Scans all
boundaries, all boundaries in the current boundary set or a
range of boundaries from NB1 to NB2 by NBINC.
– SPLINE,/ALL/SPLSET/NSPL1,NSPL2,NSPLINC/. Scans all
splines, all splines in the current spline set or a range of splines
from NSPL1 to NSPL2 by NSPLINC.
SCLOCATE: Turns on the plot cursor and gives a continuous readout of the cursor
position in screen coordinates, global coordinates and local coordinates. For global
and local coordinates, the cursor is assumed to lie in the plane of the plot CENTER
and normal to the VIEW.
SENSOR, OPTION, RANGE, OPTION2: The SENSOR command manages a
list of vertices used as ‘sensor’ points within the solution domain. The points may
be used, for example, to extract data at locations coinciding with experimentally
derived results and used for comparison. These vertices need not be connected to
any cell. They must only be located geometrically within the flow field. The user
can then print the values of the currently stored post data items interpolated to the
sensor point positions. As with all pro-STAR post functions, cell data are treated as
constant within each cell. A sensor printout of cell data will yield the cell value
regardless of where in a cell the sensor is located.
6-8
Version 3.26
Chapter 6
UTILITIES MODULE
OPTION
– ADD. Adds the vertices specified by the RANGE to the list of
sensor points.
– DELETE. Deletes the vertices specified by the RANGE from
the list of sensor points.
– LIST. Lists all sensor points that also fall within the points
defined by the RANGE.
– PRINT. Prints the post data at all sensor points that also fall
within the points defined by the RANGE.
– SCAN. Goes through the entire list of currently stored sensor
points to find the cell within which each point is located. Only
cells specified by the RANGE are searched. This step may take
some time for models containing large numbers of sensors and
large numbers of cells. The user may be able to cut the time
down considerably by building a CSET of cells in the vicinity
of the sensor points and using that CSET as the range.
RANGE
– For OPTION = /ADD/DELETE/LIST/PRINT/, the RANGE
may be one of /ALL/VSET/ or NV1,NV2,NVINC, where each
parameter refers to vertices.
– For OPTION = SCAN, the RANGE may be one of
/ALL/CSET/ or NC1,NC2,NCINC where each parameter
refers to cells. DOPTION given by /NODELETE/DELETE/
after this does not/does delete the sensors that are not within
the range.
OPTION2
– For OPTION = PRINT only, OPTION2 may be one of C80 or
C132. The C132 option prints 132 columns, allowing more
significant digits per number.
– For OPTION = SCAN only, OPTION2 may be one of
NODELETE or DELETE which does not/does delete the
sensors that are not within the range.
SETDELETE, LF(case.set), NUMSET: Deletes a set definition previously
stored using the SETWRITE command.
LF
– File name from which the set is to be deleted.
NUMSET
– Number of the set on file LF to delete or an (up to
80-character) identifier of the set. The keyword ALL may be
used to delete all the sets from the file LF.
Version 3.26
6-9
UTILITIES MODULE
Chapter 6
SETREAD, LF(case.set), NUMSET(1), OPTION1, OPTION2: Reads a set
definition previously stored using the SETWRITE command back into the program.
Multiple set definitions can be stacked on one file and recalled in any sequence.
LF
– File name from which to read in a set definition.
NUMSET
– Number of the set on file LF to recall (or NEXT) or an (up to
80-character) identifier used to write the set.
OPTION1
– User may read back all or any one of these set items:
– ALL
– CELLS
– VERTICES
– BOUNDARIES
– SPLINES
– BLOCKS
– COUPLES
OPTION2
– This option can be used to control how the set read interacts
with the currently stored set.
– NEWSET. The set read in is made the current set.
– ADD. The set read in is added to the current set.
– DELETE. The set read in is deleted from the current set.
– SUBSET. Only items in both the set read in and the current set
are retained as the new current set.
SETWRITE, LF(case.set), IDENT: Writes the current set (CSET, VSET,
BSET, SPLSET, BLKSET, CPSET) definitions to file LF for future recall and use.
Multiple set definitions can be stacked on one file and read back later set by set.
New sets are always added to the end of the file.
LF
– File name to write out set definitions.
IDENT
– An (up to 80-character) identifier that will help the user recall
which set is being recalled with the SETREAD command.
SMAP, LGEOM(case.mdl), LOUT(case.smap), OPTION: Maps all cell
post data items stored on the currently loaded post file to a new data file (SMAP
file), on the basis of a different mesh geometry stored on another pro-STAR model
file. The SMAP file contains cell data for the new geometry, which can be read
directly into pro-STAR (using command GETC), or which can be used by STAR in
an initial field restart (specified using the command ‘RDATA,INIT,C’).
6-10
Version 3.26
Chapter 6
UTILITIES MODULE
LGEOM
– Name of a pro-STAR model file, representing the new mesh
geometry.
LOUT
– SMAP file to which the mapped data corresponding to the new
mesh will be written.
OPTION
Determines how to define data for cells in the new model that are
located outside the boundaries of the current model cell set (and
for solid cells in the new model if conjugate heat transfer is not
on):
– DEFAULT. Outside cells will be given the standard default
restart data (defined with the INIT command).
– NEAREST. Outside cells will be given the values of their
nearest current neighbour. (Warning: This option may be
time-consuming if the number of outside cells is large.)
– ZERO. Outside cells will be given a value of 0.0 for all data.
SRFDELETE, LF(case.srf), NUMSRF: Deletes a surface definition
previously stored using the SRFWRITE command.
LF
– File name from which the surface is to be deleted.
NUMSRF
– Number of the surface on file LF to delete or an (up to
80-character) identifier of the surface.
SRFREAD, LF(case.srf), NUMSRF(1): Reads a surface definition previously
stored using the SRFWRITE command back into the program, allowing the user to
skip the CPLOT command and go directly to REPLOT. This is useful primarily for
very large models when the time to recalculate the surface definition for a given
CSET of cells is quite long. Multiple surface definitions can be stacked on one file
and read back by issuing multiple SRFREAD commands.
LF
– File name from which to read in a surface definition.
NUMSRF
– Number of the surface on file LF to recall (or NEXT) or an (up
to 80-character) identifier used to write the surface.
SRFWRITE, LF(case.srf), IDENT: Writes the current plot surface to file LF
Version 3.26
6-11
UTILITIES MODULE
Chapter 6
in a very compressed manner for future recall and use. Reading back the surface
definition from this file allows the user to skip the CPLOT command and go directly
to REPLOT. This is useful primarily for very large models when the time to
recalculate the surface definition for a given CSET of cells is quite long. Multiple
surface definitions can be stacked on one file and read back at a later time.
LF
– File name to write out surface definitions.
IDENT
– An (up to 80-character) identifier that will help the user recall
which surface is being recalled with the SRFREAD command.
TABLE, NTABLE, OPTION: Creates, adds to or plots a table. Tables are
automatically sorted by X-value in ascending order.
NTABLE
– Table number.
OPTION
– /NEW, DATALIST/ADD, DATALIST/READ,
IUNIT(case.tabl)/PLOT/ /LIST/CLEAR/.
– NEW,X1,Y1,X2,Y2,X3,Y3,…,X8,Y8. Creates a new table
NTABLE with up to eight (x,y) data pairs. Each X-value
must be unique. This will overwrite any existing table
number NTABLE.
– ADD,X1,Y1,X2,Y2,X3,Y3,…,X8,Y8. Adds to table
NTABLE up to eight (x,y) data pairs. Each X-value
(including the X-values that already exist in table NTABLE)
must be unique.
– READ,FILENAME. Reads the table data from file
FILENAME, and writes the data to table NTABLE. This will
overwrite any existing table number NTABLE. The data are
read in free format, two entries (x and y) per line. (Note:
Files written using the TWRITE command cannot be read in
this way. For those files, use the TREAD command.)
– PLOT. Plots an XY graph of the table data in table NTABLE.
This will reset the graph registers and graph data.
– LIST. Lists table NTABLE (see also command TLIST).
– CLEAR. Clears table NTABLE of all entries.
TFILL, NTABLE, XOPTION, X1, X2, NENT(100), RATIOX(1.0),
6-12
Version 3.26
Chapter 6
UTILITIES MODULE
YOPTION: Fills a table with data using a function of X. The X-values to be used
are defined in XOPTION and the function that calculates the Y-values is defined in
YOPTION.
NTABLE
– Table number to be filled.
XOPTION
– NEW,X1,X2,NENT(100),RATIOX(1.0). Defines a new table
NTABLE (clearing any data that might already be there). The
X-values of the new table are defined with the parameters X1,
X2, NENT and RATIOX.
– CURRENT. Uses the current X-values in the table. Parameters
X1, X2, NENT and RATIOX are not used.
X1, X2
– Fills using X-values X1 to X2. X2 must be greater than X1.
NENT
– Number of entries in the table to fill.
RATIOX
– X-value spacing ratio. If RATIOX = 1, X-values are equally
spaced over the range.
YOPTION
– FILL,Y1,Y2,RATIOY(1.0). Fills entries with Y-values from
Y1 to Y2 with fill ratio RATIOY. If RATIOY = 1, Y-values are
equally spaced over the range.
– POLYNOMIAL,A0,A1,A2,A3,A4,A5,A6. Fills Y-values such
that: Y = A0 + A1*X + A2*X^2 + A3*X^3 + A4*X^4 +
A5*X^5 + A6*X^6.
– INVERSE,A0,A1,A2,A3,A4,A5,A6. Fills Y-values such that:
Y = A0 + A1/X + A2/X^2 + A3/X^3 + A4/X^4 + A5/X^5 +
A6/X^6. Note: All X-values must be non-zero.
– EXPONENTIAL,A(e),B(1.0),C(0.0),D(1.0),E(0.0). Fills
Y-values such that: Y = (A^(B*X+C))*D + E.
– LOGARITHMIC,A(e),B(1.0),C(0.0),D(1.0),E(0.0). Fills
Y-values such that: Y = (LOG-A(B*X+C))*D + E. Note:
LOG-A denotes that the logarithm is taken with respect to base
A. If A is less than or equal to 0, it will be set to e. The
expression (B*X+C) must always evaluate to a positive
number.
– SINE,/DEGREES/RADIANS/,A(1.0),B(1.0),C(0.0),D(0.0).
Fills Y-values (with X and C as DEGREES or RADIANS)
such that: Y = A*SIN(B*X+C) + D.
– COSINE,/DEGREES/RADIANS/,A(1.0),B(1.0),C(0.0),
D(0.0). Fills Y-values (with X and C as DEGREES or
RADIANS) such that: Y = A*COS(B*X+C) + D.
– TANGENT,/DEGREES/RADIANS/,A(1.0),B(1.0),C(0.0),
D(0.0). Fills Y-values (with X and C as DEGREES or
RADIANS) such that: Y = A*TAN(B*X+C) + D.
Version 3.26
6-13
UTILITIES MODULE
Chapter 6
TFIND, NTABLE, XVAL, INTEROPT, EXTRAOPT: Finds the interpolated
Y-value for a given X-value and table number.
NTABLE
– Table number.
XVAL
– X-value.
INTEROPT
– LINEAR. Interpolate using a linear relationship between table
entries.
– SPLINE. Interpolate using a spline-type curve between table
entries.
EXTRAOPT – EXTRAPOLATE. If XVAL is beyond the table range,
extrapolate to find the Y-value.
– CAP. If XVAL is beyond the table range, do not extrapolate to
find the Y-value. Instead, use the Y-values at the limits of the
range. (In other words, if XVAL is below the table range, use
the Y-value of the lowest X-value in the table. If XVAL is
above the table range, use the Y-value of the highest X-value in
the table.)
TGENERATE, NTOFF, NTAB1, NTAB2(NTAB1), NTABINC(1), XOFF(0.0),
YOFF(0.0): Creates a new set of tables from existing tables.
NTOFF
– Table number offset. NTOFF can be zero, in which case the
original tables are replaced.
NTAB1,
NTAB2,
NTABINC
– Creates new tables using original tables NTAB1 to NTAB2 by
NTABINC.
XOFF
– Offset to add to all X-values.
YOFF
– Offset to add to all Y-values.
TLIST, NTAB1(1), NTAB2(NTAB1), NTABINC(1): Lists the values in tables
NTAB1 to NTAB2, incrementing by NTABINC.
TMAP, NTAB1, NTAB2, XYOPTION, INTEROPT, EXTRAOPT: Maps
X-data or Y-data from one table to another.
6-14
Version 3.26
Chapter 6
UTILITIES MODULE
NTAB1
– Table to map data from.
NTAB2
– Table to map data to.
XYOPTION – Y (default). Creates new Y-values in table NTAB2 based on
the X-values in table NTAB2 and the entries in table NTAB1.
– X. Creates new X-values in table NTAB2 based on the
Y-values in table NTAB2 and the entries in table NTAB1.
INTEROPT
– LINEAR. Interpolates using a linear relationship between table
entries.
– SPLINE. Interpolates using a spline-type curve between table
entries.
EXTRAOPT – EXTRAPOLATE.
– If XYOPTION = Y, then:
If an X-value in table NTAB2 is beyond the X-value range in
table NTAB1, then extrapolate to find the Y-value.
– If XYOPTION = X, then:
If a Y-value in table NTAB2 is beyond the Y-value range in
table NTAB1, then extrapolate to find the X-value.
– CAP. Do not extrapolate to find the requested values. Instead
use the values at the limits of the range in table NTAB1.
TMODIFY, NTABLE, OPTION: Modifies one or more entries in a table.
NTABLE
– Table number to be modified.
OPTION
– MODIFY,NENTRY,X1,Y1. Replaces entry number NENTRY
with values X1, Y1. If X1 (or Y1) is left blank, then the
X-value (or Y-value) of the entry will not change. The table
will automatically be sorted by X-values in ascending order.
X-values in a table must be unique.
– DELETE,NENTRY. Deletes entry number NENTRY.
– REVERSE. Reverses the order of the Y-values.
– CLEAR. Clears the table of all entries.
TREAD, LF(case.tabl), NTAB1(1), NTAB2(NTAB1), NTABINC(1),
FILETYPE: Reads table data from a file.
LF
Version 3.26
– File name.
6-15
UTILITIES MODULE
Chapter 6
NTAB1,
NTAB2,
NTABINC
– Reads table numbers NTAB1 to NTAB2 by NTABINC. Note:
Existing tables will be overwritten. If NTAB1 is replaced with
‘ALL’, then pro-STAR will read all existing tables in file LF. If
NTAB1 is replaced with ‘LIST’, then pro-STAR will list the
table numbers that exist in file LF.
FILETYPE
– /CODED/BINARY/. Defines whether the input file is in coded
or binary format.
TSMAP, LGEOM(case.mdl), LOUT(case.smap), OPTION, VOLTOL(0.005):
Maps (rezones) all cell post data items stored on the currently loaded post file to a
new data file (SMAP file), on the basis of a different mesh geometry stored on
another pro-STAR model file. This rezoning procedure is designed to enforce a
global conservation law to make the rezoned solution as close to the original
solution as possible considering the changes in the mesh. The SMAP file contains
cell data for the new geometry, which can be read directly into pro-STAR (using
command GETC), or which can be used by STAR in an initial field restart
(specified using the command ‘RDATA,INIT,C’).
Note: This routine currently only rezones the solution for fluid cells. Only data
pertaining to fluid cells in the current cell set of the current model will be mapped
to the new model. The volume of the new model should be fully contained within
the current cell set of the current model.
LGEOM
– Name of a pro-STAR model file, representing the new mesh
geometry.
LOUT
– SMAP file to which the mapped data corresponding to the new
mesh will be written.
OPTION
Determines how to define data for solid cells and cells in the new
model that are located outside the boundaries of the current
model cell set:
– NEAREST (default). Outside cells will be given the values of
their nearest current neighbour. (Warning: This option may be
time-consuming if the number of outside cells is large.)
– ZERO. Outside cells will be given a value of 0.0 for all data.
VOLTOL
– Volume tolerance fraction. The function will not attempt to
proceed if the total volume of the new mesh exceeds the total
volume of the current mesh by more than this fraction.
TSMULT, NTABLE, X-FACTOR(1.0), Y-FACTOR(1.0): Scalar multiplication
6-16
Version 3.26
Chapter 6
UTILITIES MODULE
of values in a table.
NTABLE
– Table number.
X-FACTOR
– Factor by which to multiply all x-values in table NTABLE.
X-FACTOR must be non-zero. If X-FACTOR is negative, then
table will be automatically sorted in ascending X order.
Y-FACTOR
– Factor by which to multiply all y-values in table NTABLE.
TVMULT, NTAB1, NTAB2, NTAB3: Multiplies values in table NTAB1 by the
corresponding values in table NTAB2 and puts the result in table NTAB3. In other
words, X3 = X1*X2 and Y3 = Y1*Y2, where 1, 2 and 3 refer to values from
NTAB1, NTAB2 and NTAB3. NTAB3 can be equal to NTAB1 and/or NTAB2. If
table NTAB3 already exists, it will be overwritten. Table NTAB3 will be
automatically sorted in ascending X order.
TWRITE, LF(case.tabl), NTAB1(ALL), NTAB2, NTABINC, FILETYPE:
Writes table data to a file.
LF
– File name.
NTAB1,
NTAB2,
NTABINC
– Writes table numbers NTAB1 to NTAB2 by NTABINC. If
NTAB1 is ‘ALL’ or left blank, then all tables will be written to
the file.
FILETYPE
– /CODED/BINARY/. Defines whether the output file is in
coded or binary format.
USUBROUTINE, OPTION: Lists or writes the user defined subroutines available
in the STAR solver.
OPTION
Version 3.26
– LIST,SUBNAME (default). Lists the contents of a given
subroutine SUBNAME to the screen. The subroutine name
will be prompted for. The word SUMMARY can be used to list
a summary of all available routines.
6-17
UTILITIES MODULE
Chapter 6
Table Data
OPTION
– WRITE,SUBNAME. Writes a base copy of a given subroutine
SUBNAME to a file for the user to edit and eventually include
in a STAR executable. The file will be written to a local
subdirectory named ufile (which must already exist), and
will be called SUBNAME.f, or SUBNAME.f.new if
SUBNAME.f already exists.
– AUTOMATIC. Writes base copies of all user-definable
subroutines turned on by USER options in various commands
to the user subroutine direction ufile, as in the WRITE
option above.
– SUMMARY. Lists the names of the user subroutines that can
be used in the SUBNAME fields above. Entering the keyword
SUMMARY in those fields will also provide this list.
VDISTANCE, NV1, NV2: Calculates the distance between two vertices.
NV1, NV2
– Any two predefined vertices.
VOLUME, NC1, NC2, NCINC(1): Calculates the volume within the specified cell
range. A running total of volume is kept until the VOLUME command is entered
with no cell range following.
NC1, NC2,
NCINC
– Calculates the volume of all fluid and solid cells in the range
NC1 to NC2 by NCINC. NC1 may be replaced with ALL,
CSET or CX; in any of those cases, NC2 and NCINC will be
ignored.
Table Data
TBCLEAR: Clears all table data.
TBDEFINE, TITLE(DATA): Defines a table.
6-18
Version 3.26
Chapter 6
UTILITIES MODULE
Table Data
TITLE
– Title of the table. Up to 80 characters are allowed with spaces.
The user will then be prompted for table parameters and data in a series of steps (see
command TBREAD for more information concerning tables).
TBLIST, OPTION: Lists the currently loaded table.
OPTION
– ALL. Lists all data and information for the currently loaded
table.
– INFO. Lists information concerning the currently loaded table.
– FIX,VAR1,VAL1,VAR2,VAL2,…. Only lists data
corresponding to independent variable VAR fixed at value
VAL.
TBMODIFY, OPTION: Modifies table data. Data and values corresponding to
existing variables can be modified, added or deleted. New independent or
dependent variables cannot be added and existing variables cannot be deleted.
OPTION
– ADD,VAR,VAL. Adds dependent variable data for
independent variable VAR = VAL to data set.
– DELETE,VAR,VAL. Deletes all data corresponding to
independent variable VAR = VAL from data set.
– MODIFY,VAR1,VAL1,VAR2,VAL2, …. Modifies dependent
variable data for independent variable VAR1 = VAL1, etc. A
value must be specified for each independent variable.
If OPTION is add or modify, the user will then be prompted for dependent variable
data. If OPTION is add, a blank field is interpreted as 0. If OPTION is modify, a
blank field leaves the dependent variable value unchanged.
TBREAD, LF(case.tbl): Reads a table from a file. Lines containing character
strings must not be longer than 132 characters. Numerical data is read with free
format so that either spaces or commas can be used as delimiters. The table is sorted
after it is read in so that independent variables do not need to be listed in ascending
order.
Version 3.26
6-19
UTILITIES MODULE
Chapter 6
Table Data
LF
– File name.
The table can have up to four independent variables and up to 100 dependent
variables. In any case, the total number of entries the table can have is equal to
parameter MXSTOR. Only one table can be loaded at a time. To save a table, it must
be written to a file (see command TBWRITE) before exiting pro-STAR or loading
or defining another table. The geometry scale factor used in the GEOM command
is also applied to table coordinates when it is accessed by STAR.
Space coordinate independent variable values depend on the table coordinate
system type as follows.
Cartesian
Cylindrical
Spherical
Toroidal
X
Y
Z
R
THETA (θ)
Z
R
THETA (θ)
PHI (φ)
R
THETA (θ)
PHI (φ)
Linear interpolation is used for dependent variables values corresponding to
independent variable values within the data set. Points outside the data set are
processed in accordance with the VOPTION listed in the file. (Note that a CUTOFF
value is always used for plotting purposes.)
VOPTION
– ERROR. An error message will be given if points outside the
table data set are accessed.
– CUTOFF. Values outside the data set will be given by the
closest data point.
– EXTRAPOLATE. Values outside the data set will be obtained
by extrapolating the closest two data points of the table.
The table file must remain in the working directory when the problem file
(case.prob) is written so that the table can be included and accessed by STAR.
A table which is modified in pro-STAR must be rewritten to a file before running
STAR.
The standard format of the input file is as follows:
6-20
TABLE <table name>
Optional; up to 80 characters
allowed with spaces
LOCAL <table coordinate system number>
Optional; 1 if omitted
VOPTION <error/extrapolate/cutoff>
Optional; ‘error’ if omitted
Version 3.26
Chapter 6
UTILITIES MODULE
Table Data
INDEPENDENT
<IVAR1, NVAL1, IVAR2, NVAL2, …>
<IVAR, VAL1, VAL2, VAL3, …, IVALN>
<IVAR, VAL1, VAL2, VAL3, …, IVALN>
:
:
<DVAR1, DVAR2, DVAR3, …, DVAR10>
<VAL11, VAL21, VAL31, …, VAL101>
<VAL12, VAL22, VAL32, …, VAL102>
:
:
<DVAR11, DVAR12, DVAR13, …>
<VAL111, VAL121, VAL131, …>
<VAL112, VAL122, VAL132, …>
IVAR = ‘independent variable’.
NVAL = ‘number of values’.
No more than 19 values provided
it is less than 132 characters on
the first line. IVAR names are one
to four characters.
DVAR = ‘dependent variable’.
Up to 10 DVARs per line. Order
of DVAR values corresponds to
indexing first IVAR, then second
IVAR, etc. DVAR names are one
to 25 characters.
:
:
For example:
TABLE, BOUNDARIES FOR INLET REGION 2
LOCAL, 12
VOPTION, CUTOFF
INDEPENDENT Z, 4, Y, 3
Z 1.0, 2.0, 3.0, 4.0
Y 11.0, 12.0, 13.0
U
V
T
10.0
1.1
320.3
(data corresponds to Z = 1.0, Y = 11.0)
15.0
1.2
322.4
17.5
1.5
326.4
18.7
2.1
328.8
19.3
2.2
329.1
19.6
2.5
331.0
18.7
2.7
332.5
17.5
2.9
335.8
15.0
3.1
337.9
10.0
3.3
339.2
5.0
3.4
340.4
0.0
4.0
345.6
Alternatively, the independent variables can be listed as columns instead of rows.
This is useful if the number of values of an independent variable is not known by
the table writing program prior to writing out the values. In this case, a ‘0’ is entered
for the number of values of the last independent variable. For example:
Version 3.26
6-21
UTILITIES MODULE
Chapter 6
Table Data
LOCAL, 12
VOPTION, CUTOFF
Z
Y
U
V
1.0
11.0
10.0
1.1
2.0
11.0
15.0
1.2
3.0
11.0
17.5
1.5
4.0
11.0
18.7
2.1
1.0
12.0
19.3
2.2
2.0
12.0
19.6
2.5
3.0
12.0
18.7
2.7
4.0
12.0
17.5
2.9
1.0
13.0
15.0
3.1
2.0
13.0
10.0
3.3
3.0
13.0
5.0
3.4
4.0
13.0
0.0
4.0
T
320.3
322.4
326.4
328.8
329.1
331.0
332.5
335.8
337.9
339.2
340.4
345.6
Also, additional dependent variables can be read from the very next lines rather than
after the entire data set as outlined above in the ‘standard format’. In this case, a
‘DEPENDENT’ statement is used. For example:
6-22
Version 3.26
Chapter 6
UTILITIES MODULE
Table Data
LOCAL, 12
VOPTION, CUTOFF
DEPENDENT U, W
DEPENDENT V, T
10.0
11.0
1.0
1.1
15.0
11.0
2.0
1.2
17.5
11.0
3.0
1.5
18.7
11.0
4.0
2.1
19.3
12.0
1.0
2.2
12.0
19.6
2.0
2.5
12.0
18.7
3.0
2.7
12.0
17.5
4.0
2.9
13.0
15.0
1.0
3.1
13.0
2.0
10.0
3.3
13.0
3.0
5.0
3.4
13.0
4.0
0.0
4.0
.41
320.3
.19
322.4
.09
326.4
.79
328.8
.42
329.1
.20
331.0
1.06
332.5
.54
335.8
.26
337.9
1.13
339.2
.63
340.4
.23
345.6
TBSCAN, LF(case.tbl): Scans a table file for information concerning the table.
LF
– File name.
TBWRITE, LF(case.tbl): Writes a table to a file. The file is coded and its
format is described in command TBREAD.
LF
Version 3.26
– File name.
6-23
UTILITIES MODULE
Chapter 6
Engineering Monitoring Data
Engineering Monitoring Data
EDSCAN, LF(case.ecd): Scans an engineering cell set or region data file
(*.ecd or *.erd) for information concerning the data.
LF
– File name.
6-24
Version 3.26
Chapter 7
PROPERTY MODULE
Housekeeping
Chapter 7
PROPERTY MODULE
Housekeeping
CHSCHEME, IMAT(MATCUR), ICSC: Applies a chemical reaction scheme to
a specified fluid material. This command should be executed only after all
parameters of the chosen chemical reaction scheme are specified.
IMAT
– Material number for which to apply the chemical reaction
scheme. The material must be fluid. The default is the
currently active material number (see command
PMATERIAL).
ICSC
– A predefined chemical reaction scheme number. The default is
the currently active chemical reaction scheme number (see
command CRTYPE). If NONE is entered, no chemical
reaction scheme will be applied to the fluid stream.
HELP
or
MLIST, OPTION, IMAT1(1), IMAT2(IMAT1), IMATINC(1), LOPTION,
POPTION: Lists material properties.
Version 3.26
OPTION
– BRIEF (default). Lists only the material numbers, types, and
names.
– FULL. Lists the full material property definitions.
IMAT1,
IMAT2,
IMATINC
– Range of materials to list defined by IMAT1 to IMAT2 by
IMATINC. The keyword ALL may be used in place of IMAT1.
7-1
PROPERTY MODULE
Chapter 7
Housekeeping
LOPTION
– Specifies which materials in the selected range are to be listed:
– ALL (default). All materials in the selected range.
– DEFINED. Only defined (i.e. fluid and solid) materials in the
selected range.
– FLUID. Only fluid materials in the selected range.
– SOLID. Only solid materials in the selected range.
– UNDEFINED. Only undefined materials in the selected
range.
POPTION
– For OPTION = FULL, specifies what material property
definitions are to be listed (when applicable):
– ALL (default). All properties.
– ACCE. Acceleration.
– CHEM. Chemical scheme.
– COND. Thermal conductivity.
– CP. Specific heat.
– DENS. Density.
– INIT. Initial conditions.
– LOWR. Low Reynolds number model status.
– MONI. Cell at which solution is being monitored.
– NOX. NOx model properties.
– PRES. Reference pressure.
– RADI. Radiation properties.
– SPIN. Spin properties.
– TEMP. Temperature.
– TURB. Turbulence properties.
– TWOL. Two-layer model status.
– VISC. Viscosity.
PDELETE, IMAT1(1), IMAT2(IMAT1), IMATINC(1): Deletes the definitions
of a range of fluid material property sets.
IMAT1,
IMAT2,
IMATINC
– Range of properties defined by IMAT1 to IMAT2 by
IMATINC.
PGENERATE, NSETS, MOFF, IMAT1(1), IMAT2(IMAT1), IMATINC(1):
Generates additional property sets by copying an initial range of property values to
new locations offset by MOFF.
7-2
Version 3.26
Chapter 7
PROPERTY MODULE
Housekeeping
NSETS
– Number of property sets to generate. The initial set is included
in the NSET count, therefore NSET must be > 1.
MOFF
– Offset to add to each property ID to create new sets.
IMAT1,
IMAT2,
IMATINC
– Starting range of property IDs from which NSET–1 new sets
will be created.
PMATERIAL, IMAT(1), OPTION, NAME, IMTYPE(0), PHASE: Sets the
current material property number. All properties defined after this command (until
the next PMATERIAL command) apply to material IMAT.
Materials are assigned to fluid and solid cells through the IMAT parameter in the
CTABLE command. For single fluid problems, only material number 1 should be
defined as a fluid. For multiple fluid problems, each fluid stream must be
completely separated from all others by walls or conducting baffles. For free surface
problems (see command FSURFACE), material number 1 is defined as the light
fluid, material number 2 is defined as the heavy fluid and all other material numbers
are ignored.
IMAT
– Current material property reference number. IMAT cannot be
greater than 99. For free surface problems, IMAT must be
either 1 or 2 or the keywords LIGHT or HEAVY may be used.
OPTION
– /FLUID/SOLID/. Defines whether material IMAT is a fluid
stream or a solid region (for conjugate gradient heat transfer
analyses). This field is ignored for free surface problems.
NAME
– An (up to 80-character) identifier (no blanks or commas). If
left blank, any previous name will not be changed.
IMTYPE
– 0. Uses user-supplied or database property values for this
material.
– 1. If the material in the current fluid stream is water, uses
STAR’s built-in water-steam table to calculate properties.
PHASE
– Phase number. For single-phase flow, PHASE is ignored. For
Eulerian multiphase analysis, PHASE can be 1 or 2.
15.1, 16.1, 16.2, 16.3, 17.2
STATUS, IMAT (current material number): Displays the status of all
PROPERTY settings for material number IMAT.
Version 3.26
7-3
PROPERTY MODULE
Chapter 7
Material Properties
IMAT
– Material property reference number.
Material Properties
CONDUCTIVITY, OPTION: Sets the value of thermal conductivity for the
current material.
For free surface flows, this command is used to specify the thermal conductivity
of both heavy and light fluids. The material number is IMAT = 1 for the light fluid
and IMAT = 2 for the heavy fluid. The only options applicable are CONSTANT,
MULTICOMPONENT and USER. It is possible to choose different options for the
heavy and light fluids.
OPTION
– CONSTANT, K (.02637 fluid/43.0 solid). Conductivity is
constant.
– MULTICOMPONENT, K (.02637 fluid/43.0 solid). The
equation solver for conductivity is turned on. The value of
conductivity is calculated using a constant value for the
background fluid plus the contribution of any scalars.
– POLYNOMIAL. Conductivity is defined by a polynomial
specified by the POPK command for the material and by the
POSK command if there are any scalars.
– USER,K (.02637 fluid/43.0 solid). User subroutine CONDUC
will be used to define the conductivity. K is used for any cell
not set in CONDUC.
– ANISOTROPIC,DIROPT(LOCAL),K1,K2,K3. Activates
anisotropic conductivity. This option is only valid for solid
materials.
– DIROPT.
– LOCAL,ICSYS(1). K1, K2 and K3 refer to conductivities
in the three directions of local coordinate system ICSYS.
– CELL. K1, K2 and K3 refer to conductivities in the i, j and
k directions of a cell.
– STKI (STAR/KINETICS). The conductivity is calculated by
STAR/KINetics.
– KINETIC. Conductivity is calculated by kinetic theory.
DENSITY, OPTION: Sets various options for the calculation of density by STAR
for the current material (see command PMATERIAL).
7-4
Version 3.26
Chapter 7
PROPERTY MODULE
Material Properties
OPTION
– CONSTANT,RHO. The value of density is a constant value of
RHO (the default value is = 1.205 kg/m3 for fluid materials
and 7800.0 kg/m3 for solid materials). This is the only
allowable option for solid materials and the default option for
fluid materials.
– IDEALGAS,LPRES(Y/N). The density equation solver is
turned on, and density is evaluated by the ideal gas law.
LPRES indicates whether density is a function of temperature
and pressure (Y) or temperature only (N). The default is Y. The
user must provide the molecular weight of the fluid using the
MOLWT command.
– ISOBARIC,DREF(1.205),BETA(0.0). The density equation
solver is turned on to solve the isobaric equation. DREF is the
reference density, and BETA is the volumetric expansion
coefficient.
– MULTICOMPONENT,RHO(1.205). The density equation
solver is turned on, and STAR will calculate density from
RHO (constant density of the background fluid) and any scalar
mass fractions.
– USER,LPRES(Y/N),DREF(1.205). The density equation
solver is turned on, and density is calculated in user subroutine
DENSIT. DREF (reference density) is used for any cell not set
in DENSIT. LPRES indicates whether density is a function of
temperature and pressure (Y) or temperature only (N). The
default is Y. The user must provide the molecular weight of the
fluid using the MOLWT command.
– COMPLIQ,DREF(1000.0),BETA(3.9E-4). The density
equation solver is turned on, and a default compressibility
function will be used to link the liquid density with pressure
and temperature. DREF is the density under reference
conditions. BETA is the volumetric expansion coefficient for
the liquid. Note: This option is available only for free-surface
and cavitation flows.
15.1, 16.1, 16.2, 16.3, 17.2
DIFFUSIVITY, OPTION: Defines the method of calculating mass diffusivity in
the mixture.
OPTION
Version 3.26
– CONSTANT,DM(3.00E4-05). The diffusivity is constant.
– POLYNOMIAL. Diffusivity is defined by a polynomial,
specified by command POPD for the background material and
by command POSD for any scalars present.
7-5
PROPERTY MODULE
Chapter 7
Material Properties
OPTION
– USER,DM(3.00E-05). User subroutine DIFFUS will be used
to define the diffusivity. DM is used for any cell not set in
DIFFUS.
– STKI (STAR KINETICS). The diffusivity is calculated by
STAR Kinetics.
– KINETIC. The diffusivity is calculated by the kinetic theory.
HCOEFF, OPTION: Tells the program whether or not user subroutines are
available to calculate heat or mass transfer (film) coefficients.
OPTION
– STANDARD. Uses the default STAR formulation.
– USER. User subroutine MODSWF is used for calculation of
heat and mass transfer coefficients.
LVISCOSITY, OPTION: Sets the value of molecular viscosity for the current
material.
For free surface flows, this command is used to specify the laminar viscosity of
both heavy and light fluids. The material number is IMAT = 1 for the light fluid and
IMAT = 2 for the heavy fluid. The only options applicable are CONSTANT,
MULTICOMPONENT, NONNEWTONIAN and USER. It is also possible to
choose different options for the heavy and light fluids.
OPTION
7-6
– CONSTANT,LAMVIS(1.81E-5). Molecular viscosity is
constant with a value equal to LAMVIS.
– INVISCID. The flow is inviscid.
– MULTICOMPONENT,LAMVIS(1.81E-5). The molecular
viscosity equation solver is turned on. Molecular viscosity is
calculated using a constant value (LAMVIS) for the
background fluid plus the contribution of any scalars.
– NONNEWTONIAN,EM(0.0),EN(0.0). The molecular
calculated according to the non-Newtonian power law which
requires the constants EM and EN.
– SUTHERLAND,MU0(1.716E-5),CS(116.0). Molecular
viscosity is defined by Sutherland's Law. MU0 is the reference
dynamic viscosity and CS is the Sutherland constant specified
at 273.15 degrees Kelvin (0 degrees Centigrade) and 101325
Pascals (1 atmosphere).
Version 3.26
Chapter 7
PROPERTY MODULE
Material Properties
OPTION
– POLYNOMIAL. Molecular viscosity is defined by a
polynomial specified by the POPLV command for the material
and by the POSLV command if there are any scalars.
– USER,LAMVIS(1.81E-5). The molecular viscosity equation
solver is turned on. User subroutine VISMOL will be used to
define the molecular viscosity. LAMVIS is used for any cell
not set in VISMOL.
– STKI (STAR/KINETICS). The molecular viscosity is
calculated by STAR/KINetics.
– KINETIC. Molecular viscosity is calculated by the kinetic
theory.
MOLWT, WTMOL(28.96): Sets the value of molecular weight for the current
material.
WTMOL
– The value of molecular weight. The default is the value for air.
RADPROPERTIES, USEROPT, ABSORP(0.1), SCATTER(0.0): Defines
radiation properties for the current material.
USEROPT
– CONSTANT. Constant values of the absorption and scattering
coefficients are used.
– USER. The absorption coefficient and the scattering coefficient
are specified in user subroutine RADPRO.
ABSORP
– Absorption coefficient.
SCATTER
– Scattering coefficient.
Note: Under normal circumstances, the sum of absorptivity and the scattering
coefficient should not be greater than 1.0.
RSOURCE, STYPE, LOCAT, INUM, SOPT: Specifies enthalpy, mass,
momentum, or turbulence source terms.
STYPE
Version 3.26
– /ENTHALPY/MASS/MOMENTUM/TURBULENCE/.
Determines the type of source term being defined.
7-7
PROPERTY MODULE
Chapter 7
Material Properties
LOCAT
– /CTABLE/MATERIAL/. Determines whether the source term
is being defined for a cell table or for a material.
INUM
– Cell table number or material number. The default is the
current cell table or material (see command CTYPE and
command PMATERIAL).
SOPT
– OFF (default). No source term specified.
– POLYNOMIAL. Source term is specified using a polynomial
defined in the POLENTHALPY command. This option is valid
only for STYPE = ENTHALPY.
– TABLE,TBNAME. Source term is specified using table
TBNAME. This option is not valid for
STYPE = TURBULENCE.
– USER. Source term is specified using a user subroutine. The
user subroutines used for enthalpy, mass, momentum, and
turbulence are SORENT, FLUINJ, SORMOM, and SORKEP,
respectively.
Note: The LOCAT and INUM arguments are ignored if SOPT is POLYNOMIAL
or USER. Polynomial and user subroutine source terms are defined for the entire
model.
Note: If source terms are specified by table for a given source type, then the tables
can be defined either by material or by cell table, but not by both.
SPECIFICHEAT, OPTION: Sets the value of specific heat for the current
material.
Notes:
1. For fluid materials, if the DENSITY command has been set to CONSTANT
or MULTICOMPONENT, the specific heat C refers to the specific heat at
constant volume (CV). Otherwise, it refers to the specific heat at constant
pressure (CP). The default value of C is 1006.
2. For solid materials, the only allowable OPTIONs are CONSTANT and
USER. The default value of C is 473.
3. For free-surface flows, this command is used to specify the specific heat of
both heavy and light fluids. The material number is IMAT = 1 for the light
fluid and IMAT = 2 for the heavy fluid. Only options CONSTANT,
MULTICOMPONENT and USER are applicable. It is possible to choose
different options for the heavy and light fluids.
OPTION
7-8
– CONSTANT,C. The specific heat is constant and has a value of
C.
Version 3.26
Chapter 7
PROPERTY MODULE
Material Properties
OPTION
– MULTICOMPONENT,C. The equation solver for specific heat
is turned on. The value of specific heat is calculated using a
constant value C for the background fluid plus the contribution
of any scalars.
– POLYNOMIAL. The specific heat is defined by a polynomial
specified by the POPCP command for the material and by the
POSCP command if there are any scalars. The user must
provide the molecular weight of the material using command
MOLWT.
– USER,C. For solid materials only. The specific heat is
calculated directly using user subroutine SPECHT. C is a
reference value for the specific heat that is supplied to the
subroutine.
– USER,UOPTION. For fluid materials only. Allows the user to
select one of four user subroutines. UOPTION is one of the
following:
– DEFAULT,C. The specific heat is calculated directly using
user subroutine SPECHT. C is a reference value for the
specific heat that is supplied to the subroutine.
– HOFT. Enthalpy is calculated as a function of temperature in
user subroutine CONVTE.
– TOFH. Temperature is calculated as a function of enthalpy in
user subroutine CONVET.
– BOTH. Both enthalpy and temperature can be calculated in
user subroutine COTEET.
– STKI (STAR/KINETICS). The specific heat is calculated by
STAR/KINetics.
SRCLIST, STYPE, NSC, LOCAT: Lists source terms defined in the RSOURCE
and SCSOURCE commands.
Version 3.26
STYPE
– /ENTHALPY/MASS/MOMENTUM/SCALAR/
/TURBULENCE/. Determines the type of source term being
listed.
NSC
– Scalar number. This is used only if STYPE = SCALAR. Leave
blank or use the keyword ALL to list the source terms for all
defined scalars.
7-9
PROPERTY MODULE
Chapter 7
Polynomial Representations
LOCAT
– ALL (default). Lists source terms for all cell tables and
materials.
– CTABLE,ICTID. Lists source terms for cell table ICTID. If
ICTID is blank or ALL, source terms for all defined (fluid,
solid, or baffle) cell tables will be listed.
– MATERIAL,IMAT. Lists source terms for material IMAT. If
IMAT is blank or ALL, source terms for all defined materials
will be listed.
POLENTHALPY, IMAT, OPTION1, OPTION2: Defines a polynomial function
to describe the enthalpy source terms.
IMAT
– Material number.
OPTION1
– /S1P/S2P/. Choose enthalpy source term S1P or S2P.
OPTION2
– LIST. List the coefficients.
– USER,IRANGE,RANGE1,RANGE2,NTERM,NC1,NC2. The
coefficients are user-defined, and the user will be prompted for
their values.
– IRANGE. Range number for which the coefficients are
specified. Up to five ranges can be specified.
– RANGE1,RANGE2. Temperature range for which the
coefficients are applicable.
– NTERM. Number of polynomial terms (max = 10).
– NC1. Starting coefficient number (default = 1).
– NC2. End coefficient number (default = NTERM).
– CLEAR,IRANGE1,IRANGE2. Range numbers from
IRANGE1 to IRANGE2 will be cleared. If ALL is used
instead of IRANGE1, all specified coefficients in all ranges
will be cleared.
POPCP, OPTION: Defines a polynomial function to describe specific heat,
enthalpy and entropy for a material.
OPTION
7-10
– LIST. Lists the coefficients.
Version 3.26
Chapter 7
PROPERTY MODULE
OPTION
Version 3.26
– STANDARD or CHEMKIN. The coefficients are retrieved
from a special file, chemkin.dbs, containing the
CHEMKIN thermodynamic database. The substance name
will be prompted for. By default, the CHEMKIN database
consists of two ranges with coefficients for specific heat (up to
5, the sixth value is for enthalpy and the seventh for entropy)
and the user can append to or modify the database using the
following format:
– Line 1: species name, optional comments, elemental
composition, phase, T(low), T(high), T(mid), additional
elemental composition, card number (col. 80); format
(A10,A14,4(A2,I3),A1,E10.0,E10.0,E8.0,(A2,I3),I1).
– Line 2: coefficients a(1–5) for upper temperature range, card
number (col. 80); format (5(E15.0),I1).
– Line 3: coefficients a(6–7) for upper temperature range,
coefficients a(1–3) for lower temperature range, card number
(col. 80); format (5(E15.0),I1).
– Line 4: coefficients a(4–7) for lower temperature range, card
New materials should be inserted in alphabetical order in the
chemkin.dbs file.
– CEC. The coefficients are retrieved from a special file,
cecthrm.dbs containing the thermodynamic database used
by the NASA Chemical Equilibrium Codes. The substance
name will be prompted for. By default, the CEC database
and the user can append to or modify the database keeping in
mind the following general format:
– Line 1: species name, date, atomic symbols and formula,
T(low), T(high), card number (col. 80); format
(A12,A6,4(A2,F3.0),A1,E10.0,E10.0,14X,I1).
(col. 80); format (5(E15.0),I1).
– New materials should be inserted in alphabetical order in the
cecthrm.dbs file.
7-11
PROPERTY MODULE
Chapter 7
OPTION
coefficients are user-defined and the user will be prompted for
their values.
– NTERM. Number of polynomial terms (max = 10). The
NTERM+1th term is only used for enthalpy. The
NTERM+2th term is only used for entropy.
– NC2. End coefficient number (default = NTERM+2).
– CLEAR,IRANGE1,IRANGE. Range numbers from
IRANGE1 to IRANGE2 will be cleared. If ALL is used in lieu
of IRANGE1, all specified coefficients in all ranges will be
cleared.
– GSTORE,DELTAT(100.0),REG1(1),REG2(2),REG3(3),
REG4(4),TRANGE1,TRANGE2,WTMOL(0.0). Stores c p ⁄ R ,
h ⁄ RT and s ⁄ R calculated at DELTAT temperature increments
from TRANGE1 to TRANGE2 (default entire range) with
temperature, specific heat, enthalpy and entropy values stored
in graph registers REG1, REG2, REG3 and REG4,
respectively. The plots appear in graph frames 1, 2 and 3. If
molecular weight (WTMOL) is specified c p , h and s will be
stored.
Note: The definitions for specific heat, enthalpy and entropy are as shown below:
c
----p- =
R
h
--- =
R
n
∑ ( ai T
i=1
n
∑
i=1
i–1
)
(7-1)
i
T
a i ----- + a n + 1
i
s
--- = a 1 ln T +
R
n
∑
(7-2)
i–1
i=2
⎛a T
------------ ⎞ + a n + 2
⎝ i i–1⎠
(7-3)
POPD, NSCJ, IPTYP(2), OPTION: Defines a polynomial function to describe the
mass diffusivity of the current (background) material in scalar NSCJ.
NSCJ
7-12
– Index of scalar J.
Version 3.26
Chapter 7
PROPERTY MODULE
IPTYP
– Parameter determining the polynomial form to use (see
below).
OPTION
their values.
– IRANGE. Range number for which the coefficients
cleared.
– DIFFU SPECIESI SPECIESJ. The coefficients for the pair
SPECIESI,SPECIESJ are retrieved from internal database
diffu.dbs (in double-logarithmic form). SPECIESI and
SPECIESJ are the alphanumeric character names (chemical
formulas) of the background material and scalar NSCJ,
respectively. This option allows only one temperature range
and four coefficients. It is also only valid for IPTYP = 2.
– GSTORE,DELTAT(100.),REG1(1),REG2(2),TRANGE1,
TRANGE2. Calculates the diffusivity according to the
polynomial function corresponding to the IPTYP value and
stores it at DELTAT temperature increments from temperature
TRANGE1 to temperature TRANGE2 (default is the entire
range). Temperature and values are stored in graph registers
REG1 and REG2, respectively.
Notes:
1. The form of the polynomial is
n
D ij =
∑ ak, ij T
k–1
(7-4)
k=1
if IPTYP = 1, where a k, ij are the prescribed coefficients, or
n
ln ( D ij ) =
∑ ak, ij ( ln T )
k–1
(7-5)
k=1
if IPTYP = 2, or
Version 3.26
7-13
PROPERTY MODULE
Chapter 7
n
ln ( D ij ) =
a k, ij
-------------------∑ ( l – 1-)
k = 1 ln T
if IPTYP = 3.
2. Options ‘DIFFU SPECIESI SPECIESJ’ and ‘DIFFU SPECIESJ SPECIESI’
are the same (that is D ij = D ji ) and there is only one combination in the
database. This command should get the correct values no matter what the
combination is.
POPK, IPTYP(2), OPTION: Defines a polynomial function to describe the
thermal conductivity of the current material.
IPTYP
below).
OPTION
their values.
cleared.
– CONDU,SPECIES. Coefficients for the material are retrieved
from an internal database called condu.dbs. SPECIES is the
alphanumeric character name (chemical formula) of the
material. This option allows only one temperature range and
four coefficients. It is also only valid for IPTYP = 2.
– GSTORE,DELTAT(100.0),REG1(1),REG2(2),TRANGE1,
TRANGE2. Calculates the thermal conductivity according to
the polynomial function corresponding to the IPTYP value and
TRANGE1 to TRANGE2 (default is the entire range).
Temperature and conductivity values are stored in graph
registers REG1 and REG2, respectively.
Note: The form of the polynomial is:
7-14
Version 3.26
Chapter 7
PROPERTY MODULE
Regular:
n
K =
∑ ai T
i–1
(7-6)
i=1
if IPTYP = 1, where a i are the prescribed coefficients, or
Double Logarithmic:
n
∑ ai ( ln T )
ln ( K ) =
i–1
(7-7)
i=1
if IPTYP = 2, or
Inverse Double Logarithmic:
n
ln ( K ) =
ai
-------------------(i – 1)
ln
T
i=1
∑
if IPTYP = 3.
POPLV, IPTYP(2), OPTION: Defines a polynomial function to describe the
molecular viscosity of the current material.
Version 3.26
IPTYP
below).
OPTION
their values.
cleared.
7-15
PROPERTY MODULE
Chapter 7
Porous Properties
OPTION
– VISCO,SPECIES. Coefficients for the material are retrieved
from an internal database called visco.dbs. SPECIES is the
material. This option allows only one temperature range and
four coefficients. It is also only valid for IPTYP = 2.
TRANGE2. Calculates the molecular viscosity according to
Temperature and viscosity values are stored in graph registers
Regular:
n
µ =
∑ ai T
i–1
(7-8)
i=1
Double Logarithmic:
n
ln ( µ ) =
∑ ai ( ln T )
i–1
(7-9)
i=1
if IPTYP = 2, or
n
ln ( µ ) =
ai
-------------------(i – 1)
ln
T
i=1
∑
if IPTYP = 3.
Porous Properties
PORDELETE, IPOR1(1), IPOR2(IPOR1), IPORINC(1): Deletes the porosity
definitions for the indicated range of porosity reference IDs.
7-16
Version 3.26
Chapter 7
PROPERTY MODULE
Porous Properties
IPOR1,
IPOR2,
IPORINC
– Deletes porosity definitions for IDs IPOR1 to IPOR2 in steps
of IPORINC.
POREFF, IPOR(1), OPTION, EFFCON(.02637), PRANDTL(.9): Adds values
for effective conductivity and turbulent Prandtl number to a given porosity
definition.
IPOR
– Porosity reference number.
OPTION
– STANDARD. Uses the numbers supplied.
– USER. User subroutine PORCON will be used for the
calculation of these two values.
EFFCON
– Effective conductivity.
PRANDTL
– Turbulent Prandtl number.
PORLIST, IPOR1(1), IPOR2(IPOR1), IPORINC(1): Lists the porosity
definitions for the indicated range of porosity reference IDs.
IPOR1,
IPOR2,
IPORINC
– Lists porosity definitions for IDs IPOR1 to IPOR2 in steps of
IPORINC.
POROSITY, IPOR(1), OPTION1, OPTION2, ALPHAI, BETAI, ALPHAJ,
BETAJ, ALPHAK, BETAK, ICSYS(1), RVEL(.1), POROS(1.): Defines a
porosity model for the given porosity ID. This model is then applied to all cells
referenced to this IPOR in the CTABLE. The user may elect to reference the I,J,K
indices to any local coordinate system or to the cell coordinate system of each
individual cell (see Figure 7-1). The user may also opt for a user-written subroutine
in cases where the built-in STAR models do not provide enough flexibility. The
flow resistance due to the porous medium is given by K = ( α n V ) + β n , where n
loops through I, J and K.
IPOR
Version 3.26
– Porosity ID reference number. IPOR must be less than 100.
7-17
PROPERTY MODULE
Chapter 7
Porous Properties
OPTION1
– STANDARD. The user provides one set of ALPHA and BETA
values that apply to all cells keyed to this porosity model.
– USE1. The resistance for the cells referenced to this IPOR will
be supplied in user subroutine POROS1. The subroutine
accepts ALPHA and BETA values that can be varied cell by
cell.
– USE2. The resistance for the cells referenced to this IPOR will
be supplied in user subroutine POROS2. The subroutine
requires a full resistance matrix that can be varied cell by cell.
OPTION2
– CELL. I, J and K directions refer to the cell coordinate system
for each individual cell (see Figure 7-1).
– LOCAL. I, J and K directions refer to a given local coordinate
system.
ALPHAI,
BETAI, …,
BETAK
– The resistance coefficients for this porosity model. These
should conform to the equation above. Their values are applied
as defaults for any cells not specifically defined in the user
subroutines. Note that if OPTION2 = CELL, the values of
ALPHAK and BETAK must be the same as ALPHAJ and
BETAJ, i.e. ALPHAK = ALPHAJ, BETAK = BETAJ.
ICSYS
– The local coordinate system reference number. This is needed
only when OPTION2 = LOCAL is chosen. It should be left
blank if OPTION2 = CELL.
RVEL
– Lower limit on velocity in the porous media for the purpose of
calculating resistance.
POROS
– Porosity of the porous region (0 ≤ POROS ≤ 1.0).
7-18
Version 3.26
Chapter 7
PROPERTY MODULE
Porous Properties
7
8
K
6
5
J
3
4
1
2
Figure 7-1
I
Cell coordinate system definition
PORTURBULENCE, IPOR(1), OPTION, INTENSITY(.1), LENGTH(.01):
Adds values for turbulence intensity and length scale to a given porosity definition.
IPOR
– Porosity reference number.
OPTION
– STANDARD. Uses the numbers supplied.
– USER. User subroutine PORKEP will be used for the
calculation of these two values.
INTENSITY – Turbulence intensity.
LENGTH
– Length scale.
SCPOROUS, OPTION, NSC(1), IPOR(1), DIFFUS(3.004E–05),
SCHMIDT-TRB(.9), USEROPT: Allows the user to define a value for porous
diffusivity and turbulent Schmidt number for any scalar. The user may supply
unique values of diffusivity for up to 2000 different combinations of NSC and
IPOR.
Version 3.26
OPTION
– ADD. Adds a new value to the list.
– DELETE. Deletes a value from the list.
– LIST. Lists currently stored values.
NSC
– Scalar number for which value applies.
IPOR
– Porous material property number for which value applies.
DIFFUS
– Value of diffusivity.
7-19
PROPERTY MODULE
Chapter 7
Scalar Properties
SCHMDT-TRB – Value of turbulent Schmidt number.
USEROPT
– STANDARD. The porous diffusivity values given in this
command are the ones used by the analysis.
– USER. The user will supply a FORTRAN source code
subroutine (PORDIF) to define the porous diffusivity values
for this region. The values supplied in the command will be
used as defaults for any value not assigned in the user
subroutine.
Scalar Properties
POLSCALAR, NSC, OPTION1, OPTION2: Defines a polynomial function to
describe the scalar source terms.
NSC
– Scalar number.
OPTION1
– /S1P/S2P/. Choose scalar source term S1P or S2P.
OPTION2
– LIST. List the coefficients.
their values.
– RANGE1,RANGE2. Mass fraction range for which the
cleared.
SCPLIST, OPTION, NSC1(1), NSC2(NSC1), NSCINC(1), IMAT: Lists the
attributes/properties defined for a range of scalar variables for a given material
number.
OPTION
7-20
– /BRIEF/FULL/.
Version 3.26
Chapter 7
PROPERTY MODULE
Scalar Properties
NSC1, NSC2, – Values will be listed for scalars NSC1 to NSC2 by NSCINC.
NSCINC
The keyword ALL may be used in place of NSC1 to list values
for all defined scalars.
IMAT
– Material number for which to list the values. The default is the
currently active material number (see command
PMATERIAL). The keyword ALL may be used to list values
for all defined materials.
SCPROPERTIES, NSC(1), IMAT, METHOD, DIFFUS(3.004E-05),
SCHOPT, SCHMNO(0.9): Defines material-dependent properties for scalars.
NSC
– Scalar number.
IMAT
– Material number. The default is the currently active material
number (see command PMATERIAL). The keyword ALL may
be used in place of IMAT to specify all defined materials.
METHOD
– The solution method of the scalar for the given material.
– TRANSPORT (default). Standard transport equation.
– USER. User subroutine SCALFN will be used for the
solution.
– INTERNAL. Internal algebraic solution, such as the one set
up by the PPDF command. This option should not be chosen
unless a chemical reaction model has already been set up.
– DIFFUSIONONLY. Suppresses convection terms when
solving the transport equation.
– OFF. No solution.
DIFFUS
– Value of scalar diffusivity in the mixture.
SCHOPT
– /CONSTANT/USER/. Specification for the turbulent Schmidt
number. The user subroutine is VARPRT.
SCHMNO
– Turbulent Schmidt number.
SCSOURCE, NSC, LOCAT, INUM, SOPT: Specifies scalar source terms.
Version 3.26
NSC
– Scalar number. The keyword ALL may be used to define the
source terms for all defined scalars.
LOCAT
– /CTABLE/MATERIAL/. Determines whether the source term
is being defined for a cell table or for a material.
7-21
PROPERTY MODULE
Chapter 7
Problem Conditions
INUM
– Cell table number or material number. The default is the
current cell table or material (see command CTYPE and
command PMATERIAL).
SOPT
– OFF (default). No source term specified.
– POLYNOMIAL. Source term is specified using a polynomial
defined in the POLSCALAR command.
– TABLE,TBNAME. Source term is specified using table
TBNAME.
– USER. Source term is specified using user subroutine
SORSCA.
Note: If source terms are specified by table for a given scalar, then the tables can be
defined either by material or by cell table, but not by both.
Problem Conditions
ACCELERATION, XDIR, YDIR, ZDIR, ICSYS(1), GFORCE(9.8066):
Defines components of the gravitational acceleration on all cells of materials where
buoyancy forces are activated.
XDIR, YDIR, – The vector indicating the direction of the body force. If all of
ZDIR
these fields are left blank, the default is XDIR = 0.0,
YDIR = 0.0, ZDIR = –1.0.
ICSYS
– The above vector is defined in coordinate system ICSYS,
which must be a Cartesian coordinate system.
GFORCE
– The magnitude of the acceleration.
BUOYANCY, SOPTION, X0, Y0, Z0, DOPTION: Switches buoyancy forces
on/off for the current fluid material.
SOPTION
7-22
– OFF (default). Buoyancy forces are switched off for the
current material. The remaining arguments in the command are
ignored.
– ON. Buoyancy forces are switched on for the current material.
Note: Buoyancy forces may not be switched on for materials
with constant density.
Version 3.26
Chapter 7
PROPERTY MODULE
Problem Conditions
X0, Y0, Z0
– Datum point used to switch between piezometric and static
pressure. If the keyword PREF is entered in the X0 field, or if
all three fields are left blank, the datum point will be at the
centroid of the pressure reference cell of the material. Note:
An entered reference location should be in the same units as
the modelling units. It does get multiplied by the scale factor
used to write out the geometry file.
DOPTION
– SPECIFY,DENSITY(1.205). The datum density at location
(X0,Y0,Z0) is explicitly specified by the user. This is the
default DOPTION.
– DREFERENCE,POPTION,TOPTION. If the density of the
current material (see command DENSITY) is isobaric, ideal
gas or compressible liquid, the datum density at location
(X0,Y0,Z0) is calculated with the appropriate equation in the
Methodology manual using the reference or initial pressure
and temperature. For materials with other densities, the datum
density is the same as the constant or reference density set by
the DENSITY command.
– POPTION
– REFERENCE (default). Use the reference pressure, as
specified in the PRESSURE command.
– INITIAL. Use the initial pressure, as specified in the
INITIALIZE command.
– TOPTION
– REFERENCE (default). Use the reference temperature, as
specified in the TDATUM command.
– INITIAL. Use the initial temperature, as specified in the
INITIALIZE command.
Note: The computed (piezometric) pressure used in STAR is given by:
Ppiezometric=
Pstatic–DENSITY*(GRVX*(X–X0)+GRVY*(Y–Y0)+GRVZ*(Z–Z0))
where DENSITY is the datum density defined above at location (X0,Y0,Z0), and
GRVX, GRVY and GRVZ are the gravitational acceleration components defined
by the ACCELERATION command.
CINITIALIZE, LCODEI, LPRESI, CHLEN, VELMAX: Provides parameters
for the steady state initialisation procedures of STAR-CD before starting iterative
calculations. This procedure is supplementary to the initial conditions specified by
the INITIALIZE command. The code initialisation procedure obtains the flow field
and pressure field from the given boundary conditions to satisfy continuity,
retaining the secondary velocity components (if any).
Version 3.26
7-23
PROPERTY MODULE
Chapter 7
Problem Conditions
LCODEI
– /Y/N/. Turns on or off the code initialization procedure.
LPRESI
– /Y/N/. Turns on or off pressure initialization within the code
initialization procedure.
CHLEN
– Characteristic length scale of the solution domain. This is used
to initialize a problem with a combination of pressure and inlet
boundary conditions and defaults to 0.1 × the domain length. It
is ignored for other boundary condition options.
VELMAX
– Specifies an estimate of the maximum velocity throughout the
domain for pressure-pressure or stagnation.
COKE, OPTION: Defines the constants used in formulating various turbulence
models.
OPTION
– KE,CMU,C1,C2,C3,C4,CAPPA,PRK,PRE,PRT,/RNGBTA,
RNGE0/C5/. Constants used in the k-ε or Reynolds stress
models. PRT can be defined in user-defined subroutine
VARPRT. To do so, the word USER should be substituted in
the corresponding input field. For non-linear models, CMU is
treated by the solver as a variable; therefore, the word
VARIABLE should be substituted for the CMU value.
Default Value
7-24
Constant
Description
CMU
Standard or
Nonlinear k-ε
RNG
k-ε
CHEN
k-ε
C-MU constant
0.09
0.085
0.09
C1
C-EPSILON1 constant
1.44
1.42
1.15
C2
C-EPSILON2 constant
1.92
1.68
1.90
C3
C-EPSILON3 constant
1.44
1.42
1.40
C4
C-EPSILON4 constant
–0.33
–0.387
–0.33
CAPPA
CAPPA constant
0.419
0.4
0.4153
PRK
Prandtl number for k
1.00
0.719
0.75
PRE
Prandtl number for ε
1.219
0.719
1.15
PRT
Prandtl number for enthalpy
0.9
0.9
0.9
RNGBTA
RNG Beta
–
0.012
–
RNGE0
RNG E0
–
4.38
–
Version 3.26
Chapter 7
PROPERTY MODULE
Problem Conditions
Default Value
Constant
Description
C5
C-EPSILON5 constant
Standard or
Nonlinear k-ε
RNG
k-ε
CHEN
k-ε
–
–
0.25
(See Chapter 2 of the Methodology volume for a discussion of these constants.)
Default Value
Constant
Description
GL
RSM
SSG
RSM
CMU
C-MU constant
0.09
0.09
CEPS1
C-EPSILON1 constant
1.44
1.44
CEPS2
C-EPSILON2 constant
1.92
1.83
CEPS3
C-EPSILON3 constant
–
–
CEPS4
C-EPSILON4 constant
–
–
CAPPA
CAPPA constant
0.419
0.419
PRK
Prandtl number for k
1.0
1.0
PRE
Prandtl number for ε
1.3
1.3
PRT
Prandtl number for enthalpy
0.9
0.9
RNGBTA
RNG Beta
–
–
RNGE0
RNG E0
–
–
CEPS5
C-EPSILON5 constant
–
–
OPTION
– KOMEG,OPTION2.
– OPTION2.
– STANDARD,ALPHA,BETA0,BETA0*,PRK,PRW.
Coefficients for the STANDARD k-ω turbulence model.
The default values are:
ALPHA BETA0 BETA0*
0.52
0.072
0.09
PRK
PRW
CMU
C3
2.0
2.0
0.09
1.44
– SST,PRK1,PRK2,PRW1,PRW2,BETA1,BETA2,A1.
Coefficients for the k-ω SST model.The default values are:
Version 3.26
PRK1 PRK2 PRW1 PRW2 BETA1 BETA2
A1
CMU
C3
1.176
0.31
0.09
1.4
1.0
2.0
1.168
0.075 0.0828
7-25
PROPERTY MODULE
Chapter 7
Problem Conditions
– SPAL,CB1,CB2,PRV,CV1,CW2,CW3,CAPPA. Coefficients
for the Spalart-Allmaras model. The default values are:
CB1
CB2
PRV
CV1
CW2
CW3
CAPPA
0.1335
0.622
0.666
7.1
0.3
2.0
0.41
– V2F,CMU,C1,C2,C3,C4,CKT,CETA,CL,PRK,PRE.
Coefficients for the V2F model.
CMU
C1
C2
C3
C4
0.22
1.4
1.9
1.4
–0.33
CKT CETA
6.0
70.0
CL
PRK
PRE
0.23
1.0
1.3
COLES, CKLES, CELES, CSLES(0.02): Defines the coefficients used in Large
Eddy Simulation (LES) turbulence models.
CKLES,
CELES,
CSLES
– Coefficients used in LES turbulence models. For the ‘L’
(Smagorinsky) model, the default values of CKLES and
CELES are 0.202 and 0.44, respectively. For the ‘KL’ model,
the defaults are 0.05 and 1.
CONL, OPTION: Defines the constants used in the non-linear terms of various
turbulence models.
OPTION
7-26
– STANDARD,CA0,CA1,CA2,CA3,CNL1,CNL2,CNL3,CNL4,
CNL5,CNL6,CNL7. Defines nonlinear coefficients for the
standard nonlinear model.
– /SUGA/KEA2/,CNL1,CNL2,CNL3,CNL4,CNL5. Defines
nonlinear coefficients for Suga’s original or the k-ε-A2 model.
– SPEZIALE,CNL1. Defines nonlinear coefficients for
Speziale’s model.
Version 3.26
Chapter 7
PROPERTY MODULE
Problem Conditions
Constant
Standard
Suga’s k-ε
Suga’s k-ε-A2
Speziale
CA0
0.667
–
–
–
CA1
1.25
–
–
–
CA2
1.00
–
–
–
CA3
0.9
–
–
–
CNL1
0.75
–0.1
–0.05
CNL2
3.75
0.1
0.11
–
CNL3
4.75
0.26
0.21
–
–0.15
CNL4
–10.0
–10.0
–0.8
–
CNL5
–2.0
–5.0
–0.5
–
CNL6
1000.0
–
–
–
CNL7
1.0
–
–
–
DIFCORRECTION, OPTION: Determines whether the diffusion velocity
correction is activated for the current material.
OPTION
– OFF. Diffusion velocity correction is deactivated.
– ON. Diffusion velocity correction is activated.
INISCALAR, NSC, UOPTION, CONC(0.0): Defines scalar initial conditions
that are used during the first iteration before any field results are available. Values
have to be supplied only for those scalars that are to be solved by a transport
equation.
NSC
Version 3.26
– Scalar number.
7-27
PROPERTY MODULE
Chapter 7
Problem Conditions
UOPTION
– STANDARD/USER/TABM/TABC/. Uses constant value
CONC to initialise scalar number NSC.
– USER. Uses constant value CONC to initialise scalar
number NSC in current material and overwrites with values
specified by user subroutine INITFI.
– TABM,NMAT,TBNAME. Uses constant value CONC to
initialise scalar number NSC in material NMAT and
overwrites with values given in a table associated with
material NMAT.
– NMAT. Material number.
– TBNAME. Table name for material number NMAT.
– TABC,ICTID,TBNAME. Uses constant value CONC to
initialise scalar number NSC in cell type ICTID and
overwrites with values given in a table associated with type
ICTID.
– ICTID. Cell type number.
– TBNAME. Table name for cell type ICTID.
INITIAL, UOPTION, UIN, VIN, WIN, ICSYSIN(1), OMEGAIN, PIN,
TURBOPT, TIN(293.0) (for fluid materials/types)
or
INITIAL, UOPTION, TIN(293.0) (for solid materials/types): Defines material
initial conditions that are used during the first iteration before any field results are
available. Values have to be supplied only for those equations that are to be solved.
7-28
UOPTION
– /STANDARD/USER/TABM/TABC/. (Note: This option also
controls initialisation of scalars.)
– STANDARD. Uses constant values, UIN, VIN, …, etc. to
initialise field in current material.
– USER. Uses constant values, UIN, VIN, …, etc. to initialise
field in current material and overwrites with values given in
user subroutine INITFI.
– TABM,NMAT,TBNAME. Uses constant values, UIN, VIN,
…, etc. to initialise field in material NMAT and overwrites
with values given in a table associated with material NMAT.
– NMAT. Material number.
– TBNAME. Table name for material number NMAT.
– TABC,ICTID,TBNAME. Uses constant values, UIN, VIN,
…, etc. to initialise field in cell type ICTID and overwrites
with values given in a table associated with type ICTID.
– ICTID. Cell type number.
– TBNAME. Table name for cell type ICTID.
UIN, VIN,
WIN
– Components of velocity in the U, V and W directions.
Version 3.26
Chapter 7
PROPERTY MODULE
Problem Conditions
ICSYSIN
– Initial coordinate system.
OMEGAIN
– Initial omega.
PIN
– Initial pressure.
TURBOPT
– KEPS,TEIN,EPSIN. Initial turbulence is specified using the
k-ε model. Initial values of k (TEIN) and ε (EPSIN) are
specified with the method associated with UOPTION.
– MIXL,INTENSITY,LENGTH. Initial turbulence is specified
using the k-l model. Initial intensity and mixing length are
specified with the method associated with UOPTION.
– RSM,EPSIN,RSUUIN,RSVVIN,RSWWIN,RSUVIN,
RSVWIN,RSUWIN. Initial turbulence is specified using the
Reynolds stress model. Initial dissipation of turbulence energy
(EPSIN) and the six Reynolds stresses are specified by
‘constant’ values, i.e. independently of UOPTION.
TIN
– Initial temperature.
LOWREYNOLDS, STATUS: Switch to turn on the low Reynolds number model.
This switch is valid only for the standard and non-linear k-ε turbulence models.
STATUS
– /OFF/ON/.
NWALL, OPTION: Selects a wall treatment for the following turbulence models:
(a) Low-Reynolds number Spalart-Allmaras;
(b) Low-Reynolds number k-ε (linear, nonlinear cubic, and nonlinear
quadratic);
(c) Low-Reynolds number k-ω (standard and SST).
OPTION
– STANDARD (default). Selects the standard wall treatment for
near-wall cells.
– HYBRIDWALL. Selects the hybrid wall treatment for near
wall cells.
PRESSURE, PREF(1.0E5), NCREF(1): Sets a reference pressure and cell
location for the current material.
Version 3.26
7-29
PROPERTY MODULE
Chapter 7
Problem Conditions
PREF
– Reference pressure.
NCREF
– Cell number of the location of the reference cell.
Example in tutorial: 4.2, 7.4, 7.5, 9.1, 11.1, 13.1, 15.1, 16.1, 16.2, 16.3, 17.1,
17.2
SHTRA, OPTION: Turns off or on the Suga turbulent heat flux for any Suga
turbulence model.
OPTION
– OFF (default). Suga turbulent heat flux is off.
– ON. Suga turbulent heat flux is on.
SPIN, IMAT, OMEGA, ICSYS(2), USEROPT: Defines a spinning velocity and
axis of revolution in order to calculate body forces on the fluid. The axis of
revolution is defined as the local Z axis of Cartesian or cylindrical coordinate
system ICSYS. This command must be used once for each fluid material property
defined.
7-30
IMAT
– Material ID to which this spinning velocity applies. When
using implicit multiple frames of rotation, then IMAT is
simply replaced by ISPIN, the spin index defined in the cell
table (see command CTABLE).
OMEGA
– Spinning velocity (rpm).
ICSYS
– Local coordinate system number, which must reference a
Cartesian or cylindrical system. When using implicit multiple
frames of rotation (MFRAME,IMPLICIT), then entering ‘0’
signifies that the spinning velocity for this spin index is to be
deleted.
USEROPT
– CONSTANT. The OMEGA value given in this command is the
one used by the analysis.
subroutine UOMEGA to define the OMEGA value for this
IMAT. The value supplied in the command will be used as
default if OMEGA is not assigned in the user subroutine.
– TABLE. A table will be used for the OMEGA value. The user
will be prompted for the table file name. Independent variables
for this table can only be either iteration number for a steady
calculation or TIME for a transient calculation, with OMEGA
as the dependent variable.
Version 3.26
Chapter 7
PROPERTY MODULE
Problem Conditions
TDATUM, T(273.0): Sets a temperature datum and is needed only if the enthalpy
equation is being solved. STAR works in temperature differences and T references
temperature back to a physically meaningful value, such as the absolute
temperature.
T
– Temperature datum.
TEMPERATURE, STATUS, ENTHOPT, TYPE: Sets various options for the
calculation of temperature by STAR.
STATUS
– OFF (default). Temperature is not a variable. The remaining
fields are ignored.
– ON. Temperature is solved for using the standard enthalpy
equation or a constant stagnation enthalpy relationship.
ENTHOPT
– THERMAL (default). Enthalpy refers only to thermal
enthalpy.
– CHEMICOTHERMAL. Enthalpy also includes heat of
formation.
Note: The THERMAL and CHEMICOTHERMAL options are
formally equivalent, but may have different convergence
behaviour and different distribution of errors.
TYPE
– STATIC (default). The conserved variable is static enthalpy.
– TOTAL. The conserved variable is total enthalpy.
– ROTHALPY. The conserved variable is rothalpy.
– CONSTANT,TSTAG(293.0). Temperature equation is replaced
by a constant stagnation enthalpy relationship. TSTAG is the
stagnation temperature.
Note: The STATIC, TOTAL and ROTHALPY options are
formally equivalent, but truncation and discretisation errors
affect the result differently.
THERMDIF, OPTION: Determines whether thermal diffusion is included in the
species transport equation for the current material.
OPTION
Version 3.26
– OFF. Thermal diffusion is not included.
– ON. Thermal diffusion is included.
7-31
PROPERTY MODULE
Chapter 7
Problem Conditions
TLMODEL, OPTION: Selects a one-equation turbulence model for use by the
two-layer method. The Norris/Reynolds model is the default option.
OPTION
– NORE,AMUN(50.51),CEPS(5.3) to choose the
Norris/Reynolds model.
– HAPO,AMUH(34.48),CD1(.164),CD2(.336) to choose the
Hassid/Poreh model.
– WOLF,AMUW(70.0),AEPS(5.1) to choose the Wolfstein
model.
– VANDRIEST,CVM(26.0). to choose the Van Driest model.
– USER. The turbulence model is user-specified in subroutine
TWLUSR.
TLSWITCH, YSWITCH(.95), BUFREG(.975), DYNAMIC: Changes the
default parameters used in calculating the match point between the one- and
two-equation models.
YSWITCH
– The value of fmu, a non-dimensional parameter used as a
criterion for finding a match between the one- and
two-equation models in two-layer turbulence modelling (see
the Methodology volume). Must be greater than 0 and less than
or equal to 1.
BUFREG
– Tolerance used in the match point calculation. Must be greater
than 0 and less than or equal to 1.
DYNAMIC
– /YES/NO/. Fixes the region of validity of the one-equation
model. If YES (default), switch between two-layer and k-ε
turbulence model is dynamic. If NO, switch is frozen.
TUGL, WOPTION, CONSTANTS: Defines the coefficients used if the
Gibson-Launder Reynolds stress turbulence model is turned on (see command
TURBULENCE).
7-32
Version 3.26
Chapter 7
PROPERTY MODULE
Problem Conditions
WOPTION
– GLCRAFT (default). Coefficients when the Craft wall
reflection terms are used.
– GLWR. Coefficients when standard GL wall reflection terms
are used.
– GLNOWR. Coefficients when wall reflection terms are not
used.
CONSTANTS – The constants have the following default values.
Option
Constants
Description
GLCRAFT GLWR
GLNOWR
C1
Return-to-isotropy
1.80
1.80
1.80
C2
Isotropisation of production
0.60
0.60
0.60
C1W
‘Slow’ wall reflection
0.50
0.50
0.50
C2W
‘Rapid’ wall reflection
not used
0.30
0.0
CS
Anisotropic coefficient
(k equation)
0.22
0.22
0.22
CEE
Anisotropic coefficient
(ε equation)
0.18
0.18
0.18
C2WC1
Constant 1 in Craft wall reflection model
–0.044
not used
not used
C2WC2
–0.08
not used
not used
C2WC3
0.60
not used
not used
Note: The keyword LIST may be used in place of C1 to simply list the values of the
coefficients.
TURBULENCE, OPTION: Sets the turbulence model and required values for
calculating turbulence for the current material.
OPTION
Version 3.26
– OFF (default). No turbulence model is used (flow is laminar).
– CONSTANT,TURVIS(5.E-3). Turbulence is constant
everywhere. TURVIS is the value of turbulent viscosity.
7-33
PROPERTY MODULE
Chapter 7
Problem Conditions
OPTION
7-34
– KE,LENGTH(1.0),OPTION2. Turbulence is calculated using
the k-ε turbulence model.
– LENGTH. Characteristic length of the solution domain.
– OPTION2.
– STANDARD (default). The standard k-ε model will be
used.
– RNG,BUOY(F/T),COMP(F/T). The RNG formulation of
the k-ε model will be used. The BUOY and COMP flags
are used to indicate whether to include buoyancy and/or
compressibility terms as in the standard k-ε model.
– CHEN. The CHEN variant of the k-ε model will be used.
– NONLINEAR, /QUADRATIC/CUBIC/,
/STANDARD/SPEZIALE/SUGA/KEA2/. Use one of the
nonlinear variants of the standard, Speziale, Suga or k-ε-A2
models. The order of nonlinearity is specified as either
QUADRATIC (default) or CUBIC.
– KOMEG,LENGTH(1.0),OPTION3. Turbulence is calculated
using a k-ω model.
– OPTION3.
– BASIC (default). k-ω basic model.
– SST. k-ω SST model.
– KL. Turbulence is calculated using the ‘KL’ model. The
mixing length is calculated in user subroutine LSCALE.
– SPAL,LENGTH(1.0). Turbulence is calculated using the
Spalart-Allmaras model.
– LES, OPTION2. Turbulence is calculated using the ‘Large
Eddy Simulation’ (LES) model. Default model coefficients are
automatically set. Alternative coefficients can be set using the
COLES command. Use of the LES option requires that the
analysis is transient and that upwind differencing (UD) is not
used for velocities. The implicit Euler temporal discretisation
is recommended.
– OPTION2.
– L (default). LES ‘Smagorinsky’ model is used.
– KL. LES ‘Speziale K-L’ model is used.
Version 3.26
Chapter 7
PROPERTY MODULE
Problem Conditions
OPTION
– RSM, OPTION2, DIFF. Turbulence is calculated using the
Reynolds stress model.
– OPTION2.
– GLCRAFT (default). Uses the Gibson-Launder Reynolds
Stress Model with Craft wall reflection terms. Use the
TUGL command to define the coefficients.
– GLWR. Uses the Gibson-Launder Reynolds Stress Model
with standard wall reflection terms. Use the TUGL
command to define the coefficients.
– GLNOWR. Uses the Gibson-Launder Reynolds Stress
Model without wall reflection terms. Use the TUGL
command to define the coefficients.
– SSG. Uses the Speziale, Sarkar, and Gatski Reynolds
Stress Model. Use the TUSSG command to define the
coefficients.
– DIFF.
– ISOTROPIC (default). Isotropic diffusivity is assumed for
diffusion terms.
– ANISOTROPIC.Anisotropic diffusivity, specifically the
Generalized Gradient Diffusion Hypothesis, is assumed
when calculating the diffusion terms.
– USER. Turbulence is calculated in user subroutine VISTUR.
– V2F,LENGTH(1.0): Turbulence is calculated using the V2F
turbulence model.
TUSSG, C1(3.4), C1A(1.8), C2(4.2), C3(0.8), C3A(1.3), C4(1.25), C5(0.4),
CS(0.22), CEE(0.18): Defines the constants used if the Speziale, Sarkar, and Gatski
Reynolds stress turbulence model is turned on (see command TURBULENCE).
Version 3.26
Constant
Description
Default Value
C1
Return-to-isotropy
3.40
C1A
Production-biased rapid
1.80
C2
Quadratic slow term
4.20
C3
Linear rapid
0.80
C3A
Variable isotropic rapid
1.30
C4
Anisotropy/strain rate
1.25
C5
Anisotropy/vorticity
0.40
CS
Anisotropic coefficient (k equation)
0.22
7-35
PROPERTY MODULE
Chapter 7
Problem Conditions
Constant
Description
CEE
Anisotropic coefficient (ε equation)
Default Value
0.18
Note: The keyword LIST may be used in place of C1 to simply list the values of the
coefficients.
TWOLAYER, STATUS, DIST(0.1): Activates/deactivates the two-layer
turbulence model for the current material. This command is valid only for fluid
materials.
STATUS
– /OFF/ON/.
DIST
– Distance from wall over which the model is active.
WALLFUNCTION, OPTION: Selects either standard or non-equilibrium wall
function for high Reynolds number k-ε or k-ω models.
OPTION
– /STANDARD/NONEQUILIBRIUM/.
7-36
Version 3.26
Chapter 8
SCALAR MODULE
Physical Properties
Chapter 8
SCALAR MODULE
HELP
or
STATUS: Displays the status of all SCALAR module settings.
Physical Properties
CDSCALAR, FNUM(case.scl), NSC1(1), NSC2(NSC1), NSCINC: Writes
out details of scalars in coded form.
FNUM
– File name to write out information to.
NSC1, NSC2, – Scalars from NSC1 to NSC2 in increments of NSCINC will be
NSCINC
written out.
SC, NSC(1), STATUS, INFLUENCE, OPTION, TYPE(1): Defines all basic
information for each additional scalar variable that the user wishes to solve for in
STAR.
Version 3.26
NSC
– Scalar number (0 < NSC < 51). The user should turn on scalars
consecutively because memory and disk usage is based on the
maximum number of scalars defined rather than the number
actually used.
STATUS
– DEFINE (default). Allows for definition of the physical
properties of the scalar and turns on the STAR solver for the
scalar.
– OFF. Turns the solver off for the scalar (without deleting the
scalar). The INFLUENCE, OPTION and TYPE arguments are
not used.
– ON. Turns the STAR solver on for the scalar. The
INFLUENCE, OPTION and TYPE arguments are not used.
8-1
SCALAR MODULE
Chapter 8
Physical Properties
INFLUENCE – ACTIVE (default). The scalar has an influence on other
dependent variables.
– PASSIVE. The scalar does not have an influence on other
dependent variables. The OPTION and TYPE arguments are
not used.
OPTION
– UDEFINED. The scalar properties for the active scalar are
user defined and will be prompted for.
– DBASE. The scalar properties for the active scalar are
extracted from the standard properties database props.dbs.
TYPE
– Identification tag showing whether the active scalar belongs to
the light (TYPE = 1) or heavy (TYPE = 2) fluid group. It will
take the same density computation option as the corresponding
background fluid, and will contribute to material properties
weighted by its mass fraction.
If STATUS is DEFINE, pro-STAR will then prompt for the scalar name (which
may be up to 20 characters long).
If INFLUENCE is ACTIVE and OPTION is UDEFINED, pro-STAR will also
prompt for the scalar molecular weight, density, thermal expansion coefficient,
specific heat, thermal conductivity, molecular viscosity, heat of formation, and
temperature of formation.
Note:
1. It is possible that some parameters may not be used for a given analysis (for
example Thermal conductivity would not be needed if the temperature
equation is not turned on). The user may simply let these values default to the
program defaults.
2. Values for viscosity, conductivity and specific heat are not needed if the
POLYNOMIAL option is chosen in commands LVIS, COND and SPEC,
respectively. Commands POSLV, POSK and POSCP must be used instead.
3. Values for heat and temperature of formation are not needed if the
POLYNOMIAL option is chosen in command SPEC.
SCDELETE, NSC1(1), NSC2(NSC1), NSCINC(1): Deletes scalar attributes from
the data base and compresses the maximum number of scalars to the
highest-numbered scalar left ON.
NSC1, NSC2, – Values will be deleted for scalars NSC1 to NSC2 by NSCINC.
NSCINC
8-2
Version 3.26
Chapter 8
SCALAR MODULE
Physical Properties
SCGENERATE, NUMSC, INC, NSC1(1), NSC2(NSC1), NSCINC(1):
Generates additional scalar attribute tables copied from an initial starting set.
NUMSC,
INC
– Generates NUMSC sets of scalar tables incrementing the
initial set by INC each time. The initial set is included in the
NUMSC count.
NSC1, NSC2, – The initial set of scalars is defined by NSC1 to NSC2 by
NSCINC
NSCINC.
SCLIST, OPTION, NSC1(1), NSC2(NSC1), NSCINC(1): Lists the
attributes/properties defined for a range of added scalar equations.
OPTION
– /BRIEF/FULL/.
NSCINC
SCMODIFY, NSC, ITEM, VALUE1, VALUE2: Allows the user to modify a
single item of information used by a scalar definition without the need to respecify
all items.
NSC
– Scalar number to modify.
ITEM
– Any one of the following keywords:
– NAME. 20 character identifier will be prompted for.
– INFLUENCE,/ACTIVE/PASSIVE/. Scalar influence —
either ACTIVE (default) or PASSIVE.
– MOLWT,WTMOL(28.96). Molecular weight.
– DENSITY,RHO(1.205),BETAM(0.0). Density and
volumetric expansion coefficient.
– SPECIFICHEAT,CP(1006.0). Specific heat.
– CONDUCTIVITY,K(0.02637). Thermal conductivity.
– VISCOSITY,LVIS(1.81E-05). Molecular viscosity.
– HFORM,VALUE(0.0),TFORM(0.0). Heat of formation and
temperature of formation.
Version 3.26
8-3
SCALAR MODULE
Chapter 8
POSCP, NSC, OPTION: Polynomial function to describe specific heat, enthalpy
and entropy for a scalar variable.
8-4
NSC
– Scalar number.
OPTION
CHEMKIN thermodynamic database. The substance name
will be prompted for. By default, the CHEMKIN database
and the user can append to or modify the data base keeping in
(A12,A6,4(A2,F3.0),A1,E10.0,E10.0,14X,I1).
(col. 80); format (5(E15.0),I1).
chemkin.dbs file.
cecthrm.dbs containing the thermodynamic database used
by the NASA Chemical Equilibrium Codes. The substance
name will be prompted for. By default, the CEC database
and the user can append to or modify the database keeping in
(A12,A6,4(A2,F3.0),A1,E10.0,E10.0,14X,I1).
(col. 80); format (5(E15.0),I1).
cecthrm.dbs file.
Version 3.26
Chapter 8
SCALAR MODULE
OPTION
their values.
cleared.
from TRANGE1 to TRANGE2 (default is the entire range)
with temperature, specific heat, enthalpy and entropy values
stored in graph registers REG1, REG2, REG3 and REG4,
molecular weight (WTMOL) is specified, c p , h and s will be
stored.
cp
----- =
R
h
--- =
R
n
∑ ( ai T
i–1
)
(8-1)
T
a i ----- + a n + 1
i
(8-2)
i=1
n
∑
i=1
s
--- = a 1 ln T +
R
i
n
∑
i–1
i=2
⎛a T
------------ ⎞ + a n + 2
⎝ i i–1⎠
(8-3)
POSD, NSCI, NSCJ, IPTYP(2), OPTION: Defines a polynomial function to
describe mass diffusivity for scalar pair NSCI and NSCJ.
NSCI
Version 3.26
– Index of scalar I.
8-5
SCALAR MODULE
Chapter 8
NSCJ
– Index of scalar J.
IPTYP
below).
OPTION
their values.
cleared.
– DIFFU SPECIESI SPECIESJ. The coefficients for the scalar
pair are retrieved from an internal database called
diffu.dbs (in double-logarithmic form). SPECIESI and
SPECIESJ are the alphanumeric character names (chemical
formulas) of the scalars. This option allows only one
temperature range and four coefficients. It is also only valid for
IPTYP = 2.
TRANGE2. Calculates the diffusivity according to the
polynomial function corresponding to the IPTYP value and
Temperature and values are stored in graph registers REG1 and
REG2, respectively.
Notes:
1. The form of the polynomial is
n
D ij =
∑ ak, ij T
k–1
(8-4)
k=1
if IPTYP = 1, where a k, ij are the prescribed coefficients, or
n
ln ( D ij ) =
∑ ak, ij ( ln T )
k–1
(8-5)
k=1
if IPTYP = 2, or
8-6
Version 3.26
Chapter 8
SCALAR MODULE
n
ln ( D ij ) =
a k, ij
-------------------(l – 1)
ln
T
k=1
∑
if IPTYP = 3.
2. Options ‘DIFFU SPECIESI SPECIESJ’ and ‘DIFFU SPECIESJ SPECIESI’
are the same (that is D ij = D ji ) and there is only one combination in the
database. This command should get the correct values no matter what the
combination is.
POSK, NSC, IPTYP(2), OPTION: Polynomial function to describe the thermal
conductivity of a scalar variable.
Version 3.26
NSC
– Scalar number.
IPTYP
below).
OPTION
their values.
– RANGE1,RANGE2.Temperature range for which the
cleared.
– CONDU,SPECIES. Coefficients for the scalar variable are
retrieved from an internal database called condu.dbs.
SPECIES is the alphanumeric character name (chemical
formula) of the scalar. This option allows only one temperature
range and four coefficients. It is also only valid for IPTYP = 2.
8-7
SCALAR MODULE
Chapter 8
Note: The form of the polynomial is
n
K =
∑ ai T
i–1
(8-6)
i=1
n
∑ ai ( ln T )
ln ( K ) =
i–1
(8-7)
i=1
if IPTYP = 2, or
n
ln ( K ) =
ai
-------------------(i – 1)
ln
T
i=1
∑
if IPTYP = 3.
POSLV, NSC, IPTYP(2), OPTION: Polynomial function to describe the
molecular viscosity for a scalar variable.
8-8
NSC
– Scalar number.
IPTYP
below).
OPTION
their values.
cleared.
Version 3.26
Chapter 8
SCALAR MODULE
OPTION
– VISCO,SPECIES. Coefficients for the scalar variable are
retrieved from an internal database called visco.dbs.
SPECIES is the alphanumeric character name (chemical
formula) of the scalar. This option allows only one temperature
Regular:
n
µ =
∑ ai T
i–1
(8-8)
i=1
Double Logarithmic:
n
ln ( µ ) =
∑ ai ( ln T )
i–1
(8-9)
i=1
if IPTYP = 2, or
n
ln ( µ ) =
ai
-------------------(i – 1)
ln
T
i=1
∑
if IPTYP = 3.
Version 3.26
8-9
Chapter 9
BOUNDARY MODULE
Boundary Definition
Chapter 9
BOUNDARY MODULE
Boundary Definition
BCHECK: Checks all user-defined boundaries. This command will issue error
messages for illegally defined boundaries and boundaries defined within the model.
If radiation is on, this command will also check that all radiation cell surfaces
have user-defined boundaries and that no user-defined boundaries on radiation cells
have radiation patch numbers of zero.
BCOMPRESS: Compresses all deleted boundary definitions out of the model.
BCROSS, OPTION: Uses the cursor device to pick out cell faces on which the
boundary conditions of a given region will be placed or deleted. The cursor will
continue to appear until it is placed over a region of the screen in which no surfaces
have been drawn. A surface or hidden line plot must be on the screen for this
command to function. If the cursor is placed over a location showing more than one
face (non-hidden line plot), the face nearest the viewer will be picked.
OPTION
– ADD,NREG(1),NPATCH(0). Creates boundaries with
boundary region NREG and boundary patch NPATCH on
chosen cell faces.
– DELETE. Deletes chosen boundaries.
– MODIFY,NREG(1),NPATCH(0). Modifies all chosen
boundaries to have boundary region NREG and boundary
patch NPATCH. If NREG is left blank, the region numbers will
remain unchanged. If NPATCH is left blank, the patch
numbers will remain unchanged.
BDEFINE, NREGION(1), NV1, NV2, NV3, NV4, NPATCH: Defines a
boundary for a cell face — see Figure 9-1.
NREGION
Version 3.26
– Region number to which this boundary is referenced.
9-1
BOUNDARY MODULE
Chapter 9
Boundary Definition
NV1, …,
NV4
– Four vertices defining a cell face.
NPATCH
– Radiation patch number to assign. Boundaries must have a
patch number if they are on radiation cells. Boundaries on
non-radiation cells need not be assigned a patch number; the
patch numbers of boundaries on non-radiation cells will be set
to zero upon issuing the GEOMWRITE command.
Command: BDEF , 5 , 1 , 2 , 7 , 6
↑
Region no. 5
11
12
13
14
15
9
10
6
7
8
1
2
Figure 9-1
3
4
5
Boundary assignment for a single cell face using BDEFINE
BDELETE, OPTION: Deletes a range of boundaries.
OPTION
– NB1,NB2(NB1),NBINC(1). Delete boundaries NB1 to NB2
by NBINC.
– REGION,NR1,NR2(NR1),NRINC(1). Delete all boundaries in
boundary regions NR1 to NR2 by NRINC.
BDX, NREGION(1), NPATCH: Defines boundaries and patches using the cursor
to pick vertices. The cursor will reappear until the user picks a location outside the
plot window or a spot far away from any vertex. The boundary region is determined
9-2
Version 3.26
Chapter 9
BOUNDARY MODULE
Boundary Definition
by the NREGION parameter, the radiation patch by the NPATCH parameter. The
user may select vertices from vertex, cell or spline plots. When using cell plots, the
selector will respond to both ‘exact-hidden’ or ‘quick-hidden’ as if they were both
‘quick-hidden’ plots.
NREGION
– Boundary region to assign to defined boundaries.
NPATCH
– Radiation patch number to assign.
BFIND, NREGION(1), NVSEED, NPATCH(0): Defines boundaries on the
current plot (SURFACE,ON) by finding all surface cell faces attached to one vertex
(NVSEED) and proceeding in waves outwards from this initial start — see Figure
9-2. The process ends at any vertex included in the current VSET. The user should
find VSET,NEWSET,EDGE helpful for defining a VSET that may be particularly
useful with this command.
Commands: VSET , NEWS , EDGE
BFIND , 7 , 100
VSET selected
Seed vertex 100
Boundaries
assigned to
region 7
Figure 9-2
Boundary definition using BFIND
NREGION
– Boundary region to assign to defined boundaries.
NVSEED
– Starting vertex number to search for adjacent boundaries.
NPATCH
– Radiation patch number to assign.
17.1, 17.2
Version 3.26
9-3
BOUNDARY MODULE
Chapter 9
Boundary Definition
BGENERATE, NREP, NVINC, NB1(1), NB2(NB1), NBINC(1): Generates a
new set of boundaries by applying an offset to the vertices of a predefined set — see
Figure 9-3.
Commands: BGEN ,
BGEN ,
4 , 1 , 1,1,1
2 , 5 , 1,4,1
↑
↑
Sets
Vertex
to be
offset
created
11
12
13
14
15
9
10
6
7
8
1
2
3
Figure 9-3
4
5
Boundary assignment for multiple cell faces using BGEN
NREP,
NVINC
– Generates NREP sets incrementing all vertices by NVINC.
The initial set is included in the NREP count.
NB1, NB2,
NBINC
– Initial set of boundaries defined by NB1 to NB2 by NBINC.
BLIST, NB1(1), NB2(NB1), NBINC(1), LOPTION: Lists a range of boundaries.
NB1, NB2,
NBINC
– Lists boundaries NB1 to NB2 by NBINC.
LOPTION
– VERTEX (default). Lists the vertices of each boundary
definition.
– CELL. Finds and lists the cell to which each boundary is
attached.
BMERGE, OPTION: Searches boundary list for duplicate boundary definitions
9-4
Version 3.26
Chapter 9
BOUNDARY MODULE
Boundary Definition
and deletes the lower-numbered definitions (saves the most recent). The user may
then wish to use BCOMPRESS to remove the deleted boundaries from the database.
OPTION
– /NOLIST/LIST/. Determines whether deleted boundaries will
be listed to output or not.
BMODIFY, BOPTION, NREGION, NV1, NV2, NV3, NV4, NPATCH:
Modifies the region number, vertices or patch number of one or more boundaries.
BOPTION
– NB. Modifies a single boundary number NB.
– ALL. Modifies all boundaries.
– BSET. Modifies all boundaries in the current boundary set.
– BCRS. Modifies boundaries selected by the cursor.
NREGION
– Changes the region number of the boundary or boundaries to
region number NREGION, which must be previously defined.
If left blank, the region number will not change.
NV1, NV2,
NV3, NV4
– Changes the vertex number for each non-zero entry. These
fields are ignored if BOPTION = ALL, BSET or BCRS.
NPATCH
– Changes the patch number of the boundary or boundaries to
patch number NPATCH, which must be greater than or equal
to zero. The patch number is only used for radiation modelling.
If left blank, the patch number will not change.
BPATCH, BOPTION, NPATCH(0), OPTION: Assigns radiation patches to
boundaries based on region number and/or boundary set. Boundaries must have a
patch number if they are on radiation cells. Boundaries on non-radiation cells need
not be assigned a patch number; the patch numbers of boundaries on non-radiation
cells will be set to zero upon issuing the GEOMWRITE command.
Version 3.26
BOPTION
– NREG(1). Assigns patches to all boundaries in region number
NREG.
– BSET. Assigns patches to all boundaries in the current
boundary set.
NPATCH
– Patch number to start with. If NPATCH = 0, then patch
numbers will start at the next highest available.
9-5
BOUNDARY MODULE
Chapter 9
Boundary Definition
OPTION
– BYREGION (default). If BOPTION = BSET, boundaries in
the current boundary set will be assigned patches based on the
region, with patch numbers starting at NPATCH. Otherwise, all
boundaries in region number NREG will be assigned patch
number NPATCH.
– BYSET. All boundaries in the current boundary set will be
assigned patch number NPATCH. This OPTION is valid only
if BOPTION = BSET.
– BYFACE. Every boundary in region number NREG or the
current boundary set will be assigned a unique patch number,
with patch numbers starting at NPATCH.
– BYSIZE,PLEN(1.),FANGLE(31.). Boundaries in region
number NREG or the current boundary set will be
automatically broken up into patches that are approximately
PLEN long on each edge, with patch numbers starting at
NPATCH. A single patch will not continue over discontinuous
regions or around edges, where edges are defined by adjacent
boundaries whose normals differ by an amount greater than or
equal to the feature angle (FANGLE). The feature angle is also
used to break up patches on curved surfaces, so that the angle
between the normals of any two boundaries sharing the same
patch number should differ by no more than 2*FANGLE
degrees.
– BYPERCENT,PERC(0.01). (For FASTRAC radiation model
only.) The number of patches in the region number NREG will
be calculated as a percentage of the total number of boundaries
(NBTOT) associated with region number NREG. Therefore,
the approximate number of patches for region number NREG
will be NUMPATCH=PERC*NBTOT.
– BYNUMBER,MPATCH(1). (For FASTRAC radiation model
only.) The number of patches in the region number NREG will
be approximately MPATCH.
BPCOMPRESS: Compresses patch numbers that do not belong to any boundary
out of the model. Boundary definitions are renumbered in accordance with the
compressed list.
BREAD, LF(case.bnd), NVOFF(0), NB1, NB2, OPTION, FOPT,
NROFF(0), NPOFF(0): Reads boundaries from a file.
LF
9-6
– File name from which to read boundaries.
Version 3.26
Chapter 9
BOUNDARY MODULE
Boundary Definition
NVOFF
– Offset to apply to vertex numbers upon input.
NB1, NB2
– Reads only boundaries between NB1 and NB2 (default = all).
OPTION
– ADD. Adds the boundaries to the end of the boundary list,
regardless of the boundary numbers on the file.
– MODIFY. Uses the boundary numbers on the file to overwrite
current boundary definitions.
FOPT
– CODED. File LF is a coded (ASCII) where each line is in the
format (I8, 6X, 4I9, 2I7, A). The first number on each line is
the boundary number, the next four numbers are the vertex
numbers, the sixth number is the boundary region number, and
the string at the end of the line is a four-character string
denoting the region type (e.g. INLE, OUTL, WALL, etc.).
– BINARY. File LF is a binary file.
NROFF
– Offset to apply to region numbers upon input.
NPOFF
– Offset to apply to patch numbers upon input.
BSHELL, NROFF(0), NC1(1), NC2(NC1), NCINC(1), NPAT(0): Creates
boundaries by converting all shell cells in the given range. The starting shells are
not deleted by this process.
NROFF
– The region number of each new boundary is defined as the cell
table ID number of the starting shell plus NROFF. If the region
does not currently exist, it will be defined as a wall region.
NC1, NC2,
NCINC
– The range of cells used to create boundaries. Only shells in this
range will be used. Other types will be ignored. CSET and
ALL are allowed as substitutes for the range.
NPAT
– The radiation patch number of the new boundaries.
BWRITE, LF(case.bnd), NVOFF, NB1, NB2, NREG, FOPT: Writes a group
of boundary definitions to file LF.
Version 3.26
LF
– File name to which boundaries are written.
NVOFF
NB1, NB2
– Writes out only boundaries between NB1 and NB2
(default = all).
9-7
BOUNDARY MODULE
Chapter 9
Cyclic Set Definition
NREG
– Writes out only those boundaries with this region number.
FOPT
– CODED. Writes a coded (ASCII) file in the format (I8, 6X,
4I9, 2I7, 6X, A). The first number is the boundary number, the
next four are the vertices of the boundary, the fifth is the region
number, and the sixth is the radiation patch number. The last
item on the line is a four-character string which indicates the
region type (i.e. INLE, OUTL, WALL, etc.).
BZONE, NREG(1), OPTION, NPATCH(0): Creates boundaries on cell faces, or
modifies or deletes boundaries, within a user-drawn zone.
NREG
– Boundary region number.
OPTION
– ADD (default). Creates boundaries with boundary region
NREG and boundary patch NPATCH on all the cell faces
within a user-drawn zone.
– ALL. Creates boundaries with boundary region NREG and
boundary patch NPATCH on all the cell faces visible on the
screen.
– DELETE. Deletes all boundaries within a user-drawn zone.
NREG and NPATCH are ignored for this option.
– MODIFY. Modifies all boundaries within a user-drawn zone to
have boundary region NREG and boundary patch NPATCH. If
NREG is left blank, the region numbers will remain
unchanged. If NPATCH is left blank, the patch numbers will
remain unchanged.
NPATCH
– Radiation patch number.
CYARBITRARY, NREG1, NREG2, TOLIN(.01), TOLPL(.25),
TOLANG(15.): Matches cyclic boundaries on two faces by checking for overlap
in the local coordinate system of the region definitions and creates the appropriate
cyclic set list.
NREG1,
NREG2
9-8
– Region definitions of the first and second cyclic sides. NREG1
cannot be equal to NREG2, but both regions must be defined
as cyclic in the same coordinate system.
Version 3.26
Chapter 9
BOUNDARY MODULE
TOLIN
face is shrunk by a factor of 1.–TOLIN when checking).
TOLPL
TOLANG
– Tolerance value for matching the normal to a slave face with
the normal to the corresponding master face.
CYCHECK, TOL(.01), NBCY1(1), NBCY2(NBCY1), NBCYINC(1),
SETOPTION: Performs a set of checks on the given range of arbitrary cyclic sets
to help determine their validity. The checks include:
1. Check that all the listed boundaries exist and they reference arbitrary cyclic
region definitions.
2. Check that there is overlap between the boundaries of the two sides of the
cyclic set.
3. Cumulative area check for the range to see if the overlapping areas from either
side match.
TOL
– Tolerance for determining how closely master and slave areas
must match.
NBCY1,
NBCY2,
NBCYINC
– Searches through sets NBCY1 to NBCY2 by NBCYINC.
SETOPTION – If NOSET (default), the BSET is not altered by this command.
– If NEWSET, then the program will build a new BSET from all
boundaries connected to all cyclic sets that fail the
CYCHECK. (Note that using NEWSET will destroy the
current boundary set definition.)
CYCLIC, NBCY, NB1, NB2, …, NB18: Defines a cyclic set of boundaries. A
cyclic set allows several boundaries to be matched up with one (prime or master)
boundary. The actual coupling of U, V and W is a function of boundary orientation
or local coordinate system orientation as defined in the REGION specification and
whether it is cyclic or anticyclic.
Version 3.26
9-9
BOUNDARY MODULE
Chapter 9
NBCY
– Cyclic set number. The user can add to a previously defined
pair by simply using a set number over again.
NB1, NB2,
…, NB18
– Boundary definition numbers that form the cyclic set. The first
boundary defined is the master or prime boundary.
CYCOMPRESS: Compresses deleted cyclic sets out of the list.
CYDELETE, NBCY1, NBCY2, NBCYINC(1): Deletes previously defined cyclic
sets.
NBCY1,
NBCY2,
NBCYINC
– Deletes sets numbered NBCY1 to NBCY2 by NBCYINC.
CYGENERATE, NREP, NBINC, NBCY1(1), NBCY2(NBCY1),
NBCYINC(1): Generates additional cyclic sets by offsetting a previously defined
starting set.
NREP,
NBINC
– Generates NREP sets incrementing each boundary number by
NBINC. The initial set is included in the NREP count.
NBCY1,
NBCY2,
NBCYINC
– Initial set of cyclic boundaries defined by NBCY1 to NBCY2
by NBCYINC.
CYLIST, NBCY1(1), NBCY2(NBCY1), NBCYINC(1), BOPTION: Lists cyclic
set definitions.
NBCY1,
NBCY2,
NBCYINC
9-10
– Lists cyclic sets NBCY1 to NBCY2 by NBCYINC.
Version 3.26
Chapter 9
BOUNDARY MODULE
BOPTION
– NOSET (default). Current boundary set is not used to decide
whether to list the cyclic sets.
– BSET,ANY. Cyclic set is listed only if any of its boundaries
are in the current boundary set.
– BSET,ALL. Cyclic set is listed only if all of its boundaries are
in the current boundary set.
CYMATCH, NREG1, NREG2, DX, DY, DZ, TOL(.0001): Matches cyclic
boundaries on two faces by comparing the boundary centroids in the local
coordinate system of the region definitions and creates the appropriate cyclic set list
(see Figure 9-4). Anticylic boundaries are handled as follows. For each specified
flipping direction, the negative of that coordinate for each boundary centroid in the
first region is taken. The specified offsets are then added after this transformation.
Note that for an anticyclic case with origin symmetry, placing the origin of the local
coordinate system at the origin of symmetry eliminates the need for offsets.
NREG1,
NREG2
cannot be equal to NREG2, but both regions must be defined
as cyclic in the same coordinate system.
DX, DY, DZ – Offsets added to the centroids of the boundaries belonging to
NREG1 in order to match the centroids of boundaries in
NREG2.
TOL
– Tolerance used to determine whether two boundaries should be
matched.
Version 3.26
9-11
BOUNDARY MODULE
Chapter 9
Region Definition
U2
V1
U1
V2
Cyclic boundary 1
Cyclic boundary 2
YL
RL
U1 = U2
V1 = V2
W1 = W2
ΘL
XL
Local cylindrical system
Figure 9-4
Cyclic repeatability defined using local coordinate systems
Region Definition
RCHECK, IREG1(0), IREG2(IREG1), IREGINC(1): Checks all defined
regions. This is useful when solver keys and control parameters are changed and
additional conditions are needed in region definitions. Note that if the user is
running transients, the transient history data file must be connected prior to
invoking this check.
IREG1,
IREG2,
IREGINC
– Regions IREG1 to IREG2 in increments of IREGINC will be
tested.
RCOMPRESS: Compresses undefined/deleted region numbers out of the model.
Boundary definitions are renumbered in accordance with the compressed list.
9-12
Version 3.26
Chapter 9
BOUNDARY MODULE
Region Definition
RDEFINE, NREGION(1), BTYPE, USEROPT: Defines the characteristics of a
boundary region. The program will prompt for boundary condition values. As
described below, the values prompted for depend on the BTYPE selected and the
set of equations turned on (see command RADIATION and command SOLVE).
Note that other characteristics of the boundary region may be defined using
command RINLET, command RTPRESSURE, and command RTURBULENCE.
NREGION
– The region number to which the following characteristics will
be applied. Region 0 contains the values used for the default
domain boundaries.
BTYPE
– The boundary type of this region. Possible types are: INLET,
OUTLET, SYMPLANE, WALL, CYCLIC, STAGNATION,
PRESSURE, BAFFLE, FREESTREAM (SHOCK),
TRANSIENT (SHOCK), ATTACH, RADIATION, DEGAS
(applicable only to Eulerian multiphase flow), RIEMANN,
INTERNAL, NRPRESSURE and NRSTAGNATION.
USEROPT
– STANDARD. The boundary values given in this command are
the ones used by the analysis. This is the only option available
for SYMPLANE, CYCLIC, ATTACH, RADIATION,
INTERNAL and DEGAS boundary types.
– TABLE. A table will be used for the boundary values (see
command TBREAD). The user will then be prompted for the
table file name. Independent variables of the table can be any
or all of the three space coordinates of the table coordinate
system (X, Y, Z for Cartesian) and/or TIME. Appropriate
dependent variables of the table are the same as those for user
subroutines. The coordinate system used should be the same as
the coordinate system specified in the boundary region
definition.
subroutine to define the boundary values for this region. The
values supplied in the command will be used as defaults for
any value not assigned in the user subroutine.
– GTPOWER. The GT-POWER subroutine will be used. This
option is only valid for INLET or PRESSURE boundary types
and only for transient simulation.
– RETIP. The specified pressure value corresponds to the tip
region of the turbomachine. Only valid for PRESSURE or
NRPRESSURE boundary types.
– REHUB. The specified pressure value corresponds to the hub
region of the turbomachine. Only valid for PRESSURE or
NRPRESSURE boundary types.
Based on the BTYPE and the equations and options that have been turned on,
pro-STAR will prompt for the following values (not necessarily in the order given
here):
Version 3.26
9-13
BOUNDARY MODULE
Chapter 9
Region Definition
BTYPE = INLET (see also command RINLET)
Value
Description
When Prompted For
U, V, W
Velocity components
Always
ICSYS
Coordinate system
Always
OMEGA
Omega
Always
T
Temperature value
Temperature solver on
DEN
Density
Always
TRAD
Radiation temperature
Thermal radiation on
EMISS
Emissivity
BTYPE = OUTLET
Value
Description
When Prompted For
SOPT
Split option:
Always
– /SPLIT,FSPLIT/: Split option,
with flow split ratio FSPLIT.
May not be used if there are
any PRESSURE boundaries.
– /FIXED,FRATE/: No split
option, with flow rate FRATE.
TRAD
EMISS
Emissivity
BTYPE = SYMPLANE
SYMPLANE regions require no extra values.
BTYPE = WALL
9-14
Value
Description
When Prompted For
SPOPT
Slip option (NOSLIP/SLIP)
Always
TLACTIVE
Defines whether two-layer is
active on region (Y/N)
Two-layer model is on
Version 3.26
Chapter 9
BOUNDARY MODULE
Region Definition
Value
Description
When Prompted For
ROPT
Roughness option:
Always
– /STANDARD,ELOG/:
Standard roughness.
– /ROUGH,Y0,D,A,B,C/:
Specified roughness, where
Y0 is effective roughness
height and D is displacement
of zero velocity plane. A, B
and C are constants.
– /USER/: Roughness is defined
in user subroutine ROUGHW.
U, V, W
Velocity components
SPOPT = NOSLIP
ICSYS
Coordinate system
SPOPT = NOSLIP
OMEGA
Omega
SPOPT = NOSLIP
TOPT
Temperature option:
Temperature solver is on
– /ADIABATIC/: Adiabatic.
– /FIXED,T,RESIS/: Fixed
temperature T with wall
resistance RESIS.
– /FLUX,Q/: Fixed heat flux Q.
– /CONDUC,RESIS/: Allowed
only when conjugate heat
transfer is on, and only on
solid/ fluid interface.
EMISS
Emissivity
REFLEC
Reflectivity
ABSORP
Solar absorptivity
Thermal and solar radiation on
EXOPT
Solar exposed option
(EXPOSED/UNEXPOSED)
Solar radiation on
TRANS
Transmissivity
Thermal or solar radiation on
LFSUPPORT
Defines whether the region can Liquid films are on
support a liquid film (Y/N)
ILTY, LFU, LFV, Liquid film type and initial
Liquid film initialisation is on
LFW
components of film velocity (in
coordinate system ICSYS)
LFY, LFT
Version 3.26
Film thickness and temperature
9-15
BOUNDARY MODULE
Chapter 9
Region Definition
BTYPE = CYCLIC
Value
Description
When Prompted For
ICSYS
Coordinate system
Always
OPT1
Region is all or partially cyclic Always
(ALL/PARTIAL)
OPT2
Region is regularly cyclic or
anticyclic (REGU/ANTI)
Always
OPT3
Cyclic boundaries are to be
matched as integrals or as
arbitraries (INTE/ARBI)
Always
POPT
Partial cyclic option:
– /PDROP,DELTAP/
– /MFLOW,FLOWRATE/
OPT1 = PARTIAL
TBULK
Bulk temperature
OPT1 = PARTIAL
FX, FY, FZ
Anticyclic matching flip
directions (N/Y for each)
OPT2 = ANTI
DX, DY, DZ
Offsets added to centroids of
boundaries for matching
OPT3 = ARBI
BTYPE = STAGNATION
9-16
Value
Description
When Prompted For
PSTAG
Stagnation pressure
Always
TSTAG
Stagnation temperature
Always
SOPT
Stagnation quantities defined
with absolute or relative
velocity (SABS/SREL)
Always
DOPT
Velocity direction option:
Always
– /VNORMAL/: Velocity is
normal to the surface.
– /DCOS,DU,DV,DW,ICSYS/:
Velocity direction cosines are
DU, DV, DW in coordinate
system ICSYS.
VOPT
Velocity is relative or absolute Always
(VREL/VABS)
TRAD
Version 3.26
Chapter 9
BOUNDARY MODULE
Region Definition
Value
Description
When Prompted For
EMISS
Emissivity
BTYPE = PRESSURE (see also command RTPRESSURE)
Value
Description
When Prompted For
POPT
Pressure is piezometric or static Not applicable for
(PIEZO/STATIC)
USEROPT = RETIP or REHUB
(STATIC in such cases)
P
Pressure value
ENV
Pressure is a total environmental Not applicable for
pressure, but only under inflow USEROPT = RETIP or REHUB
conditions (N/Y)
MEAN
Pressure is mean of pressure
profile extrapolated from the
model’s interior (N/Y)
NBIN
Number of averaging intervals Only applicable for
to be used while enforcing the USEROPT = RETIP or REHUB
radial equilibrium condition
UVW
Ascribe velocity components to Always
pressure boundary (N/Y)
U, V, W
Velocity components
UVW = Y
ICSYS
Coordinate system
UVW = Y
OMEGA
Omega
UVW = Y
TRAD
EMISS
Emissivity
Always
Not applicable for
USEROPT = RETIP or REHUB
BTYPE = BAFFLE
Note: Baffle boundaries have two sides. The following values will be prompted for
twice, once for each side. Entering ‘SAME’ on the second pass will assign the
values for side 1 to side 2.
Version 3.26
Value
Description
When Prompted For
SPOPT
Always
TLACTIVE
Defines whether two-layer is
active on region (Y/N)
Two-layer model is on
9-17
BOUNDARY MODULE
Chapter 9
Region Definition
Value
Description
When Prompted For
ROPT
Roughness option:
Always
– /STANDARD,ELOG/:
Standard roughness.
– /ROUGH,Y0,D,A,B,C/:
Specified roughness, where
Y0 is effective roughness
height and D is displacement
of zero velocity plane. A, B
and C are constants.
– /USER/: Roughness is defined
in user subroutine ROUGHW.
U, V, W
Velocity components
SPOPT = NOSLIP
ICSYS
Coordinate system
SPOPT = NOSLIP
OMEGA
Omega
SPOPT = NOSLIP
ARES
ARES
SPOPT = NOSLIP (Side 1 only)
BRES
BRES
POROS
Boundary porosity
TOPT
Temperature option:
Temperature solver is on
– /ADIABATIC/: Adiabatic.
– /FIXED,T,RESIS/: Fixed
temperature T with wall
resistance RESIS.
– /FLUX,Q/: Fixed heat flux Q.
– /CONDUC,RESIS/: Allowed
only for side 1.
EMISS
Emissivity
REFLEC
Reflectivity
ABSORP
Solar absorptivity
Thermal and solar radiation on
TRANS
Transmissivity
Thermal radiation on (Side 1
only)
LFSUPPORT
Defines whether the region can Liquid films are on
support a liquid film (Y/N)
ILTY, LFU, LFV, Liquid film type and initial
Liquid film initialisation is on
LFW
components of film velocity (in
coordinate system ICSYS)
LFY, LFT
9-18
Film thickness and temperature
Version 3.26
Chapter 9
BOUNDARY MODULE
Region Definition
BTYPE = FREESTREAM
Value
Description
When Prompted For
U, V, W
Velocity components
Always
ICSYS
Coordinate system
Always
OMEGA
Omega
Always
P
Pressure value
Always
T
Temperature value
TRAD
EMISS
Emissivity
BTYPE = TRANSIENT
Value
Description
When Prompted For
U, V, W
Velocity components
Always
ICSYS
Coordinate system
Always
P
Pressure value
Always
T
Temperature value
TRAD
EMISS
Emissivity
BTYPE = ATTACH
Value
Description
When Prompted For
ICSYS
Coordinate system
Always
IREGALT
Alternate region
Always
BTYPE = RADIATION
Version 3.26
Value
Description
When Prompted For
TRAD
Always
EMISS
Emissivity
Always
9-19
BOUNDARY MODULE
Chapter 9
Region Definition
BTYPE = DEGAS
DEGAS regions require no extra values to prompt for.
BTYPE = RIEMANN
Value
Description
When Prompted For
U, V, W
Velocity components
Always
ICSYS
Coordinate system
Always
OMEGA
Omega
Always
P
Pressure value
Always
T
Temperature value
TRAD
EMISS
Emissivity
BTYPE = INTERNAL
INTERNAL regions require no extra values.
BTYPE = NRPRESSURE
Value
Description
When Prompted For
P
Pressure value
Always
NHARM
Number of harmonics
Always
RELAX
Relaxation factor
Always
BTYPE = NRSTAGNATION
9-20
Value
Description
When Prompted For
PSTAG
Stagnation pressure
Always
TSTAG
Stagnation temperature
Always
SOPT
Stagnation quantities defined
with absolute or relative
velocity (SABS/SREL)
Always
Version 3.26
Chapter 9
BOUNDARY MODULE
Region Definition
Value
Description
When Prompted For
DOPT
Velocity direction option:
Always
– /VNORMAL/. Velocity is
normal to the surface.
– /DCOS,DU,DV,DW,ICSYS/.
Velocity direction cosines are
DU,DV,DW in coordinate
system ICSYS
VOPT
Velocity is relative or absolute Always
(VREL/VABS)
NHARM
Number of harmonics
Always
RELAX
Relaxation factor
Always
RDELETE, NREG1, NREG2(NREG1), NRINC(1): Deletes the characteristic
values for a set of regions.
NREG1,
NREG2,
NRINC
– Deletes regions in the range of NREG1 to NREG2 by NRINC.
RGENERATE, NREP, NROFF, NREG1(1), NREG2(NREG1), NRINC(1):
Generates additional boundary regions with properties identical to the original
starting set. This may be useful for setting up patches for radiation modelling.
NREP,
NROFF
– Generates NREP sets of regions incrementing the initial set by
NROFF each time. The starting set is included in the NREP
count.
NREG1,
NREG2,
NRINC
– The initial set of regions is defined by NREG1 to NREG2 by
NRINC.
RINLET, NREG, OPTION: Defines parameters for compressible subsonic
inflows for an inlet boundary region.
Version 3.26
9-21
BOUNDARY MODULE
Chapter 9
Region Definition
NREG
– The boundary region number, which must be an inlet region.
OPTION
– MASSFLOW,FIXANG(N/Y). The inlet mass flux is calculated
by STAR. FIXANG is a flag which determines whether the
direction of the inlet velocity remains fixed (Y) or not (N).
– VELOCITY. The specified inlet velocity remains fixed.
RLIST, NREG1(0), NREG2(NREG1), NRINC(1): Lists the definition of each
boundary region.
NREG1,
NREG2,
NRINC
– Lists the definitions for regions NREG1 to NREG2 by NRINC.
RMODIFY, NREG(1): Modifies the characteristics of an already defined
boundary region. The program will prompt for boundary condition values, which
are dependent on the boundary type (BTYPE) of the region and the set of equations
turned on (see command SOLVE and command RADIATION). Entering a ‘U’ for
any value will leave it unchanged from the previous definition. This command does
not change the BTYPE of a boundary region; to change the BTYPE, use the
RDEFINE command instead.
NREG
– The region number whose characteristics will be modified.
RNAME, IREG(0), NAME: Defines an alphanumeric identifier for a boundary
region entry.
IREG
– ID of a region entry.
NAME
– A name of up to 80 characters to attach to this region. The
name may not have embedded blanks or commas.
17.2
9-22
Version 3.26
Chapter 9
BOUNDARY MODULE
Region Definition
RTPRESSURE, NREG, TOPTION, COPTION: Sets temperature and scalar
mass fraction options for pressure boundary regions.
NREG
– The boundary region number, which must be a pressure region.
TOPTION
– TEMPERATURE,T(293.0). Supply a boundary temperature
value T. For Eulerian multi-phase problems, T is the boundary
temperature of the continuous phase, while the boundary
temperature of the dispersed phase is defined by the
ERTPRESSURE command.
– ZGRADT. Boundary temperatures will be calculated by
STAR.
COPTION
– CONCENTRATION. Use fixed boundary values for scalar
species mass fractions, as defined by command RSMODIFY
– ZGRADC. Boundary mass fractions will be calculated by
STAR.
RTURBULENCE, NREG, TOPTION: Sets turbulence options and parameter
values for boundary regions.
NREG
– Boundary region number. This command is valid only for
freestream, inlet, non-reflective pressure, non-reflective
stagnation, pressure, Riemann, stagnation, and transient
shockwave regions.
TOPTION
– NONE. Turbulence is off for this region.
– K,KE(0.0). Supplies a boundary value for turbulence kinetic
energy. This option is not valid for pressure, non-reflective
pressure, or non-reflective stagnation boundary regions.
– KEPSILON,KE(0.0),EPS(0.0). Supplies boundary values for
turbulence kinetic energy and dissipation rate. This option is
not valid for pressure boundary regions.
– MIXLENGTH,TURBINTENSITY(0.0),
LENGTHSCALE(0.0). Supplies boundary values for
turbulence intensity and length scale.
– RSM, EPS(0.0),RSUU(0.0),RSVV(0.0),RSWW(0.0),
RSUV(0.0),RSVW(0.0),RSUW(0.0). Supplies boundary
values for turbulence dissipation rate and Reynolds stress
components. This option is not valid for pressure,
non-reflective pressure, or non-reflective stagnation regions.
– ZGRAD. Turbulence parameters will be calculated by STAR.
This option is valid only for pressure boundary regions.
Version 3.26
9-23
BOUNDARY MODULE
Chapter 9
Scalar Boundary Values
Scalar Boundary Values
RSGENERATE, NREG(1), NREG1(0), NREG2(NREG1), NREGINC(1):
Generates scalar boundary values for a range of boundary regions based on scalar
boundary values of a single boundary region.
NREG
– Region number from which to copy scalar boundary values.
This region must be an inlet, wall, pressure, stagnation or
baffle region.
NREG1,
NREG2,
NREGINC
– Scalar boundary values from region NREG will be copied to
any inlet, wall, pressure, stagnation and baffle regions in the
range NREG1 to NREG2 by NREGINC.
RSLIST, NSC1(1), NSC2(NSC1), NSCINC(1), NREG1(ALL),
NREG2(NREG1), NREGINC(1): Lists scalar boundary values.
Scalar boundary values for scalars NSC1 to NSC2 by NSCINC will be listed for
all inlet, wall, pressure, stagnation, baffle, and Riemann boundary regions in the
range NREG1 to NREG2 by NREGINC.
RSMODIFY, NREG(0), NSC(1), OPTION, PROPT: Modifies a scalar boundary
value. Scalar boundary values are only used for inlet, wall, pressure, stagnation,
Riemann and baffle regions.
9-24
NREG
– Region number for which to modify scalar value.
NSC
– Scalar number.
OPTION
– CONCENTRATION,CONC(0.0). Scalar mass fraction. This
option is valid for inlet, stagnation, pressure and Riemann
regions.
– ADIABATIC. Adiabatic wall/baffle. This option is valid only
for wall or baffle regions. For baffle regions, pro-STAR will
prompt for the side number (1 or 2).
– FIXED,VAL1(0.0),VAL2(0.0). Fixed value for walls/baffles
(VAL1) plus optional wall/baffle resistance (VAL2). This
option is valid only for wall or baffle regions. For baffle
regions, pro-STAR will prompt for the side number (1 or 2).
– FLUX,FLX(0.0). Flux value through wall/baffle. This option is
valid only for wall or baffle regions. For baffle regions,
pro-STAR will prompt for the side number (1 or 2).
Version 3.26
Chapter 9
BOUNDARY MODULE
Boundary Couple Definition
OPTION
– DIFFUSION,DIFF(0.0). Diffusion through baffle plus baffle
resistance. This option is valid only for baffle regions and is
applied for both sides.
PROPT
– If PROPT = NOPR, then output for this command is
suppressed. This option should follow the last required input.
Error messages are not suppressed.
BC, NBC, N1, N2: Defines a pair of boundaries or regions that together form a
coupled pair. These coupled pairs are used to join cells that exist in different rotating
frames of reference.
NBC
– Boundary couple number. The user can redefine a previously
defined set by simply using a set number over again. If blank,
the next unused set number will be used.
N1, N2
– Boundary or region N1 will be coupled to boundary or region
N2. The BCOPTION command is used to set whether N1 and
N2 are interpreted as individual boundaries or as entire
boundary regions. N1 cannot be equal to N2.
BCCOMPRESS: Compresses undefined or deleted boundary/region couple
numbers out of the model.
BCDELETE, NBC1, NBC2, NBCINC: Deletes a set of boundary/region couple
definitions.
NBC1,
NBC2,
NBCINC
– Deletes couples NBC1 to NBC2 by NBCINC.
BCGROUP, NGP, OPTION, NBC1, NBC2: Groups region couples together.
Works only if BCOPTION is set to REGION. This command allows the user to take
Version 3.26
9-25
BOUNDARY MODULE
Chapter 9
several individual BC (coupled region) definitions and join them into one larger
region for purposes of averaging the fluxes crossing these boundaries.
NGP
– Group number. Defaults to the next available.
OPTION
– ADD defines a group number if not already defined and adds
to the group definitions if defined.
– DELETE deletes the group number.
NBC1, NBC2 – If option ADD is chosen, it defines NBC1 to NBC2 region
couples to correspond to group number NGP.
BCLIST, NBC1(1), NBC2(NBC1), NBCINC(1): Lists boundary/region couple
definitions and groups if present.
NBC1,
NBC2,
NBCINC
– Lists couples NBC1 to NBC2 by NBCINC.
BCMATCH, NREG1, NREG2, TOL(.0001): Matches boundaries on two faces
by comparing the boundary centroids in the global coordinate system and appends
to the boundary couple list. Because it creates boundary couples, this command will
work only if BCOPTION is set to BOUNDARY.
NREG1,
NREG2
cannot be equal to NREG2.
TOL
matched.
Note: Boundaries within the regions for which matches cannot be found will be
listed. It is the user’s responsibility to couple them if necessary using the BC
command.
BCOPTION, OPTION: Specifies the boundary coupling option used to join
blocks of cells that exist in different rotating frames of reference.
9-26
Version 3.26
Chapter 9
BOUNDARY MODULE
Fluid/Structure Coupling
OPTION
– BOUNDARY. Boundary couples defined by BC and
BCMATCH will be one to one couplings of boundaries from
one cell block to those of another.
– REGION. The boundary couples defined by BC will be
regions rather than individual boundaries. In this case the
coupling will average the flux crossing all boundaries in one
region with all boundaries in the second. BCMATCH cannot
be used with this option.
Note: This option must be set up prior to creating any boundary couple.
CICDEFINE, NCIN(1), LOPT, NREG1(1), NREG2(NREG1), NREGINC(1):
Defines up to 20 regions making up a coupling interface.
NCIN
– Coupling interface number.
LOPT
– NEWSET. Defines the coupling interface with the following
regions.
– ADD. Adds regions to an existing coupling interface.
– DELETE. Removes regions from the existing coupling
interface.
NREG1,
NREG2,
NREGINC
– A range of region numbers. The keyword BSET can be used in
place of NREG1 to specify the required regions.
CICOMPRESS: Compresses coupling interfaces. Coupling interfaces must be
compressed before the problem file is written out.
CIDELETE, NCIN1(1), NCIN2(NCIN1), NINC(1): Deletes coupling interfaces.
NCIN1(1),
– Deletes coupling interfaces NCIN1 to NCIN2 by NINC.
NCIN2(NCIN1), The keyword ALL may be used in place of NCIN1.
NINC
Version 3.26
9-27
BOUNDARY MODULE
Chapter 9
CILIST, NCIN1(1), NCIN2(10), NINC(1): Lists coupling interfaces.
NCIN1, NCIN2, – Lists coupling interfaces NCIN1 to NCIN2 by NINC. The
NINC
keyword ALL may be used in place of NCIN1.
CIMM, OPTION1, OPTION2(1.0e5): Specifies internal vertex displacement in
response to boundary movement. Displacements are only received for the vertices
on the coupling interface so this command is used to specify how the rest of the
mesh should move.
OPTION1
– BOUN (default). Moves boundary vertices only.
– SREL. Smoothes vertex displacements over the whole mesh
according to relative displacements.
– STOT. Smoothes vertex displacements over the whole mesh
according to total displacements.
For SREL or STOT only:
OPTION2
– Multiplication factor for mesh smoothing. This factor scales up
the displacements for reliable numerical solution.
CITAG, NCIN(1), MESH(1), PART(1), TAG(0): Optionally tags an existing
coupling interface (only useful for multiple coupling interfaces). This facility can
be used if the vertices of multiple coupling interfaces are in the same plane or if, for
efficiency reasons, the search for matching fluid and structural vertices needs to be
limited.
NCIN
– Coupling interface number.
MESH
– Mesh number.
PART
– Partition number.
TAG
– Tag number.
MPCCI, STATUS: Sets coupling interface on or off.
STATUS
9-28
– OFF (default). Turns fluid structure interface off.
– ON. Turns fluid structure interface on.
Version 3.26
Chapter 9
BOUNDARY MODULE
Version 3.26
9-29
Chapter 10
CONTROL MODULE
Solution Controls
Chapter 10
CONTROL MODULE
Solution Controls
AAANALYSIS, STATUS, NFDI(500), KERA(0.0001), KMAX(0.01),
ISCC(0.01), CSYS: Turns on/off modelling of the Lilley aeroacoustic equation
sources. A stochastic approach is used to synthesise the fluctuating velocity from k
and ε, which is then used to calculate Lilley aeroacoustics sources.
STATUS
– OFF (default). Turns aeroacoustic modelling off.
– ON. Turns aeroacoustic modelling on. Aeroacoustic modelling
may be turned on for steady-state analyses only.
NFDI
– Number of discretisation points in the frequency domain.
KERA
– Threshold ratio for k/ε, which determines the cells in which to
perform the aeroacoustic analysis.
KMAX
– Threshold ratio for k/kmax, which determines the cells in which
to perform the aeroacoustic analysis.
ISCC
– Convergence criterion for the iterative scheme used to
calculate parameters of the von Karman turbulence energy
spectrum.
CSYS
– Coordinate system used.
– GLOBAL (default). Global Cartesian coordinate system.
– LOCAL. Local Cartesian coordinate system whose origin is
located at the centroid of the cell with the largest k.
ALGORITHM, OPTION, DEFOPT, VALUES: Sets the algorithm used for
solution. SIMPLE and SMPISO can only be used for steady state analyses. The
PISO method may be used for either steady-state or transient
Version 3.26
OPTION
– /SIMPLE/SMPISO/PISO/.
DEFOPT
– DEFAULT. The number of sweeps, residual error tolerances
and under-relaxation factors are set to recommended defaults
based on the setting of the ALGORITHM and
STEADY/TRANSIENT options of command TIME.
10-1
CONTROL MODULE
Chapter 10
Solution Controls
DEFOPT
– NODEFAULT. The number of sweeps, residual error
tolerances and under-relaxation factors are not changed from
previous settings.
VALUES
– For SIMPLE
– None required.
– For SMPISO
– URFPCR(.8). Under-relaxation factor for pressure
correction.
– For PISO
– MAXCOR(20). Maximum number of correctors.
– RESOC(.25). Residual error tolerance for the pressure
correction stages.
– URFPCR(1.). Under-relaxation factor for pressure
correction.
CONJUGATEHEAT, STATUS, URFSOL(1.): Turns on or off the capability
within STAR to perform a conjugate heat transfer analysis. This capability allows
STAR to calculate the conductive heat transfer solution in solid cells at the same
time as the usual fluid heat transfer solution.
STATUS
– /ON/OFF/.
URFSOL
– Under-relaxation value for temperature solution in solid cells.
DSCHEME, SCHEME, FIELD VARIABLE(ALL), FACTOR, UOPTION:
Sets the differencing scheme used for each field variable and, for higher order
differencing, a blending factor to use with first order upwind differencing.
SCHEME
– UD. Upwind Differencing. For this scheme, FACTOR and
UOPTION are not used. This is the default scheme for all field
variables except DENSITY.
– MARS. Monotone Advection and Reconstruction Scheme.
– SFCD. Self-Filtered Central Differencing.
– CD. Central Differencing. This is the default scheme for field
variable DENSITY.
– LUD. Linear Upwind Differencing.
– QUICK. Quadratic Upstream biased Interpolation scheme for
Convective Kinematics.
FIELD
– /ALL/CONCENTRATION/DENSITY/RSM/T/
VARIABLE
/TURBULENCE/UVW/.
10-2
Version 3.26
Chapter 10
CONTROL MODULE
Solution Controls
FACTOR
Each of the differencing schemes, except for UD, has a factor
associated with it that must be between 0 and 1. FACTOR is
defined as follows:
– For the MARS differencing scheme, FACTOR represents the
level of compression of the advection scheme. The higher this
parameter, the more compressive the scheme becomes. The
default value is 0.5.
– For the CD, LUD and QUICK differencing schemes, FACTOR
represents the blending factor with UD (0.0 = pure upwind
differencing, 1.0 = no blending). The default value is 1.0 for all
variables other than DENSITY. The default factor for
DENSITY is 0.01.
– For the SFCD differencing scheme, the actual value of the
blending factor is dynamically adjusted during the solution.
These dynamic blending factors are proportional to the inverse
of FACTOR. Thus, lower values of FACTOR result in higher
blends of CD. The default value of FACTOR is 0.5.
UOPTION
– STANDARD (default). The standard STAR methods are
employed.
– USER. User subroutine VARBLN is called to calculate the
blending factor on a per cell basis.
Note:
1. CD and MARS are the only allowable differencing schemes for field variable
DENSITY. FACTOR is not applicable when MARS is used to compute
DENSITY.
2. The differencing scheme selected for field variable CONCENTRATION
applies to all additional scalars.
3. If any fluid material in the model has LES turbulence, then the UD scheme is
not allowed for UVW.
EDATA, OPTION: Allows input of various undocumented extended data text.
These data are for debugging purposes and should be used only under the direction
of your STAR-CD representative.
OPTION
Version 3.26
– LIST (default). Lists the extended data text.
– CLEAR. Clears all extended data text.
– ADD,NLINES. Adds a given number of lines (NLINES) of
text to the end of the existing extended data text. The user will
be prompted for each line. Lines of text may be up to 80
characters long and may include embedded blanks or commas.
Lines may also be entirely blank.
10-3
CONTROL MODULE
Chapter 10
Solution Controls
OPTION
– NEW,NLINES. Clears all extended data text, then prompts the
user for NLINES lines of text, which will be the new extended
data text.
Note: Extended data may be edited more easily using the Extended Data GUI.
ERRESTIMATE, EOPT1, EOPT2: Sets the STAR error estimating flags.
EOPT1
– /OFF/ON/. Turns off/on error estimation.
EOPT2
– /OFF/ON/. Turns off/on additional error estimation for near
wall cells.
GTPOWER, STATUS: Sets GTPOWER solver status.
STATUS
– /OFF/ON/. Turns GT-POWER solver off or on. If turned on,
pro-STAR will create a file named ‘star.gtp’. When turned
off, pro-STAR will delete this file.
ITERATION, ITSTEP, RESMAX(.001): Defines the number of iterations
through the STAR solvers. If the predicted solution satisfies the convergence
criteria, then STAR will not use the full allocation of iterations.
ITSTEP
– The number of iterations to be performed in this run for steady
state analyses (default = 100) or the maximum number of time
steps performed for a transient analysis (default = 99999).
RESMAX
– Overall residual tolerance.
MFRAME, STATUS, URFBNP(.8), URFBNU(.8), IUPDAT(1), IBEG(1),
IGPF0(0), IGPF1(0), NHARM(5): Sets control parameters used in multiple
rotating frame of reference problems.
10-4
Version 3.26
Chapter 10
CONTROL MODULE
Solution Controls
STATUS
– OFF. The multiple reference frame feature is turned off.
– IMPLICIT. The spin velocities are defined based on the spin
index specified in the CTABLE command for every cell type.
– EXPLICIT. The interfaces between fluids in different frames
of reference must be coupled using the BCOPTION, BC and
BCMATCH commands available in the BOUNDARY module.
The spin velocities are specified materialwise.
– NR-EXPLICIT. As above, except that the field values will be
coupled using a Non-Reflecting method.
The following parameters are valid only if EXPLICIT or NR-EXPLICIT are
chosen.
URFBNP
– Under-relaxation factor for velocities transferred from pressure
to inlet boundaries.
URFBNU
– Under-relaxation factor for pressures transferred from inlet to
pressure boundaries.
IUPDAT
– Frequency of updating boundaries (1 means every iteration).
IBEG
– Iteration number at which to begin updating.
IGPF0,
IGPF1
– Boundary couple group numbers. The mass flow rate at group
IGPF1 will be scaled to balance the flux at group IGPF0.
IGPF0, IGPF1 must be both zero or both non-zero. If non-zero,
the groups must be defined by the time the geometry file is
written.
The following parameter is valid only if NR-EXPLICIT is chosen.
NHARM
– Number of harmonics.
RADIATION, ROPTION, URFRAD(0.3): Turns on/off the calculation of
wall-to-wall heat transfer due to radiation effects and selects the radiation model.
ROPTION
Version 3.26
– OFF. Turns radiation modelling off.
10-5
CONTROL MODULE
Chapter 10
Solution Controls
ROPTION
– DTRM,NBEAM(100),GASOPT(/OFF/ON/),NCOMPU(1).
Uses the Discrete Transfer radiation model.
– NBEAM. Number of beams per patch. Higher numbers yield
greater accuracy at the cost of significantly higher CPU
times. The number of beams defined must be according to
the series 4*N**2 (i.e. 4, 16, 36, 64, 100, …).
– GASOPT. Turns gaseous radiation modeling (participating
media) off or on. If ON, then radiation must be turned on for
all fluid cells (see command CTABLE) before writing the
geometry file.
– NCOMPU. Number of fluid iterations per radiation
calculation. Only required if the GASOPT is ON.
– DORM,DOITER(20),DOTOL(1.E-8),ORDSET(S4),
NCOMPU(1). Uses the Discrete Ordinate radiation model.
– DOITER. Maximum number of iterations in the DO solver.
– DOTOL. DO solver tolerance.
– ORDSET. Ordinate set to use (one of S2, S4, S6, S8).
– NCOMPU. Number of fluid iterations per radiation
calculation.
– VFNP,TENV(300.0). Uses the FASTRAC view factor
calculation radiation method. The surrounding environmental
temperature is set to TENV (in Kelvins).
URFRAD
– Under-relaxation parameter for calculation of wall temperature
when radiation is on and an adiabatic or total flux boundary
condition is prescribed.
RCONSTANT, OPTION: Allows input of various undocumented constants.
These constants are for debugging purposes and should be used only under the
direction of your STAR-CD representative.
OPTION
– NCONST,RVALUE. Assigns value RVALUE to constant
number NCONST. Constant number must be from 1 to 200.
– ALL,RVALUE. Assigns value RVALUE to all 200 constants.
– LIST. Lists the values of all constants.
RDATA, OPTION, INITOPT, LF(case.pst or case.smap), RESET:
Controls the reading and use of a restart file.
10-6
Version 3.26
Chapter 10
CONTROL MODULE
Solution Controls
OPTION
– NONE. No restart file is read. Analysis is begun from initial
conditions set in the PROPERTIES module.
– RESTART. The analysis is continued from a previous
(unconverged) run. The results of the previous analysis are
contained on a restart file (case.pst).
– INITIALFIELD. With an initial field restart, the user is
expected to supply a restart file containing a complete field
definition to use as a starting point for an analysis. Typically
this happens when the user wishes to restart a previous analysis
with altered boundary conditions. The user may pick between
three possible forms for this restart:
INITOPT
– A. STAR will read only cell data from the restart file and
completely ignore boundary data. This option should be used
when making changes to boundary types (i.e. switching a
cyclic boundary to a symmetry boundary) as well as boundary
values.
– B. STAR will read both cell and boundary data from the restart
file, but boundary values, such as input velocities, written on
the problem data file (case.prob) will supersede the values
contained on the restart file. With this option the user may
change input values but not redefine any boundary type.
– C. STAR will read cell data from a file created using the
SMAP command.
LF
– For INOPT = A or INOPT = B, the name of the restart file
(default is case.pst). For INOPT = C, the name of the
SMAP data file (default is case.smap).
RESET
– /RESET/CONTINUE/ (default is RESET). For initial field
restarts, option RESET makes the restart run counter start from
time step/iteration 1. Option CONTINUE makes the restart run
counter continue from the time step or iteration number of the
previous run.
REFLUX, URFFLX(1.): Sets the under-relaxation value of fluxes for velocity
initialisation.
URFFLX
– Value of under-relaxation parameter.
RELAX, RLVEL, RLP, RLKE, RLT, RLVIS, RLDEN, RLLAMVIS,
Version 3.26
10-7
CONTROL MODULE
Chapter 10
Solution Controls
RLCONDUC, RLRSTRESS, RLG, RLV22, RLF22, RLA2: Sets the value of the
relaxation factors used in the solution of each of the respective variables. Two forms
of this command can be used. The user can type ‘RELAX,.7,.7,.6,…,1.’ to change
all of the values in one line. Alternatively the user may type ‘RELAX,RLP (or any
other variable name),1.’ to change the value of a single relaxation parameter.
RLVEL is used for U, V and W. RLKE is used for KE and EPS. RLRSTRESS is
used for Reynolds stress variables RSUU, RSVV, RSWW, RSUV, RSVW and
RSUW. RLG is used for P1 radiation model intensity. Typing
‘RELAX,DEFAULT’ will set all variables to their recommended values based on
whether the SIMPLE or PISO scheme has been selected as well as the
STEADY/TRANSIENT setting.
RLVEL, RLP, – Under-relaxation factors as described above.
…, RLA2
RLKE is the under-relaxation factor for the V t -equation when using the
Spalart-Allmaras model or for the k and ω equations when using the k-ω models.
RESIDUAL, RSU, RSV, RSW, RSP, RSKE, RSEPS, RST, RSUU, RSVV,
RSWW, RSUV, RSVW, RSUW, RSG, RSV22, RSF22, RSA2: Sets the values of
the residual error tolerances used for judging convergence of each of the respective
variables. Two forms of this command can be used. The user can type
‘RESID,.3,.3,.4,…,.2’ to change all of the values in one line. Alternatively, the user
may type ‘RESID,RSP (or any other variable name), .5’ to change the value of a
single residual value. Typing ‘RESID,DEFAULT’ will set all variables to their
recommended values based on whether the SIMPLE or PISO scheme has been
selected as well as the STEADY/TRANSIENT setting.
RSU, RSV,
…, RSA2
– Provides the desired residual error tolerance for each variable.
A blank (or 0) for any value will leave it unchanged from its
previous setting.
RSEPS is the residual error tolerance for the V t -equation when using the
Spalart-Allmaras model or for the ω-equation when using the k-ω models.
SOLAR, SOPTION, ICSOL(3), SOLAZI(0.0), SOLALT(0.0),
SOLINT(1000.0), SOLDIFF(800): Sets solar radiation parameters.
10-8
Version 3.26
Chapter 10
CONTROL MODULE
Solution Controls
SOPTION
– OFF (default). Turns off solar radiation.
– ON. Turns on solar radiation.
– USER. Turns on solar radiation, with the parameters to be
specified in user subroutine USOLAR.
The following arguments are used only if SOPTION is ON:
ICSOL
– A spherical coordinate system in which to measure the
position (azimuth and altitude) of the sun.
SOLAZI
– Angle specifying the solar azimuth in degrees.
SOLALT
– Angle specifying the solar altitude in degrees.
SOLINT
– Solar intensity in watts/m2.
SOLDIFF
– Atmospheric diffuse solar radiation in watts per square meter.
This is only applicable for the FASTRAC radiation model.
SOLUFORM, OPTION: Determines which matrix solution algorithm is to be
used in STAR.
OPTION
– SCALAR,/CG/AMG/. The SCALAR option is the quicker
option for machines without a hardware vectorising unit.
Either the CG or the AMG solver can be used for the pressure
equation.
– VECTOR. The VECTOR option is the quicker option for
machines with hardware vectorising units (such as CRAY,
CONVEX, FUJITSU and HITACHI) and is the default on
those machines. However, it requires ore memory than the
SCALAR option.
Note: Either option can be used for any machine.
SOLVE, LU, LV, LW, LP, LKE, LEPS, LT, LVIS, LDEN, LLAMVIS, LCP,
LCONDUC, LUU, LVV, LWW, LUV, LVW, LUW, LG, LV22, LF22, LA2:
Controls the variables that are solved for. Two forms of this command can be used.
The user can type ‘SOLVE,Y,Y,Y,Y,N,N,…,N’ in order to change all the settings
in one line. Alternatively, the user may type ‘SOLVE,LP (or any other variable
name), Y (or N)’ to change the value of a single parameter.
Version 3.26
10-9
CONTROL MODULE
Chapter 10
Solution Controls
LU, LV, …,
LA2
– Provides either Y(es) or N(o) for each variable. A blank for a
given variable will leave it unchanged from its previous
setting.
Note:
1. The solution of a variable is sometimes conditional on having previously
issued another command that sets up all parameters needed in that solution
process. The list of such variables and the corresponding command that
enables their solution is as follows:
Variable
Meaning
Command
LKE
Turbulence kinetic energy
TURB
LEPS
Turbulence dissipation rate when k-ε TURB
models are used, or V t when the
Spalart-Allmaras model is used, or ω
when the k-ω models are used
LA2
Second invariant of stress anisotropy, TURB
only available when the k-ε-A2 model
is used
LV22
Variable υ22, only available when the TURB
V2F model is used
LF22
Variable f 22, only available when the TURB
V2F model is used
LT
Temperature
TEMP
LVIS
Turbulent viscosity
TURB
LDEN
Density
DENS
LLAMVIS
Molecular viscosity
LVIS
LCP
Specific heat
SPEC
LCONDUC
Thermal conductivity
COND
2. pro-STAR will automatically turn on the solution of any of the above
variables when the corresponding enabling command is first used. Thus,
turning on the solution explicitly via command SOLVE is unnecessary in this
case.
3. Command SOLVE can be used at any stage to turn any variable solution off, if
that is required for whatever reason, e.g.
(a) Freezing the value of a variable property.
(b) Turning off LU, LV or LW in two-dimensional models.
The solution can always be turned back on again if required.
10-10
Version 3.26
Chapter 10
CONTROL MODULE
Solution Controls
16.1, 16.2, 16.3, 17.1
SWEEP, NSU, NSV, NSW, NSP, NSKE, NSEPS, NST, NSUU, NSVV, NSWW,
NSUV, NSVW, NSUW, NSG, NSV22, NSF22, NSA2: Sets the values of the
number of sweeps used in the solution of each of the respective variables. Two
forms of this command can be used. The user can type ‘SWEEP,20,20,10,…,30’ to
change all of the values in one line. Alternatively, the user may type ‘SWEEP,NSP
(or any other variable name), 15’ to change the value of a single sweep parameter.
Typing ‘SWEEP,DEFAULT’ will set all variables to their recommended values
based on whether the SIMPLE or PISO scheme has been selected as well as the
STEADY/TRANSIENT setting.
NSU, NSV,
…, NSA2
– Provides the desired number of sweeps for each variable. A
blank (or 0) for any value will leave it unchanged from its
previous setting.
NSEPS describes the number of sweeps for the V t -equation in the Spalart-Allmaras
model or the ω-equation in the k-ω models.
Note: The number of sweeps used for pressure is automatically multiplied by a
factor of 1.5 in STAR when the vector solver is turned on.
SWIRLBLEND, SWRLBLND(.95): Enters a blending factor for swirl terms in
models with an axis of symmetry located on a single wedge shaped cell.
SWRLBLND – Blending factor as described above.
SWITCHES, OPTION: Turns on/off or lists various undocumented switches
within STAR. These switches are there for debugging purposes and should be used
only under the direction of your STAR-CD representative.
OPTION
– NSWITCH,/OFF/ON/. Turns off/on switch number
NSWITCH, which must be from 1 and 200.
– ALL,/OFF/ON/. Turns off/on all switches.
– LIST. Lists the current values of all switches.
Version 3.26
10-11
CONTROL MODULE
Chapter 10
Solution Controls
TIME, OPTION, PAROPTION, TOPTION, TSTEP, OUTOPT: Sets time step
and steady-state/transient/pseudo-transient/single-transient analysis key.
OPTION
– STEADY. Analysis is steady state.
– TRANSIENT. Analysis and boundary conditions vary over
time. Use the TRANSIENT module to complete transient load
step definitions.
– PSEUDO-TRANSIENT. Analysis is basically steady state,
however, time step relaxation is used instead of
under-relaxation factors.
– SINGLE-TRANSIENT. Transient analysis. In this mode, the
time-dependent control parameters are not defined in the
transient module using load steps but through commands
DELTIME, WRPOST, PRPOST, etc.
PAROPTION – DEFAULT. The number of sweeps, residual tolerances and
under-relaxation factors are set to recommended defaults.
– NODEFAULT. The number of sweeps, residual tolerances and
under-relaxation factors are not changed from previous
settings.
TOPTION
(PSEUDO-TRANSIENT option only)
– CONSTANT. The time step is constant and defined by the
value of TSTEP.
– USER. The time step value can be varied via a user subroutine,
DTSTEP. The value of TSTEP is supplied as a default.
TSTEP
– Time step value (PSEUDO-TRANSIENT option only).
OUTOPT
– /RATE-CHANGE/RESIDUAL/. Output option (TRANSIENT
only). Rate of change or residual values will be output.
TNORM, DTNORM(0.): Provides an estimated temperature change over the
domain to be used in normalising the residuals of the enthalpy equation. The
normalisation factor is (m)(cp)(DTNORM). If DTNORM = 0., then STAR will use
the smaller and non-zero of (m)(cp)(Tin) or abs [(m)(cp)(Tout–Tin)].
DTNORM
– Estimated temperature change as defined above.
WDATA, OPTION, NWRITE(100), NFSAVE(0), IWUNIT(case.pst):
Controls the writing of a restart/post-processing file (case.pst).
10-12
Version 3.26
Chapter 10
CONTROL MODULE
Scalar Controls
OPTION
– RESTART. A standard restart file will be written. This file
contains all the information required for an analysis to be
continued (see command RDATA) but not enough for
complete post-processing. (Cell data can be plotted but not
vertex data as the latter are not written to the file).
– NONE. No restart file is written. The user will not be able to
restart or post-process the results of the analysis.
NWRITE
– This number controls the frequency with which solution sets
are written to the post data file (case.pst). Each new set
overwrites the previous one. Regardless of the value of this
number, a solution set is always written at the end of a run if
OPTION = RESTART.
NFSAVE
– Successive snapshots of the post data file (case.pst) will be
saved under the file name ‘case.pst.stepnumber’ every
NFSAVE iterations, where ‘stepnumber’ is the total
number of iterations or time steps performed up to a save
operation.
IWUNIT
– Name of the file that will contain the post file after a STAR
analysis.
Scalar Controls
SCCGENERATE, NSC, NSC1, NSC2, NSCINC: Generates (replicates) a set of
scalar control parameters over a range of scalars.
NSC
– Scalar number for which the control parameters have been set.
NSC1, NSC2, – Scalars in the range from NSC1 to NSC2 with increment
NSCINC
NSCINC will have control parameters corresponding to scalar
NSC.
SCCLIST, OPTION, NSC1(1), NSC2(NSC1), NSCINC(1): Lists the control
parameters defined for a range of added scalar equations for the currently active
material number.
Version 3.26
10-13
CONTROL MODULE
Chapter 10
Print Out and Post Data Controls
OPTION
– /BRIEF/FULL/.
NSCINC
SCCMODIFY, NSC(1), ITEM, VALUE: Modifies control parameters of scalars.
NSC
– Scalar number. The keyword ALL may be used in place of
NSC.
ITEM
– /NSWEEPS/POWA/PRWA/RELAX/RESIDUAL/. The control
parameter to modify. See command SCCONTROL for the
definition of each ITEM.
VALUE
– The new value for the ITEM.
SCCONTROL, NSC(1), RELAX(1.0), NSWEEPS(100), RESIDUAL(0.1),
PRWA, POWA: Defines control parameters for scalars.
NSC
– Scalar number.
RELAX
– Under-relaxation factor.
NSWEEPS
– Maximum number of sweeps.
RESIDUAL
– Solver error tolerance.
PRWA
– Whether to print all scalar wall data (N/Y).
POWA
– Whether to place all scalar wall data on the post file (N/Y).
ANORM, /OFF/ON/: Sets the switch for residual normalisation.
10-14
OFF
– Uses the standard residual normalisation to judge the
convergence.
ON
– Uses the old (pre-3.150) default residual normalisation.
Version 3.26
Chapter 10
CONTROL MODULE
BRMONITOR, IREG, OPTION: Turns on requests for STAR to write out a file
containing specific monitoring information on a boundary region by region basis.
IREG
– Boundary region number to monitor. The keyword ALL may
be used to indicate all boundary regions. If the keyword OFF is
used, then monitoring is turned off for all regions, and the
remaining arguments in this command are ignored.
OPTION
– ALL. Monitors all classes of data.
– NONE. Turns off monitoring for the selected region.
– LIST. Lists the classes monitored for the selected region.
– List of items.
Any one or more of the following items are accepted. Each
item in the list from A2 to VELO yields the minimum,
maximum, volume-averaged and mass averaged variable per
iteration or time step:
– A2. A2 in k-ε-A2 model
– DENS. Density
– ED. Turbulent Dissipation
– F22. F22 in V2F model
– KE. Turbulent kinetic energy
– PRES. Pressure
– RSNO. Normal Reynolds stress components (RSUU,
RSVV, RSWW)
– RSSH. Shear Reynolds stress components (RSUV, RSVW,
RSUW)
– TEMP. Temperature
– V22. V22 in V2F model
– VELO. U, V, W, and velocity magnitude
– ENTH. Enthalpy in/out
– FORC. Forces
– HFLU. Heat Flux
– MFLU. Mass flux
– SCAL,NSCAL. Mass fraction for scalar NSCAL
– TORQ. Torques
– UNST. Unsteady pressures
If ITEM = UNST, then also:
– /TIME,TSTART(0.),TEND(99999.)/ or
– /ITER,ISTART(1),ITEND(999999)/
CPUTIME, STATUS: Turns on and off CPU time reporting in STAR at the end of
each iteration.
Version 3.26
10-15
CONTROL MODULE
Chapter 10
STATUS
– /ON/OFF/.
CSMONITOR, LF(case.set), NUMSET, OPTION: Turns on requests for
STAR to write out a file containing specific monitoring information on a cell set by
cell set basis. All the set definitions must be contained on a single set file using
pro-STAR command SETWRITE.
LF
– File name on which set definitions are stored. If the keyword
OFF is used, then cell monitoring is turned off for all sets, and
the remaining arguments in this command are ignored.
NUMSET
– Cell set number or string identifier of the set on file LF.
OPTION
– ALL. Monitors all classes of data.
– NONE. Turns off monitoring for the selected cell set.
– LIST. Lists the classes monitored for the selected cell set.
– List of items.
Any one or more of the following items are accepted. Each
item in the list from A2 to VELO yields the minimum,
maximum, volume-averaged and mass-averaged variable per
iteration or time step:
– A2. A2 in k-ε-A2 model
– DENS. Density
– ED. Turbulence dissipation
– F22. F22 in V2F model
– PRES. Pressure
– RS. Reynolds Stresses
– TE. Turbulence kinetic energy
– TEMP. Temperature
– TLEN. Turbulence length scale
– TTIM. Turbulence time scale
– V22. V22 in V2F model
– VELO. U,V,W,V magnitude in coordinate system ICSYS
– AMOM,ICSYS. Angular momentum in coordinate system
ICSYS
– MASS. Mass
– SCAL,NSCAL. Mass fraction for scalar NSCAL
– VOLU. Volume
LESOUT, MEAN(N/Y), NSTART(1000): Provides time-averaged values of
velocities, pressure and subgrid turbulent viscosity.
10-16
Version 3.26
Chapter 10
CONTROL MODULE
MEAN
– Y (default). Values will be provided.
– N. Values will not be provided.
NSTART
– The averaging will start from time step NSTART (only
processed if MEAN is Y).
MONITOR, NCELL(1): Defines the cell at which the solution variables are
printed out at each iteration. One cell must be monitored for each different material
property set.
NCELL
– The cell number of the cell used for monitoring the solution at
the current material property.
PANALYSIS, WFREQ(0), OPTION, CUTOFF(1), MAXPAT(100): Prints
additional information about those patches that contribute most of the incident
radiative heat flux on a specified patch.
WFREQ
– Writing frequency. This information will be produced every
WFREQ iterations or time steps and written to file
case.info.
OPTION
– STANDARD (default). Analyses the incident radiative heat
flux for the patch with the maximum temperature. The
information includes the radiative heat flux (in Watts) and the
percentage of radiative heat flux contributions from other
patches.
– IPAT. A specific patch number to be analysed.
CUTOFF
– A cutoff value, used to select those patches that contribute
more than a given percentage of the total incident radiation
heat flux to the selected patch.
MAXPAT
– A limit on the number of patches to be listed. The code will
only list up to MAXPAT patches, even if there are still more
patches whose percentage contribution is larger than CUTOFF.
POWALL, OPTION, /NAME1,FLAG1,NAME2,FLAG2,…,NAMEN,
FLAGN/: Specifies or lists what wall data to store in the post data file
Version 3.26
10-17
CONTROL MODULE
Chapter 10
(case.pst).
OPTION
– LIST,OPTION2. Lists wall data NAMEs for ACTIVE or ALL
variables.
– OPTION2.
– ACTIVE (default). Lists wall data NAMEs and their
storing status in the following format:
Name
Definition
Status
SHEA
YPLU
…
…
Shear force
YPLUS
Y
Y
– ALL. Lists ALL wall variable NAMEs that can be stored.
– SPECIFY. Specifies which wall data to store.
NAME1,
FLAG1,
NAME2,
FLAG2,…,
NAMEN,
FLAGN
– NAME1,NAME2,…,NAMEN. Wall post data name.
– FLAG1,FLAG2,…,FLAGN. Y/N flag.
PRCHECK, ECHOCH, BOUNDCH, CONVERCH, RESIDCH, RADREG,
IRAD: Determines whether or not several items useful in checking the analysis are
or are not printed to the case.info file. The default is no print for all of these
items.
ECHOCH
– /NOECHO/ECHO/. Echoes the input data for a STAR
analysis.
BOUNDCH – /NOBOUN/BOUN/. Prints out information on all boundaries
and body forces.
CONVERCH – /NOCONV/CONV/. Prints out conservation and engineering
data checks at the end of every iteration.
10-18
RESIDCH
– /NORESI/RESI/. Prints out inner iteration residuals generated
in the equations being solved at the end of every iteration.
RADREG
– /NORADREG/RADREG,IRAD/. Prints out radiation heat
transfer information on a regionwise basis. IRAD is the
frequency (in terms of number of iterations or time steps) for
printing regionwise radiation heat transfer information.
Version 3.26
Chapter 10
CONTROL MODULE
PRFIELD, NC1(1), NC2(NC1), NCINC(1), LOPTION: Sets the values of the
cells at which field data will be printed in the solution phase.
NC1, NC2,
NCINC
– Cells numbered NC1 to NC2 by NCINC will be printed. NC1
may be replaced with NON (no printout of cells) or All (print
out all cells); in either of those cases, NC2 and NCINC will be
ignored.
LOPTION
– /NOUSER/USER/. If USER, user-specified data from
subroutine POSDAT will also be printed.
PRTEMP, OPTION: Sets the printed values of temperature either as absolute
values or relative to the datum temperature TDATUM.
OPTION
– /RELATIVE/ABSOLUTE/.
PRWALL, OPTION, /NAME1,FLAG1,NAME2,FLAG2,…,NAMEN,
FLAGN/: Specifies or lists what wall data to print at the end of a run.
OPTION
– LIST,OPTION2. Lists wall data NAMEs for ACTIVE or ALL
variables.
– OPTION2.
– ACTIVE (default). Lists wall data NAMEs and their
printing status in the following format:
Name
Definition
Status
SHEA
YPLU
…
…
Shear force
YPLUS
Y
Y
– ALL. Lists ALL wall variable NAMEs that can be printed.
– SPECIFY. Specifies which wall data to print.
Version 3.26
10-19
CONTROL MODULE
Chapter 10
Free Surface and Cavitation Controls
NAME1,
FLAG1,
NAME2,
FLAG2, …,
NAMEN,
FLAGN
– NAME1,NAME2,…,NAMEN. Wall print data name.
– FLAG1,FLAG2,…,FLAGN. Y/N flag.
RESDATA, MAXLOC(0), NPOST(10000): Controls both printing and post data
file writing of residuals.
MAXLOC
– If greater than 0, then the locations (cell numbers) of the
MAXLOC highest residuals for each variable will be printed.
NPOST
– Every NPOST iterations, all residuals for all variables will be
written to file (case.rpo). This file is identical in format to
the standard post transient data file (case.pstt) and can be
loaded into the POST module in exactly the same manner
(TRLOAD). This allows users to see the residual distribution
as easily as seeing the actual solution.
CAVITATION, STATUS: Deactivates/activates the cavitation using different
modelling options. The NUCLEI parameter is to set the cavitation nuclei
distribution option and it is only valid for the BTF model. The free surface model
should be switched on in order to activate the cavitation modelling.
10-20
Version 3.26
Chapter 10
CONTROL MODULE
STATUS
– OFF (default). Deactivates the cavitation model.
– ON,MODEL,STTIME(80),CAVSTEN(OFF),VAPMAX(0.95),
PLIMIT(ON). Activates the cavitation model.
– MODEL.
– BAROTROPIC. Barotropic model.
– BTF. Bubble two-phase model.
– RAYLEIGH. Rayleigh bubble equation model.
– USER. User specified model in subroutine sorsca.f.
– STTIME. Starting time step when the cavitation model is
activated. It is recommended that cavitation modelling
should start after the residuals for the pre-cavitation flow
have reached reasonably small values.
– CAVSTEN.
– OFF. The surface tension effect is not included.
– ON. The surface tension effect is included.
CAVSTEN is applicable only to the barotropic and Rayleigh
models; it has no effect if any other model is used. Surface
tension in cavitation is considered on the basis of cavitation
nuclei and is different from the interface surface tension
effects in a general free surface model. However, the surface
tension coefficient is the same as the one specified by
command STENSION.
– VAPMAX. Specifies the maximum volume fraction of
vapour. This value should not be larger than 0.98.
– PLIMT. An option for determining whether or not to restrict
the lowest pressure in the flow to vapour pressure after
cavitation takes place. If PLIMT is OFF, the limiter will not
be applied.
The difference between the BTF and RAYLEIGH models is that the former needs
nuclei distribution, while the latter does not.
When cavitation is switched on:
(a) A passive scalar named VOF should be defined automatically by
pro-STAR, if it is not defined already by the user.
(b) An active scalar called ‘CAV’ always needs to be defined. Molecular
properties for vapour are assigned using that scalar. In cavitation
modelling, the liquid must be assigned to material number 2.
CAVNUCLEI, OPTION: Defines properties for modelling the formation of nuclei
during cavitation.
Version 3.26
10-21
CONTROL MODULE
Chapter 10
OPTION
– CONSTANT,NNUCLEI(1.0E+7),RNUCLEI(5.0E-6). Values
for cavitation nuclei are defined as constants.
– NNUCLEI. Number of nuclei in a volume of one cubic meter
(only used by the BTF and Rayleigh models).
– RNUCLEI. Either the average radius of cavitation nuclei
(barotropic and Rayleigh models), or the equilibrium radius
of the cavitation nuclei under user-defined reference
conditions.
– USER. Values for cavitation nuclei defined through user
subroutine CAVNUC.
CAVPROPERTY, /CONSTANT, SOUNDL(1450.0), SOUNDV(340.0),
CAVSVP(2370.0)/USER/: Defines properties of the cavitation model.
OPTION
– CONSTANT (default). Properties, such as speed of sound in
liquid (SOUNDL), speed of sound in vapour (SOUNDV) and
saturated vapour pressure (CAVSVP), are defined as constants.
– USER. Properties are defined through user subroutine
CAVPRO.
FSDSCHEME, IFSDIFF(1), FACTOR(1.0), ROMIT(0.02): Defines the
differencing scheme for solving the VOF transport equation.
IFSDIFF
– A value which indicates the differencing scheme used. A value
of 1 is for the compressive scheme, and a value of 2 is for the
upwind scheme. The compressive scheme is generally better at
maintaining the sharpness of the heavy/light fluid interface.
FACTOR
– A blending factor for the differencing scheme.
ROMIT
– Specifies the region where the Courant number restriction (see
command FSVOF) can be omitted. In the flow region, if
|GRAD(VOF)/MAX(GRAD(VOF))| < ROMIT
the Courant number restriction MAXCOUR (used in solving
the VOF transport equation) is omitted.
10-22
Version 3.26
Chapter 10
CONTROL MODULE
FSMASSTR, STATUS: Activates/deactivates the mass transfer computation in
free surface flows.
STATUS
– OFF (default). Deactivates the mass transfer computation.
– ON,DIFFUSIVITY(3.004E-5),MASSFRAC(2.0E-5),
SATDG(0.8). Activates the mass transfer computation.
– DIFFUSIVITY. The diffusivity of the light fluid in the heavy
fluid.
– MASSFRAC. The mass fraction of the dissolved gas in the
heavy fluid under reference conditions.
– SATDG. The degree of saturation of the dissolved gas at the
initial state.
When mass transfer in free surface flow is selected, an additional passive scalar
named MFDG (Mass Fraction of Dissolved Gas) should be defined.
FSSUBCYCLE, STATUS: Sets the free surface subcycling.
STATUS
– ON,NSUBC(20),NSUBC1(1). Turns subcycling on. NSUBC
is the number of allowed subcycles and NSUBC1 is the
number of subcycles in the first time step (both should not be
greater than 50). When the sub-cycling feature is switched on,
the solver will use the Courant number criterion to determine
the actual subcycles needed in each time step. If this actual
number exceeds the user specified number, the code will
reduce the time step size to ensure that this maximum number
is not exceeded.
– OFF,MAXT(1.1). Turns subcycling off. MAXT is the
maximum time step increase (must be from 1.0 to 1.5).
FSURFACE, STATUS: Activates/deactivates free surface modelling.
STATUS
– OFF (default). Turns free surface modelling off.
– ON,STEN(OFF). Turns free surface modelling on. STEN
specifies whether or not the surface tension force should be
included in the model (OFF — surface tension model is off,
ON — surface tension model is on).
Notes for free surface modelling:
1. The light fluid material properties are defined as material 1, and the heavy
fluid material properties are defined as material 2.
Version 3.26
10-23
CONTROL MODULE
Chapter 10
2. All fluid cells must have material number 1. The initial fluid in a cell (light or
heavy) is defined using the FSMAT option in the CTABLE command. If the
light/heavy option is not defined by the user, the default (light) option will be
used.
3. When there are more than two fluids in the flow, the light and heavy fluid
already defined become background fluids. All other fluids presented should
be defined as active scalars.
4. The extra active scalars (if any) should be distinguished as either heavy or
light scalars using command SC.
5. The contact angle (see command STENSION) will take effect only when
surface tension effects are considered.
6. It is permissible to model the interface between two immiscible liquids, where
one is defined as heavy material, and the other as the light material.
FSVOF, NCORR(5), MINVAL(–1.0E–4), MAXCOUR(0.3): Sets values for free
surface VOF solution.
NCORR
– Number of correctors for solution of VOF (must be from 1 to
50).
MINVAL
– The minimum unbounded negative value.
MAXCOUR – Maximum Courant number for VOF (must be from 0.05 to
0.3).
STENSION, OPTIONS, STENCOE(0.0727), CONTANG(90.0): Defines the
surface tension properties of heavy fluid for use in free surface and cavitation
modelling.
OPTIONS
– CONSTANT. Uses constant values for surface tension
coefficient and contact angle.
– USER. Subroutine FSTEN will be used to specify the
surface tension coefficient and the contact angle.
STENCOE(0.0727) – Surface tension coefficient.
CONTANG(90.0)
– The angle between the heavy/light fluid interface normal
and the wall normal at a point on a solid wall. This
parameter is not used when modelling surface tension
effects in cavitation problems.
10-24
Version 3.26
Chapter 10
CONTROL MODULE
VAPORIZATION, STATUS: Activates/deactivates the evaporation/boiling/
condensation computation in free surface flows.
STATUS
– OFF. Deactivates the vaporisation computation.
STATUS
– ON,TYPE,MODEL,NPHASE(2),VAPPRO,NUCDEN(1.0E7),
FBAREA(0.5),TSAT(373.15),PVSAT(1.013E5),
EVAHEAT(2.257E+6). Activates the vaporisation
computation, where:
– TYPE. Vaporisation type: BOILING (default) or
EVAPORATION.
– MODEL. Parameter for calculating the vaporisation/
condensation rate: STANDARD (default) or USER.
– NPHASE. Number of phases involved in the flow. Takes an
integer value of 2 (liquid and vapour only) or 3 (liquid, gas
and vapour).
– VAPPRO. Parameter specifying the option for calculating the
vaporisation properties (TSAT,PVSAT,EVAHEAT):
– CONSTANT. Constant values are specified.
– WATERVAPOR. Variable properties calculated from
water-steam tables will be used.
– USER. Properties are specified in user routine CAVPRO.
– NUCDEN - Number density of nuclei in the liquid (1/m3).
– FBAREA. Fraction of bubble surface area exposed to
convective heat transfer due to relative motion.
– TSAT. For boiling, it is the boiling temperature. For
evaporation, it serves as a saturation temperature
corresponding to PVSAT (K).
– PVSAT. Saturation vapour pressure corresponding to TSAT.
– EVAHEAT. Heat of vaporisation.
When option STANDARD is chosen, the vaporisation rate will be calculated using
the default model. When option USER is chosen, the vaporisation rate will be
calculated through user subroutine FSEVAP.
When VAPPRO is set to CONSTANT, the user-specified values of TSAT,
PVSAT and EVAHEAT will be used. Otherwise, they will be treated as reference
values.
When vaporisation is on, an active scalar called EVAP needs to be defined.
WHEATTR, STATUS: Activates/deactivates wall heat transfer modelling due to
boiling.
Version 3.26
10-25
CONTROL MODULE
Chapter 10
STATUS
– OFF. Deactivates wall heat transfer modelling.
– ON,REYNO(2.0E5),DHYD(0.4),BCANGLE(45.0),
COEHTR(0.023),DBMIN(1.0E-5). Activates wall heat
transfer modelling.
– REYNO. Characteristic Reynolds number.
– DHYD. Characteristic length scale (m) (e.g. pipe diameter).
– BCANGLE. Bubble contact angle at the wall (degrees).
– COEHTR. Single-phase convective heat transfer correlation
coefficient (for pipe flow COEHTR = 0.023; for flow on flat
plate, COEHTR = 0.0366).
– DBMIN. Minimum diameter of active nuclei (m).
The wall heat transfer treatment will be effective for all walls under the following
conditions:
1.
2.
3.
4.
10-26
Free surface feature is activated.
Boiling model is on.
The wall is wetted by the liquid in question.
A fixed wall temperature is specified, whose value is greater than the boiling
temperature.
Version 3.26
Chapter 11
TRANSIENT MODULE
Chapter 11
TRANSIENT MODULE
CDTRANS, LF(case.trnc): Saves all transient load data in coded format,
typically to transfer the data to another computer with a binary data representation
that is incompatible with the current computer.
LF
– File name on which to write out the data.
CPOST, OPTION: Defines which cell data items are to be written to the transient
post file every NPOF time steps (see command LSTEP) during this load step.
OPTION
– LIST (default). Lists the setting for each variable.
– VARIABLE,/Y/N/. Sets a variable to be written (Y) or not to
be written (N) to the transient post file. Valid VARIABLES
are: ALL (to set all variables), LU, LV, LW, LP, LKE, LEPS,
LV22, LF22, LT, LVIS, LDEN, LLAM, LCP, LCON, LFLUX,
LVOID, LUU, LVV, LWW, LUV, LVW, or LUW.
LEPS is used for V t in the Spalart-Allmaras model or ω in the k-ω models.
CPRANGE, NC1(1), NC2(NC1), NCINC(1): Defines the range of cells for which
data selected with the CPRINT command will be printed every NPRF time steps
(see command LSTEP) and is valid for all load steps.
NC1, NC2,
NCINC
– Prints selected data for cells NC1 to NC2 by NCINC.
CPRINT, OPTION: Defines which cell data items are to be printed every NPRF
time steps (see command LSTEP) during this load step.
Version 3.26
11-1
TRANSIENT MODULE
Chapter 11
OPTION
– LIST (default). Lists the setting for each variable.
– VARIABLE,/Y/N/. Sets a variable to be printed (Y) or not to
be printed (N). Valid VARIABLES are: ALL (to set all
variables), LCON, LCP, LDEN, LEPS, LF22, LKE, LLAM,
LP, LT, LU, LUU, LUV, LUW, LV, LV22, LVIS, LVOID, LVV,
LVW, LW, or LWW.
LEPS is used for V t in the Spalart-Allmaras model or ω in the k-ω models.
DELTIME,OPTION1: Defines the time step (DT) calculation method in the time
units specified by command TRELATION.
OPTION1
11-2
– CONSTANT,TSTARt(0),DT(0.001). Starting from analysis
time TSTARt, use a constant time step given by DT. If a
TSTARt that is less than any previous TSTARts is given, then
the previously defined periods will be overwritten and removed
from the period definition.
Version 3.26
Chapter 11
TRANSIENT MODULE
OPTION1
– VARIABLE,TSTARt(0),DTINitial(1.0E-3),DTMAX(1),
DTMIN(1E-5),OPTION2. Starting from analysis time
TSTART, the value of time step DT is DTINitial, then DT is
calculated using the method given by OPTION2 subject to the
constraints given by DTMAX and DTMIN. If a TSTARt that is
less than any previous TSTARTs is given, then the previously
defined periods will be overwritten and removed from the
period definition.
– DTMAX. Upper limit of DT.
– DTMIN. Lower limit of DT.
– OPTION2.
– DTRATIO,RATIO(1.1). DT varies with a constant ratio.
The DT relationship between time step I+1 and time step I
is:
DT(I+1) = DT(I)*RATIO
– The value of RATIO determines the rate at which DT
increases (RATIO > 1) or decreases (RATIO < 1).
– MAXC,MaxCourantNumber(500). DT keeps the same
value as its preceding time step until the maximum cell
Courant number exceeds the specified
MaxCourantNumber, then the DT of time step I+1 is
calculated from the DT of time step I and the Courant
number as:
DT(I+1) = MaxCourantNumber/
(Actual Maximum Courant Number)*DT(I)
– MAAV,AveCourantNumber(100). DT keeps the same value
as its preceding time step until the average Courant number
exceeds the specified AveCourantNumber, then the DT of
time step I+1 is calculated from the DT of time step I and
the Courant number as:
DT(I+1) = AveCourantNumber/
(Actual Average Courant Number)*DT(I)
– LIST. Lists the TSTART value and DT calculation option
for all time periods already defined.
– DELETE,TSTART(0). Delete a specified time period that
begins at TSTART.
– USER. DT is calculated by user coding in subroutine
DTSTEP.
– TABLE,TBNAME. A table stored in file TBNAME is used
to specify DT. The table is in standard table format. The
independent variable is time, the dependent variable is DT
(both in current time units). The DT value between
successive points in the table is computed by linear
interpolation.
Version 3.26
11-3
TRANSIENT MODULE
Chapter 11
HELP
or
LSCOMPRESS: Compresses out all deleted load step definitions from the
transient history file.
LSDELETE, LS: Deletes a given load step from the transient history file.
LS
– Load step number to delete.
LSGET, LS(1): Restores a set of transient options and boundary specifications that
had previously been saved on the transient history file.
LS
– Load step number of the set of options to restore.
LSLIST, LS1(1), LS2(LS1), LSINC(1): Lists the major parameters stored for each
load step defined on the transient history file.
LS1, LS2,
LSINC
– Lists load steps LS1 to LS2 by LSINC.
LSRANGE, LSSTRT(1), LSFIN (last defined load step): Defines the range of
load steps on the transient history file that the user wishes to run through in the next
11-4
Version 3.26
Chapter 11
TRANSIENT MODULE
STAR analysis run.
LSSTRT
– Starting load step number for the next analysis run.
LSFIN
– Final load step number for the next analysis run.
LSSAVE, LS: Saves all current transient options and boundary specifications to the
transient history file.
LS
– Load step number assigned to this set of options.
LSTEP, LS, NTSTEP(1), TIMEOPT, DT, LRAMP(N), NPRF(0), NPOF(0):
Defines basic load step parameters.
LS
– Load step identifying number.
NTSTEP
– Number of time steps during this load step.
TIMEOPT
– CONSTANT. The time increment (DT) is constant for this load
step.
– USER. The time increment can be varied in user subroutine.
DTSTEP. DT is the default value.
DT
– Time increment for the current load step.
LRAMP
– If true (Y), ramp boundary conditions linearly from previous
load step, otherwise step change conditions. The first load step
must step change. The ramp condition cannot be chosen if a
user subroutine is specified.
NPRF
– Data print frequency. If NPRF = 0, then no data are printed
during this load step. If NPRF = NTSTEP, then data are
printed once at the end of the load step.
NPOF
– Data post frequency. If NPOF = 0, then no data are written to
the transient post file during this load step. If
NPOF = NTSTEP, then data are written to the transient post
file once at the end of the load step.
MVGRID, STATUS, EVSTATUS, PROGRAM: Turns on/off flags within
Version 3.26
11-5
TRANSIENT MODULE
Chapter 11
STAR which allow/disallow various types of grid movements/operations within a
transient analysis.
STATUS
– OFF (default). No grid motion of any type allowed. The
EVSTATUS and PROGRAM options are ignored.
– ON. Grid motion is allowed. The grid motion will be
accomplished using the NEWXYZ subroutine or using a mesh
motion application specified with the PROGRAM option. In
the latter case, user subroutine NEWXYZ is still called after
the mesh motion application.
EVSTATUS – NOEVENT (default). Connectivity changes are not allowed.
The PROGRAM option is ignored.
– EVENT. Connectivity changes are allowed.
PROGRAM
– PROSTAR (default). Mesh motion during the STAR run will
be calculated using pro-STAR. A file named mvmesh.sh,
which is used for communication between STAR and
pro-STAR, will be created when the PROBLEMWRITE
command is issued.
– NONE. Mesh motion is to be done with user subroutine
NEWXYZ alone.
– <Program Name>. Name of the program used to move the
mesh. The only currently valid program name other than
PROSTAR is ESICE. (Note that the entire program name, not
just the first four letters, must be entered.)
PRPOST, PHASE, OPTION1, OPTION2: Specifies or lists what cell and wall
post data to print and how often. The phase number, as used in Eulerian multiphase
flow problems, is also specified here. However, this parameter does not relate to the
discrete phases used in Lagrangian multiphase analyses.
11-6
PHASE
– Phase number. For single-phase flow, PHASE must be equal to
1. For Eulerian multiphase analysis, PHASE can be 1 or 2.
OPTION1
– LIST. Lists cell and wall data that can be printed and how often
to print the chosen data.
Version 3.26
Chapter 11
TRANSIENT MODULE
OPTION1
– OPTION2.
– NAMES,/ALL/CELL/WALL/. Lists the post data variable
NAMEs:
– ALL. All the post data NAMEs including CELL and
WALL post data.
– CELL. Cell post data only.
– WALL. Wall post data only.
– STATUS. Displays the current printed-output time period
definitions as specified by PRPOST,SPECIFY.
– SPECIFY. Specifies when to print which cell/wall post data.
– OPTION2.
– TSTART,TINTVAL,NAME1,FLAG1,NAME2,FLAG2,
…,NAMEN,FLAGN. Defines the parameters of a
printed-data output period in terms of:
– TSTART. Starting time (in current time units).
– TINTVAL. Time interval at which data are printed (in
current time units).
– NAME1,NAME2,…,NAMEN. Post data name.
– FLAG1,FLAG2,…,FLAGN. Y/N flag signifying whether
the preceding variable will be printed. All flags are
automatically set to N at the beginning of the analysis.
Each printed- data period inherits the items selected for its
predecessor, unless cancelled by a N flag.
Available post data variable NAMEs can be listed using
PRPOST,LIST. The NAMEs do not have to be in any
particular order.
– DELETE. Deletes a post-data-output time period specified
using this command.
– OPTION2.
– TSTART. Specifies which data-output time period is to be
deleted.
RUNTIME, OPTION, DATA: Specifies the run time length (in the current time
units defined by command TRELATION).
OPTION
– DURAtion. The run time length is determined by duration.
– ENDTime. The run time length is determined by the end time,
i.e. as soon as the analysis time exceeds the ENDTime the run
will stop.
DATA
– Value of either DURAtion or ENDTime.
Version 3.26
11-7
TRANSIENT MODULE
Chapter 11
SCTRANS, OPTION, NSC1(1), NSC2(MAXSCL), STATUS: Tells STAR
which additional scalar data to print and/or write on the transient post file (which
was connected using the TRLOAD command).
OPTION
– CPRINT. Prints cell data.
– CPOST. Puts cell data on the transient file.
– WPRINT. Prints wall (surface) data.
– WPOST. Puts wall (surface) data on the transient file.
NSC1, NSC2 – The option selected applies to scalars NSC1 to NSC2.
STATUS
– /Y/N/ to turn on or off the given item.
STATUS: Displays the status of all TRANSIENT settings.
TDSCHEME, OPTION: Sets the temporal discretisation scheme on all
transported variables.
OPTION
– IMPLICIT. First order implicit scheme.
– CRNICHOLSON, BLEND(1.0). Higher order
Crank-Nicholson scheme. BLEND is the blending factor.
TRELATION, OPTION, DATA: Defines a time-dependent variable, such as
angular position in turbomachinery or crank angle in reciprocating engine
applications, and its relationship to time (in seconds). The new variable is then used
in specifying time-related parameters, such as time steps. If this command is not
issued, the default time variable is time in seconds.
OPTION
– TSEC (default). Time variable is time in seconds.
– THETA. Time variable is angular position in degrees.
DATA
– Parameters defining the time variable relationship to time
expressed in seconds. For OPTION = TSEC, no additional
parameter is needed. For OPTION = THETA, two parameters
are required:
– RPM. Rotating speed (revolutions per minute).
– THETA0. Initial angular position (degrees) at time = 0.
The relationship between THETA and time in seconds is:
TSEC = (THETA–THETA0)/(RPM*6).
11-8
Version 3.26
Chapter 11
TRANSIENT MODULE
TRFILE, FOPT, LF(case.trns), MAXSTP(10): Initialises a transient history
data file or reconnects to a previously defined file. This file contains a record of all
load steps which together define a set of transient boundary conditions. As long as
a transient history file is connected to the session, the user may not add or delete
boundary region definitions. The user may redefine currently existing regions.
FOPT
– INITIALIZE. To set up a new file or completely erase an old
one.
– CONNECT. To reconnect to a previously defined file.
– CLOSE. To disconnect from a data file.
LF
– Name of the transient file.
MAXSTP
– Maximum load step to be defined on this file. This determines
the initial size of the transient history file. It may be re-sized at
any time by using the CONNECT option of this command
with a new MAXSTP.
WPOST, LFXYZ, LTHERM, LYPLUS: Defines the list of wall data items to be
written to the transient history post file every NPOF time steps (see command
LSTEP) during this load step. Two forms of this command can be used. The user
can type ‘WPOST,Y,Y,N’ in order to change all the settings in one line.
Alternatively the user may type ‘WPOST,LFXYZ (or any other variable name), Y
(or N)’ to change the value of a single parameter. LFXYZ refers to the three wall
shear forces. LTHERM refers to all temperature-related wall quantities
(temperature, heat flux, radiation data, etc.) and LYPLUS refers to values for y-plus
and distance.
LFXYZ,
LTHERM,
LYPLUS
setting.
WPRINT, LFXYZ, LTHERM, LYPLUS: Defines the list of wall data items to be
printed every NPRF time steps (see command LSTEP) during this load step. Two
forms of this command can be used. The user can type ‘WPRINT,Y,Y,N’ in order
to change all the settings in one line. Alternatively the user may type
‘WPRINT,LFXYZ (or any other variable name), Y (or N)’ to change the value of a
single parameter. LFXYZ refers to the three wall shear forces. LTHERM refers to
all temperature-related wall quantities (temperature, heat flux, radiation data, etc.)
and LYPLUS refers to values for y-plus and distance.
Version 3.26
11-9
TRANSIENT MODULE
Chapter 11
LFXYZ,
LTHERM,
LYPLUS
setting.
WRPOST, PHASE, OPTION1, OPTION2: Specifies or lists what cell and wall
post data to write to the transient post file and how often. The phase number, as used
in Eulerian multiphase flow problems, is also specified here. However, this
parameter does not relate to the discrete phases used in Lagrangian multiphase
analyses.
11-10
PHASE
– Phase number. For single-phase flow, PHASE must be equal to
1. For Eulerian multiphase analysis, PHASE can be 1 or 2.
OPTION1
– LIST. Lists cell and wall data that can be written to the
transient post file and how often to write the chosen data.
– OPTION2.
– NAMES,/ALL/CELL/WALL/. Lists the post data variable
NAMEs:
– ALL. All the post data NAMEs including CELL and
WALL post data.
– CELL. Cell post data only.
– WALL. Wall post data only.
– STATUS. Displays the current data-output time period
definitions as specified by WRPOST,SPECIFY.
– SPECIFY. Specifies when to write which cell/wall post data to
the transient post file.
Version 3.26
Chapter 11
TRANSIENT MODULE
OPTION1
– OPTION2.
– TSTART,TINTVAL,NAME1,FLAG1,NAME2,FLAG2,…,N
AMEN, FLAGN. Defines the parameters of a data-output
time period in terms of:
– TSTART. Starting time (in current time units). This can
only be defined for phase 1; other phases take the same
value as phase 1.
– TINTVAL. Time interval at which data are successively
written to the transient post file (in current time units). This
can only be defined for phase 1; other phases take the same
value as phase 1.
– NAME1,NAME2,…,NAMEN. Post data name.
– FLAG1,FLAG2,…,FLAGN. Y/N flag signifying whether
the preceding variable will be written to the .pstt file.
Flags SU, SV, SW and P are automatically set to Y at the
beginning of the analysis. All other flags are set to N. Each
data-output period inherits the items selected for its
predecessor, unless cancelled by a N flag.
Available post data variable NAMEs can be listed using
WRPOST,LIST. The NAMEs do not have to be in any
particular order.
– DELETE. Deletes a post-data-output time period specified
using this command.
– OPTION2.
– TSTART. Specifies which data-output time period is to be
deleted.
Version 3.26
11-11
Chapter 12
DROPLETS MODULE
Controls
Chapter 12
DROPLETS MODULE
Controls
DAGE, LFD(case.trk): Evaluates the age of all currently loaded droplets based
on information from the droplet track file. Droplet age is a measure of how long a
droplet has been in the domain relative to the time the first droplet entered the
domain. If a droplet has already evaporated or exited the model, droplet age is
measured until the time when it has done so.
LFD
– Droplet track file name.
DINTERPOLATION, OPTION: Defines an interpolation method used to
evaluate the continuous-phase temperature, velocity and species mass fraction at
droplet locations.
OPTION
– GRADIENT (default). Uses the gradient of the
continuous-phase quantities to determine values at the droplet
location.
– VERTEX. Uses values interpolated at the cell vertices to
calculate values at the droplet location.
– CELL. Uses the cell values, neglecting any variation in the
continuous-phase fields across the cell.
DLIST, NDR1, NDR2, NDRINC(1), OPTION: Lists information about a range
of droplets.
NDR1, NDR2, – The range of droplets to be listed is NDR1 to NDR2 by
NDRINC
NDRINC. Using DCRS will list cells by enabling cursor
picking.
OPTION
Version 3.26
– COORDINATE (default). Lists the coordinates and velocity
of the droplets.
– AGE. Lists the age of the droplets. Droplet ages must first be
loaded using the DAGE command.
12-1
DROPLETS MODULE
Chapter 12
Controls
OPTION
– OTHER. Lists the density, diameter, mass, count and
temperature of the droplets.
DRAVERAGE, STATUS: Sets a flag to calculate and pass droplet average
properties to the user through the user routine dravrg.f at the end of each
sub-cycle.
STATUS
– /OFF/ON/.
DREAD, LF(case.drpc): Reads droplet parcel data in from a coded file.
LF
– File name from which to read in parcel definitions. The first 32
lines of this file contain the data which define droplet types.
These are followed by parcel initial conditions in format
(I8,1X,I2,1X,5(G13.6,1X),5(G13.6,1X),I3,I5,1X,G13.6). The
data are: the parcel number, parcel type, number of droplets in
this parcel, droplet initial diameter, density and temperature,
three initial coordinates, three initial velocity components, the
load step at which the parcel will be injected, the coordinate
system number for velocities and the rotational speed. These
data are listed in the same order by command DINLIST.
DRNPROCEDURE, OPTION: Defines a numerical procedure for the two-phase
Lagrangian calculation.
OPTION
– STANDARD,FACT(0.35) (default). The spray sources are
calculated in the predictor and each PISO corrector stage and
under-relaxed by a specified under-relaxation factor FACT.
– PREDICTOR_ONLY. The spray sources are calculated only in
the predictor stage and are kept constant in the PISO
correctors. The under-relaxation factor is not used.
DRPMODE, STATUS, OPTION: Determines the method of specifying parcel
12-2
Version 3.26
Chapter 12
DROPLETS MODULE
Controls
initial conditions in Lagrangian two-phase flow calculations.
STATUS
– /SPRAY/EXPLICIT/USER/.
– SPRAY. Sets up spray calculations using built-in atomisation
models.
– EXPLICIT.Specifies parcel injection using either velocity
components or nozzle parameters, along with a variety of
entrance location options.
– USER.Uses subroutine DROICO to specify all initial
conditions.
OPTION
– /2D,ANGLE/3D/. If option SPRAY is selected, this sets a 2D
or 3D analysis mode.
– ANGLE. Angle (degrees) of axisymmetric mesh geometry.
DRPOST, MAXFILE(60.), MAXTIME(100.): Defines droplet post file
characteristics.
MAXFILE
– Maximum size (in megabytes) of the droplet trajectory file.
MAXTIME
– Maximum tracking time.
DTIME, TMIN(0.0), TMAX(1.0E+30): Selects the time range for droplet track
plots. The droplets in the droplet set will be plotted only at the locations visited
within this time range. This command affects only the plotting of droplets loaded
from a droplet track file. Note that this information is not saved in the model file.
TMIN
– Lower bound of time range.
TMAX
– Upper bound of time range.
DRUSER, STATUS: Activates user coding for parcel injection, in conjunction
with either the SPRAY or EXPLICIT option of command DRPMODE. If option
USER is already set in DRPMODE, this command will have no effect.
STATUS
– /ON/OFF/.
Version 3.26
12-3
DROPLETS MODULE
Chapter 12
Controls
DWRITE, LF(case.drpc): Writes droplet data to file LF.
LF
– File name to which droplet information is written.
EXIT: Returns to the PRO Module.
HELP
or
detailed information about a specific command within the module.
STATUS, IDTY (current droplet type number): Displays the status of all
two-phase Lagrangian settings for droplet type number IDTY.
IDTY
– Droplet type reference number.
STPA, IBEGIN(0), PURF(0.0): Defines the iteration number when averaging is to
begin and the particle under-relaxation factor for coal combustion problems.
IBEGIN
– Iteration number at which to start averaging.
PURF
– Particle under-relaxation factor.
TPHL, STATUS, OPTION, COURANT(0.35): Turns two-phase Lagrangian
calculations on or off (default) and specifies whether the process is coupled (the
dispersed and the continuous phases influence each other) or uncoupled (only the
continuous phase influences the dispersed one).
STATUS
– /ON/OFF/
OPTION
– /COUPLED/UNCOUPLED/
COURANT
– Courant number. The number varies from 0 to 1.
12-4
Version 3.26
Chapter 12
DROPLETS MODULE
Parcel Properties
Parcel Properties
DINLIST, NDR1(1), NDR2(NDR1), NDRINC(1): Lists the initial conditions for
a set of droplet parcels.
NDR1,
NDR2,
NDRINC
– Lists parcels NDR1 to NDR2 by NDRINC.
DMAX, NDRMAX(100): Sets the maximum number of droplet parcels.
NDRMAX
– Maximum number of droplet parcels. Must be greater than or
equal to 1.
DRCOMPRESS: Compresses out unused or deleted droplet parcels.
DRCREATE, OPTION: Creates and manipulates sets of parcel initial positions
(injection points) using vertices previously defined with other commands. Unit
vector components are also specified using this command. Note that the sets created
using this command will belong only to the current injection group (IGROUP). Sets
can be copied to other IGROUPs using the command DRSDUPLICATE.
Version 3.26
12-5
DROPLETS MODULE
Chapter 12
Parcel Properties
OPTION
12-6
– ADD,SOPT,TYPE,/DX,DY,DZ,ICS1(1)/NORM/RELATIVE,
ANGLE/. Adds a set to the end of the current list.
– SOPT. /CURSOR/COORDINATE/. Use the cursor to select
from the plot screen or specify the screen coordinates. This
option does not apply when TYPE is BREGION, BSET,
VSET or VRANGE.
– TYPE.
–POINT,ICSYS,XP,YP,ZP. Creates a set containing a single
injection point. For option CURSOR, the crosshairs will
appear and a point on the model should be selected. For
option COORDINATE, XP, YP, ZP are the X, Y, Z
coordinates of the point in coordinate system ICSYS.
–LINE,/NVERT/NVERT,ICSYS,XP1,YP1,ZP1,XP2,YP2,
ZP2/. Creates a set of NVERT injection points between two
points in space. For option CURSOR, the crosshairs will
appear and two points on the model should be selected. For
option COORDINATE, XP1, YP1, ZP1 are the X, Y, Z
coordinates of point 1 and XP1, YP2, ZP2 are the X, Y, Z
coordinates of point 2 in coordinate system ICSYS.
–CIRCLE,/NVERTR,NVERTT/NVERTR,NVERTT,ICSYS,
ZCOORD,RADIUS/. Creates a set of injection points
where NVERTR and NVERTT are the number of points in
the radial and angular direction, respectively. For option
CURSOR, the centroid and a point on the circumference of
the circle should be selected. For option COORDINATE,
the RADIUS of the circle and the Z coordinate of its centre
in coordinate system ICSYS should be specified.
–RECTANGLE,/NVERTX,NVERTY/NVERTX,NVERTY,
ICSYS,ZCOORD,XCMIN,XCMAX,YCMIN,YCMAX/.
Creates a set of injection points where NVERTX and
NVERTY are the number of points in the X and Y
direction, respectively. For option CURSOR, two points on
the screen should be selected to form a rectangle. For
option COORDINATE, XCMIN, XCMAX are the
minimum and maximum X coordinates and YCMIN,
YCMAX are the minimum and maximum Y coordinates at
the rectangle’s Z coordinate in coordinate system ICSYS.
–BREGION,NB1,NB2. Creates a set of injection points from
region NB1 to region NB2.
–BSET. Creates a set of injection points from the current
BSET.
–VSET/VRAN,NV1,NV2,NVIN/. Creates a set of injection
points from the current VSET or for a range of vertices
from vertex NV1 to NV2 by NVIN.
Version 3.26
Chapter 12
DROPLETS MODULE
Parcel Properties
OPTION
– DOPT.
–/CONSTANT,DX,DY,DZ,ICS1(1)/NORM/
/RELATIVE,ANGLE/. The injection direction may be
specified using unit vector components DX, DY, DZ in
coordinate system ICS1. If TYPE is CIRCLE, the injection
direction can also be specified as RELATIVE, which
means that parcels are injected at a fixed ANGLE relative
to the normal to the plane of the circle. If TYPE is
RECTANGLE, BREGION or BSET, the entrance direction
can also be specified as NORM, which means that parcels
will be injected normal to the cell face on which the parcel
lies.
– MODIFY,ISET,DX,DY,DZ,ICS1(1). Redefines DX, DY and
DZ for set ISET in coordinate system ICSYS.
– DELETE,ISET1,ISET2. Deletes sets ISET1 to ISET2.
– PLOT,ISET1,ISET2. Plots injection positions and directions
(using unit vectors) for ISET1 to ISET2. ISET1 can be
replaced by ALL, in which case all points for all sets in the
current IGROUP will be displayed.
DRDIAMETER, OPTION, VALUE1, VALUE2: Specifies the method of
calculating droplet diameters.
OPTION
– Choose the method for droplet diameter generation.
– CONSTANT. Constant diameter (default).
– ROSIN. Rosin-Rammler distribution.
– NORMAL. Normal function distribution.
– TABLE. User specified table.
VALUE1
– For OPTION = CONSTANT. Droplet diameter.
= ROSIN. Parameter X.
= NORMAL. Mean diameter.
= TABLE. File TBNAME containing the
user-specified distribution.
VALUE2
– For OPTION = ROSIN. Parameter q.
= NORMAL. Standard deviation.
DRGENERATE, NSET(2), NDR1(1), NDR2(IDR1), NDRINC(1), DD, DX,
DY, DZ, DU, DV, DW, DLSTEP, DCSYS, DOMEGA: Generates additional sets
of droplets with new initial conditions from a given starting set.
Version 3.26
12-7
DROPLETS MODULE
Chapter 12
Parcel Properties
NSET
– Generates NSET groups (including the starting set).
NDR1,
NDR2,
NDRINC
– Starting set is NDR1 to NDR2 by NDRINC.
DD
– Change in diameter to apply to each successive set.
DX, DY, DZ – Change in initial position to apply to each successive set. The
changes are interpreted in the currently active local coordinate
system.
DU, DV, DW – Change in initial velocity to apply to each successive set.
DLSTEP
– Change in load step (load step at which this droplet set is
released).
DCSYS
– Change in coordinate system of initial velocity vector for each
successive set. If the new calculated coordinate system will be
less than 1 or greater than 99, then it will be set to 1 or 99,
respectively.
DOMEGA
– Change in rotational speed to apply to each successive set.
DRGROUP, IGROUP(1), GRNAME: Selects a parcel injection group IGROUP
whose properties and behaviour can be defined or modified using appropriate
commands.
IGROUP
– Injection group number.
GRNAME
– Injection group name.
DRINITIAL, IDTYP, OPTION, VALUES, TINJ, MAS1, MAS2, SOI, EOI,
INPARC: Defines parcel injection conditions.
12-8
IDTYP
– Droplet type.
OPTION
– /EXPLICIT/NOZZLE/ (default EXPLICIT).
Version 3.26
Chapter 12
DROPLETS MODULE
Parcel Properties
VALUES
– /VMAG,ICSYS,OMEGA/ if OPTION is EXPLICIT, or
/DIAM,ICONE,ECONE/ if OPTION is NOZZLE, where:
– VMAG. Initial velocity magnitude.
– ICSYS. Coordinate system defining axis of rotation.
– OMEGA. Angular velocity.
– DIAM. Nozzle hole diameter.
– ICONE. Spray inner cone angle.
– ECONE. Spray outer cone angle.
TINJ
– Initial droplet temperature.
MAS1
– /GROUP/POINT/ (default is injection group). Mass flow rate
can be applied to the entire injection GROUP, or else to each
separate POINT within the group. (Note that points are
specified according to SETS.)
MAS2
– /FIXED,FLOWRATE/TABLE,TBNAME/ (default FIXED).
Mass flow rate can be a constant value given by FLOWRATE,
or else read from a user-defined table in file TBNAME.
SOI
– Start of injection (not required in steady state cases).
EOI
– End of injection (not required in steady state cases).
INPARC
– Number of parcels per injection point (per second).
DRSCALE, NDR1(1), NDR2(NDR1), NDRINC(1), SFX(1.0), SFY(1.0),
SFZ(1.0): Scales the initial position for a range of droplet definitions.
NDR1,
NDR2,
NDRINC
– Starting set is NDR1 to NDR2 by NDRINC.
SFX, SFY,
SFZ
– Scale factors to apply to the initial position of each droplet in
the range. Scaling is done in the currently active local
coordinate system.
DRSDUPLICATE, IGROUP1, ISET1, IGROUP2, ISET2: Copies set definition
ISET1 of IGROUP1 to ISET2 of IGROUP2. If IGROUP1 and IGROUP2 are
omitted, ISET1 will be copied to ISET2 of the current IGROUP. If IGROUP2 is
specified, but ISET2 is omitted, then a copy of ISET1 will be appended to the end
of the set list for IGROUP2. If IGROUP1 is omitted, but IGROUP2 is specified,
then ISET1 of the current IGROUP will be copied as required to IGROUP2.
Version 3.26
12-9
DROPLETS MODULE
Chapter 12
Spray Modelling
Spray Modelling
AMODEL, ATMOD: Specifies the atomisation model. The SPRAY option of
command DRPMODE must be selected before using this command.
ATMOD
– Atomization model
– REITZ
– HUH
– MPI1
– MPI2
FUEL, FUELTYPE, NOPT: Sets the fuel type present in droplets of the active
droplet type (single-component droplets), or sets the NOPTth droplet component to
the specified fuel type (multi-component droplets). Droplet or component
properties (e.g. density, surface tension, etc.) are then calculated internally by
STAR. This command takes precedence over properties specified via
DRPROPERTIES or DRCMPONENT.
FUELTYPE – /STANDARD/N-HEPTANE/N-DODECANE/HMN/.
NOPT
– For multi-component droplets, NOPT specifies the component
number. For single-component droplets, NOPT is ignored. The
fuel type is set for the active droplet type.
INJDELETE, INJ1(1), INJ2(INJ1), INJINC(1): Deletes a range of injectors.
INJ1, INJ2,
INJINC
– Deletes injectors INJ1 to INJ2 by INJINC. Keyword ALL may
be used in place of INJ1.
INJECTOR, INJ, DIAM, ICSYS(2), SBETA, PINOPT, SGAP, IDTYP,
MOPT, SOI, EOI, INPARC, TINJ: Specifies the injector parameters. The
SPRAY option of command DRPMODE must be selected before using this
command.
12-10
Version 3.26
Chapter 12
DROPLETS MODULE
Spray Modelling
INJ
– Injector number.
DIAM
– Injection hole diameter (must be greater than zero).
ICSYS
– Coordinate system of injector (must be cylindrical). Injector is
located at the origin of this system, aimed along its z-axis.
SBETA
– Injector cone angle.
PINOPT
– NOPINTLE. Injector is not pintle type.
– PINTLE. Injector is pintle type.
SGAP
– Pintle gap (only used for pintle injectors)
IDTYP
– Droplet type number for droplets from this injector.
MOPT
– FIXED,FLOWRATE. The mass flowrate is fixed and given by
FLOWRATE.
– TABLE,TBNAME. The mass flowrate is specified in a table of
time (seconds or degrees CA) versus fuel mass flow rate (kg
per second) stored in file TBNAME. The table must have a
minimum of two entries, the last one defining the end of
injection. The table data must have been defined using the
TBDEFINE command or other table-creation utility.
SOI
– Start of injection (seconds or degrees CA).
EOI
– End of injection (seconds or degrees CA); not required if
MOPT = TABLE.
INPARC
– Parcel injection rate (number of parcels per second).
TINJ
– Temperature (in Kelvin) of injected fuel.
INJLIST, INJ1(1), INJ2(INJ1), INJINC(1): Lists attributes of defined injectors.
INJ1, INJ2,
INJINC
– Lists injectors INJ1 to INJ2 by INJINC. Keyword ALL may be
used in place of INJ1.
NMODEL, NOZMOD, CDNZL, ZLOD, RCONTR, ROUGHN: Specifies the
nozzle model. The SPRAY option of command DRPMODE must be selected before
using this command.
Version 3.26
12-11
DROPLETS MODULE
Chapter 12
Droplet Models and Properties
NOZMOD
– Nozzle model.
– EFFE.
– MPI1.
– MPI2.
CDNZL
– Nozzle discharge coefficient; must be greater than 0 and not
greater than 1.
ZLOD
– Nozzle length/diameter ratio; must be greater than 0.
RCONTR
– Contraction ratio at the exit of nozzle; must be 0.00 to 1.0.
ROUGHN
– Roughness of nozzle interior surface.
DRBOIL, OPTION, TBOIL(380.0), TLEIDF(1000.0), CSFWL(0.0154):
Activates/deactivates the droplet boiling model.
OPTION
– OFF (default). Deactivates the droplet boiling model.
– ON. Activates the droplet boiling model.
TBOIL
– Boiling temperature (K).
TLEIDF
– Leidenfrost temperature. Only required when droplet-to-wall
heat transfer or the MPI wall interaction model has been
activated.
CSFWL
– Empirical surface coefficient. Only required when
droplet-to-wall heat transfer has been activated.
DRBREAKUP, MODEL: Activates the droplet breakup model and defines the
constants of the bag (WEBB,TSBB) and stripping (WESB,TSSB) breakup models.
MODEL
– OFF (default). Droplet break-up switched off.
– REITZ,WEBB(6.0),TSBB(3.14159),WESB(0.5),TSSB(20.0).
Reitz-Diwakar model activated.
– HSIANG,WEBB(6.0). Hsiang-Faeth model activated.
– PILCH. Pilch-Erdman model activated.
12-12
Version 3.26
Chapter 12
DROPLETS MODULE
DRCLIST, IDTY: Lists droplet component properties for a particular droplet type.
IDTY
– Droplet type number. The default is the current droplet type
number.
DRCMPONENT, NDRCOM(1): Specifies the number of components for a
droplet type and defines their physical properties. Mass transfer must be turned on
for the droplet type before this command can be used (see command DRMASS).
NDRCOM
– Number of droplet components.
The user will be prompted for: Scalar Number, Mass-Fraction, Specific Heat (at
constant pressure), Heat of Vaporisation, Pressure of Saturation (absolute) and
Component Name for each droplet component. If USER is specified for Scalar
Number, then this component evaporates to many scalars, and this is specified via
user coding. The sum of the mass-fractions for all the components must total 1.0.
DRHEAT, STATUS, USEROPT: The calculation of heat transfer between the
dispersed and continuous phase can be activated or deactivated by this command.
STATUS
– /ON/OFF/
USEROPT
– STANDARD (default). Heat transfer calculation based on
standard coding.
– USER. Heat transfer calculation specified in user subroutine
DRHEAT.
DRMASS, STATUS, USEROPT: The calculation of mass transfer between the
dispersed and continuous phase can be activated or deactivated by this command.
STATUS
– /ON/OFF/
USEROPT
– STANDARD (default). Mass transfer calculation based on
standard coding.
– USER. Mass transfer calculation specified in user subroutine
DRMAST.
Version 3.26
12-13
DROPLETS MODULE
Chapter 12
DRMOMENTUM, STATUS, DRVM(0.), SFAC(1.): Activates or deactivates
momentum transfer between the dispersed and continuous phases.
STATUS
– OFF. Momentum transfer is deactivated (default).
– STANDARD. The standard correlation is used.
– YUEN. The Yuen-Chen correlation is used.
– USER. Momentum transfer is defined in user subroutine
DROMOM.
DRVM
– Virtual mass coefficient.
SFAC
– Slip factor in a porous medium.
DRPROPERTIES, PROPOPT, USEROPT, VALUE: Defines droplet physical
properties for the active droplet type and the given PROPOPT.
PROPOPT
– DENS. Density.
– STCO. Surface tension coefficient.
– COND. Thermal conductivity (only required for problems
involving droplet-to-wall heat transfer).
– TCRI. Critical temperature.
– HOVA. Heat of vaporization.
– POSA. Saturation pressure.
USEROPT
– STANDARD. If PROPOPT = DENS, STCO, VISC, COND, or
TCRI, droplet bulk physical properties are constant. If
PROPOPT = CP, HOVA, or POSA, droplet component
physical properties are constant.
– USER. Bulk or component physical properties (except TCRI)
are variable and are defined by user subroutine DROPRO.
VALUE
– For PROPOPT = DENS, STCO, VISC, COND and TCRI, this
is the bulk density, surface tension coefficient, viscosity,
conductivity, or critical temperature, respectively. Default
values are 1000.0 for DENS, 0.02 for STCO, 1.0E–3 for VISC,
0.15 for COND and 650.0 for TCRI.
DRTDELETE, IDTY(1): Deletes a previously defined droplet type.
IDTY
12-14
– Droplet type ID.
Version 3.26
Chapter 12
DROPLETS MODULE
DRTYPE, IDTY(1), DRNAME: Selects a droplet type IDTY whose properties
and behaviour can be defined or modified using appropriate commands.
IDTY
– Droplet type number (between 1 and 10).
DRNAME
– Droplet name (optional).
DTYLIST, IDTY1, IDTY2, IDTYINC: Lists a set of droplet type definitions.
IDTY1,
IDTY2,
IDTYINC
– Lists droplet types IDTY1 to IDTY2 by IDTYINC.
DRWALL, STATUS(REBOUND): Defines droplet behaviour following a
collision with an obstacle (wall, fluid-solid or fluid-porous medium interface). This
command replaces the old DRBOUNCE command.
STATUS
– REBOUND. Droplet rebounds perfectly from the obstacle.
– USER. Droplet behaviour regarding momentum, heat and
mass transfer is defined by the user coding.
– STICK,WHTOPT(OFF). Droplet sticks to the obstacle. If
WHTOPT is ON, droplet-to-wall heat transfer modelling will
be activated.
– EVAPORATE. Droplet evaporates instantaneously.
– MPI,NDRSPL(2),TLEIDF(1000.0). Droplet behaviour
regarding momentum, heat and mass transfer is defined by
MPI model. NDRSPL is the number of new droplets created
during splashing and TLEIDF the Leidenfrost temperature.
– BAI, BAICOE1(1.0E-6),BAICOE2(0.7),BAICOE3(1320.0),
WHTOPT(OFF). Droplet behaviour regarding momentum,
heat and mass transfer is defined by Bai’s model. BAICOE1,
BAICOE2, BAICOE3 are three real coefficients needed by this
model. If WHTOPT is ON, droplet-to-wall heat transfer
modelling will be activated.
Version 3.26
12-15
DROPLETS MODULE
Chapter 12
Global Models
PEMISSIVITY, EMISS(0.0): Defines particle or droplet emissivity.
EMISS
– Surface emissivity of particle or droplet.
Global Models
DCOLLISION, OPTION, ADDCONS, COALEL, CLUSTR, COLDET,
NUMDENS: Activates/deactivates the O'Rourke droplet collision model for
transient cases and applies advanced options if required.
OPTION
– OFF (default). Collision model off.
– STANDARD. Activates transient collision model with default
settings for remaining options. Note that the coalescence
timescale is applied as a default (extension to the O’Rourke
model).
– ADVANCED. Activates transient collision model and accepts
further settings from this command.
ADDCONS
– OFF (default). No additional constraints on collision detection.
– ON,RMFACT(1.0). Applies additional geometric constraints
on collision detection. RMFACT is the relative motion factor.
COALEL
– OFF. Coalescence timescale not applied.
– ON (default). Applies coalescence timescale.
CLUSTR
– OFF (default). No cell clustering.
– ON,LEVELS(1). Activates cell clustering. Cells will be added
to the cluster within neighbouring layers defined by LEVELS.
COLDET
– STANDARD (default). Uses standard method for detecting
collisions.
– USER. User subroutine COLLDT is called for collision
detection.
NUMDENS – STANDARD (default). Uses standard method for calculating
droplet number density.
– USER. User subroutine COLLND provides the droplet number
density.
DCONDENSATION, OPTION: Switches droplet condensation calculations on or
off.
12-16
Version 3.26
Chapter 12
DROPLETS MODULE
Global Models
OPTION
– OFF (default). Deactivates the droplet condensation model.
– ON. Activates the droplet condensation model.
DRFORCE, STATUS: Applies body forces (such as gravity) to droplets.
STATUS
– OFF (default). Body forces will not be allowed.
– ON. Body forces will be allowed.
DRTURBULENCE, STATUS: Activates/deactivates the turbulent dispersion
model.
STATUS
– /OFF/ON/.
Version 3.26
12-17
Chapter 13
LIQUID FILMS MODULE
Chapter 13
LIQUID FILMS MODULE
HELP
or
LFBOIL, OPTION, TBOIL: Switches the film boiling off or on.
OPTION
– OFF (default). Film boiling is turned off.
– ON. Film boiling is turned off.
TBOIL
– Boiling temperature (K).
LFCMPONENT, NLFCOM(1): Specifies the number of components for a liquid
film type and defines their physical properties.
NLFCOM
– Number of liquid film components.
The user will be prompted for: Scalar Number, Mass-Fraction, Specific Heat (at
constant pressure), Heat of Vaporisation, Pressure of Saturation (absolute) and
Component Name for each film component. If USER is specified for Scalar
Number, then this component evaporates to many scalars and this is specified via
user coding. The sum of the mass-fractions for all the components must total 1.0.
LFCONDENSATION, OPTION: Switches liquid film condensation calculations
on or off.
OPTION
– OFF (default). Deactivates the LF condensation model.
– ON. Activates the LF condensation model.
Version 3.26
13-1
LIQUID FILMS MODULE
Chapter 13
LFFORCE, STATUS: Applies gravity forces to liquid films.
STATUS
– OFF (default). Gravity forces will not be allowed.
– ON. Gravity forces will be allowed.
LFFUEL, FUELTYPE, NOPT(1): Sets the fuel type present in films of the active
film type for single-component films. For multi-component films the command sets
the NOPTth film component to the specified fuel type. Film or component
properties (e.g. density, surface tension etc.) are then calculated internally by
STAR. This command takes precedence over properties specified via
LFPROPERTY or LFCMPONENT.
FUELTYPE – /STANDARD/N-HEPTANE/N-DODECANE/HMN/.
NOPT
– For multi-component films, NOPT specifies the component
number. For single-component films, NOPT is ignored. The
fuel type is set for the active film type.
LFHEAT, OPTION: Switches the heat transfer between the film and carrier fluid
on or off.
OPTION
– ON (default). Heat transfer between the film and carrier is on.
– OFF. Heat transfer between the film and carrier is off.
LFMASS, OPTION: Switches the mass transfer between the film and carrier fluid
on or off.
OPTION
– ON (default). Mass transfer between the film and carrier is on.
– OFF. Mass transfer between the film and carrier is off.
LFMMENTUM, OPTION: Switches the momentum transfer between the film
and carrier fluid on or off.
13-2
Version 3.26
Chapter 13
LIQUID FILMS MODULE
OPTION
– ON (default). Momentum transfer between the film and carrier
is on.
– OFF. Momentum transfer between the film and carrier is off.
LFMODEL, OPTION, URFACTOR: Sets the type of liquid film model used.
OPTION
– DYNAMIC (default). Liquid films are dynamic. Heat, mass
and momentum transfer is modelled.
– STATIC. Liquid films are static. Only heat and mass transfer is
modelled.
URFACTOR – Under-relaxation factor (default = 0.7).
LFPROPERTY, PROPOPT, USEROPT, VALUE: Defines initial physical
properties for liquid films.
PROPOPT
– DENS. Density.
– STCO. Surface tension coefficient.
– COND. Thermal conductivity.
– TCRI. Critical temperature.
– HOVA. Heat of vaporisation.
– POSA. Saturation pressure.
USEROPT
– STANDARD. If PROPOPT = DENS, STCO, VISC, COND or
TCRI, film bulk physical properties are constant. If
PROPOPT = CP, HOVA, or POSA, film component physical
properties are constant.USER. Bulk or component physical
properties are variable and are defined by user subroutine
LFPROP.
VALUE
– For PROPOPT = DENS, STCO, VISC, COND and TCRI, this
is the bulk density, surface tension coefficient, viscosity,
conductivity or critical temperature, respectively. Default
values are 1000.0 for DENS, 0.02 for STCO, 1.0E-3 for VISC,
0.15 for COND and 650.0 for TCRI.
Version 3.26
13-3
LIQUID FILMS MODULE
Chapter 13
LFSOLVE, OPTION: Switches liquid film modelling off or on.
OPTION
– OFF. Liquid film modelling not allowed.
– NOINIT. No film present initially; films may form later
through droplet-wall collisions or condensation.
– INIT. Films are present initially on at least some walls/baffles.
LFSTRIP, STATUS: Switches the liquid film stripping model off or on.
STATUS
– OFF (default). Liquid film stripping will not be modelled.
– USER. Liquid film stripping is applied by user subroutine
FDBRK.
LFTDELETE, ILTY(1): Deletes a previously defined liquid film type.
ILTY
– Film type ID.
LFTYPE, ILTY(1), LFNAME: Selects a film type ILTY whose initial properties
and behaviour can be defined by appropriate commands.
ILTY
– Film type number (between 1 and 10).
LFNAME
– Film name (optional).
STATUS: Displays the status of all LIQUID FILM commands.
13-4
Version 3.26
Chapter 14
EVENTS MODULE
Event Creation/History
Chapter 14
EVENTS MODULE
EXIT: Returns to PRO Module.
HELP, OPTION
or
HELP, COMMAND: Displays the command set for the EVENTS module or
displays more detailed information about a specific command within this module.
OPTION
– ALL. All commands in the module will be listed.
– ELIST. Lists events file and step creation and listing
commands.
– ECELL. Lists commands related to deactivation, activation,
refinement and unrefinement of cells.
– EBOUND. Lists commands related to attachments and
detachments.
– ELOAD. Lists commands related to events loading and
execution.
STATUS, OPTION: Gives the status of the EVENTS module.
OPTION
– ALL. Gives status of all event related parameters.
– DATA. Gives information about the currently connected events
data file.
– CURRENT. Gives the current event listing.
– LOADING. Gives the loading information.
EVCND, NEVENT: Defines a conditional event.
NEVENT
– Event number for the conditional event.
Note: This command reinitialises all parameters related to an event. Conditional
events may be referenced by actual events and may contain:
1. Cells with fluid stream changes.
Version 3.26
14-1
EVENTS MODULE
Chapter 14
2. Attachment boundary pairs.
3. Detachment boundary pairs.
EVCOMPRESS: Compresses out deleted events. This will not renumber the
events but will prompt the user whether this command needs to be executed.
EVDELETE, NEVENT: Deletes event definitions from the events file.
NEVENT
– Event number to be deleted from events data file.
Note: The events file should be connected for an event to be deleted.
EVFILE, FOPT, LF(case.evn): Initialises an events data file, re-connects to a
previously defined file or closes an events file. This file contains a record of all
event occurrences.
FOPT
– CONNECT. Reconnects to a previously defined file.
– INITIALIZE. Sets up a new file or completely erase an old
one.
– CLOSE. Closes a previously connected events file. This will
compress the events file by removing all references to deleted
events. The currently active events file will then be closed.
LF
– If INITIALIZE or CONNECT, name of the events file.
EVGET, NEVENT, NEWEVENT, NEWTOPT: Gets an event from the events
file for modification.
NEVENT
– Event number to be loaded for modification.
NEWEVENT – New event number, if it needs to be defined.
For actual events:
14-2
Version 3.26
Chapter 14
EVENTS MODULE
NEWTOPT
– TIME,TIME. Sets the time of occurrence of this event and it
must be unique for all event steps.
– DEGREE,DEGREE. Sets the angular position for this event
step.
For piston cylinder problems:
NEWTOPT
– PCOMP,DISTANCE. Sets the position of the piston when it is
compressing.
– PEXPA,DISTANCE. Sets the position of the piston when it is
expanding.
Note that if DEGREE, PCOMP or PEXPA is the NEWTOPT, the time of
occurrence is calculated using the parameters in the EVPARM command and these
must be pre-set. Also, the time of occurrence calculated for these positions must be
unique for all event steps.
Note: If a new event is to be created using an old one, an existing event could be
read using the EVGET command with options NEWEVENT and NEWTOPT.
EVLIST, OPTION, /NEV1(CURRENT EVENT), NEV2(NEV1),
NEVINC(1)/TIME, TIME1, TIME2/DEGREE, DEGREE1,
DEGREE2/PCOMP, POS1, POS2/PEXPA, POS1, POS2/: Lists characteristics
of events.
OPTION
– BRIEF. Lists event number, time option and time value for
each event.
– FULL. Lists all characteristics of each event.
The following options imply BRIEF plus one extra characteristic:
OPTION
– DEACT. Lists the number of deactivated cells.
– ACTIV. Lists the number of activated cells.
– CFLUID. Lists the number of changed fluid type cells.
– GRID. Gives information about grid change commands.
– ATTACH. Lists the number of attachments.
– DETACH. Lists the number of detachments.
– COND. Lists the number of conditional events.
NEV1,
NEV2,
NEVINC
– Events from NEV1 to NEV2 in increments of NEVINC will be
listed (ALL may be used to indicate all defined events).
The following options list the events in chronological order and are valid only for
BRIEF related options:
Version 3.26
14-3
EVENTS MODULE
Chapter 14
TIME,
TIME1,
TIME2
– Lists events from TIME1 to TIME2.
DEGREE,
DEGREE1,
DEGREE2
– Lists events from DEGREE1 to DEGREE2.
PCOMP,
– Lists events from piston compression positions POS1 to POS2.
POS1, POS2
PEXPA,
– Lists events from piston expansion positions POS1 to POS2.
POS1, POS2
Note: If the event number corresponds to the current event, the current event
description will be listed from the current database. If it does not correspond to the
current event number, this information is obtained from the currently active events
data file.
EVOFFSET, TOFFSET, TFACTOR: Applies offsets to the time value
definitions in the events data file.
TOFFSET
– Offset to be applied to the time definitions in the pro-STAR
events file (default = 0.0).
TFACTOR
– Factor to be applied to the time definition in the pro-STAR
events file (default = 1.0).
Note: TOFFSET and TFACTOR will be applied to positive times only. The new
time of occurrence is given by:
TNEW = TOLD * TFACTOR + TOFFSET
The times listed in the EVLIST command will be the original times of occurrence
as defined by the EVSTEP command or alternative.
EVPARM, OPTION: Defines global parameters to be used in determining the
times of occurrence of the events. Depending upon the TOPTION chosen in the
EVSTEP command, the time of occurrence of a particular event step is calculated
using these parameters.
14-4
Version 3.26
Chapter 14
EVENTS MODULE
OPTION
– DEGREES,RPM,THETAI. Sets the angular speed (RPM) and
the initial angular position in degrees (THETAI). RPM must be
greater than zero. If DEGREE is chosen as TOPTION in the
EVSTEP command, the time of occurrence will be calculated
using:
TIME = (THETA–THETAI)/(6*RPM).
– PISTON,RPM,CRAD,LCON,YINIT,STATE,YTDC. Sets up
piston related parameters where:
– RPM. Angular speed of the model. Must be greater than
zero.
– CRAD. Crank radius. Must be greater than zero.
– LCON. Length of the connecting rod. Must be greater than
zero.
– YINIT. Initial position of the piston.
– STATE. One of COMPRESSION or EXPANSION which
defines the initial state of the piston
(default = COMPRESSION).
– YTDC. Top dead centre location of the piston.
If PCOMP or PEXPA are chosen as TOPTION in the EVSTEP command, the time
of occurrence will be calculated on the basis of a simple crank-connecting rod
mechanism using these parameters.
EVREAD, LF(case.evnc): Reads coded events data from a file, typically to
transfer the data to another computer with a binary data representation that is
incompatible with the current computer.
LF
– File name containing the coded events information. This file
should have been created using the EVWRITE command.
Note: An events data file should be initialised or connected prior to using this
command. If a connected file is used, events having the same number and type will
be replaced. The last read event will become the current event. Thus, if a current
event is present, its description will be destroyed.
EVSAVE, NEVENT, TOPTION: Saves currently defined event in the events data
file. If DEGREE, PCOMP or PEXPA is the TOPTION, the time of occurrence is
calculated using the parameters in the EVPARM command and these must be
pre-set. Also, the time of occurrence calculated for these positions must be unique
Version 3.26
14-5
EVENTS MODULE
Chapter 14
for all event steps. If the current event exists in the events data file, it will be
replaced with one of the same type. If events loading was initiated, all event steps
will be unloaded when any event is saved.
NEVENT
– Event number to be stored (may be different from the current
event number).
TOPTION
step.
For Piston cylinder problems:
TOPTION
compressing.
expanding.
EVSTEP, NEVENT, TOPTION: Defines an actual event.
NEVENT
– Event number (defaults to the next available).
TOPTION
step.
For Piston cylinder problems:
TOPTION
compressing.
expanding.
If DEGREE, PCOMP or PEXPA is the TOPTION, the time of occurrence is
calculated using the parameters in the EVPARM command and these must be
pre-set. Also, the time of occurrence calculated for these positions must be unique
for all event steps.
Note: This command reinitialises all parameters related to an event. Actual events
may contain:
1. Deactivated cells.
2. Activated cells.
3. Cells with fluid stream changes.
14-6
Version 3.26
Chapter 14
EVENTS MODULE
4.
5.
6.
7.
8.
Enabled conditional events.
Disabled conditional events.
Attachment boundary pair.
Detachment boundary pairs.
Grid change commands.
EVUNDELETE, NEVENT, NEWTOPT: Undeletes a previously deleted event
definition in the events file.
NEVENT
– Event number to be un-deleted from events data file.
For actual events:
NEWTOPT
step.
For piston cylinder problems:
NEWTOPT
compressing.
expanding.
Note that if DEGREE, PCOMP or PEXPA is the NEWTOPT, the time of
occurrence is calculated using the parameters in the EVPARM command and these
must be pre-set. Also, the time of occurrence calculated for these positions must be
unique for all event steps.
EVWRITE, LF(case.evnc): Writes coded events data to a file, typically to
transfer the data to another computer with a binary data representation that is
incompatible with the current computer.
LF
– File name containing the coded events information.
Note: An events data file should have been created prior to using this command.
Version 3.26
14-7
EVENTS MODULE
Chapter 14
Grid Change and Condition Selection
ECONDITIONAL, NEVENT, OPTION: Adds conditions specified in a
conditional event to the current event.
NEVENT
– Previously stored conditional event in the events file.
OPTION
– /ENABLE/DISABLE/IGNORE/. If ENABLE, the conditions
of NEVENT are added to the current event. If DISABLE, the
conditions of NEVENT are disabled from the current event. If
IGNORE, the reference to conditional event NEVENT is
deleted.
Note: The current event must be an ACTUAL event. All conditional events defined
for a particular event will be carried on to the next event in STAR unless disabled.
EFLUID, NFL, OPTION, COPTION: Changes the fluid stream of an event.
NFL
– Fluid number.
OPTION
– /ADD/DELETE/CLEAR/.
If the option is ADD or DELETE:
COPTION
– CRANGE,NC1,NC2,NCINC. Cells in the range NC1 to NC2
in increments of NCINC will be added/removed.
– CTYPE,ICTID. All ICTID cell types will be added/removed.
– GROUP,IGRP. All IGRP group types will be added/removed.
EGRID, OPTION: Defines grid change pro-STAR commands for moving mesh
problems. Valid only for ACTUAL events with non-negative times of occurrence.
Parameters needed with the grid change commands can be set up using the
user-defined subroutine UPARM. Explicit redefinition of vertices can be done
using the user-defined subroutine NEWXYZ. Both subroutines UPARM and
NEWXYZ can reference subroutine LIVCLL to get the status of a cell at any
loading time.
14-8
Version 3.26
Chapter 14
EVENTS MODULE
OPTION
– CONTINUE. Uses grid change commands of the previous
event for the current event (default).
– READ,LUNIT(case.cgrd),GOPTION. Reads in grid
change commands from file LUNIT with GOPTION:
– ABSOLUTE. The grid change commands specified are in
absolute time.
– RELATIVE. The grid change commands specified are in
relative time.
– WRITE,LUNIT(case.cgrd). Writes out stored grid change
commands to file LUNIT.
– LIST. Lists stored or current grid change commands.
– SETUP. Sets up the grid change commands for execution by
invoking the user-defined move grid subroutine UPARM and
defining required parameters.
– NEWXYZ. Modifies the vertex coordinates as specified by the
user-defined subroutine NEWXYZ.
– EXECUTE. Executes the current grid change commands by
inputting them as a stream of pro-STAR commands. Sequence
of operation:
– Define parameters from UPARM.
– Execute grid change commands.
– Use NEWXYZ to redefine vertices.
– NONE. Clears EGRID input stream for this event.
Notes:
1. The EGRID command remains active for subsequent events unless the
EGRID,NONE command is executed.
2. Subroutine LIVCLL may be called within UPARM or NEWXYZ as:
CALL LIVCLL(NCELL,ISTAT)
where NCELL is the pro-STAR cell number whose status is to be determined.
ISTAT is returned as follows:
ISTAT = 0 if NCELL is a deactivated cell
ISTAT = –1 if NCELL is marked for deactivation
ISTAT = –2 if there is no such fluid cell
ISTAT = 1 if NCELL is a live cell
3. The EGRID command is automatically called by the MIXASI, MIXVESSEL,
MMVALVE, MMPISTON and MMVCURTAIN commands.
4. See the EVFLAG command for check parameters relevant to this command.
Version 3.26
14-9
EVENTS MODULE
Chapter 14
Cell Activation/Deactivation
Cell Activation/Deactivation
EACELL, OPTION, COPTION: Activates cells for the current event. Only valid
for an ACTUAL event with time of occurrence greater than zero.
OPTION
COPTION
Note: The cells to be activated for an event should be selected on a layer basis.
ECLIST, OPTION, NC1, NC2, NCINC: Lists deactivated, activated, change
fluid type, excluded or included cells.
OPTION
– /DEACTIVATE/ACTIVATE/CFLUID/EXCLUDE/
/INCLUDE/.
NC1, NC2,
NCINC
– Cells from NC1 to NC2 in increments of NCINC will be listed.
If CSET, cells in the current cell set will be listed. If ALL
(default), all cells with the specified option will be listed.
EDCELL, OPTION, COPTION: Deactivates cells for the current event in the
currently active direction specified by the EDDIR command. Only valid for an
ACTUAL event.
OPTION
COPTION
Note: The cells to be deactivated for an event should be selected on a layer basis.
14-10
Version 3.26
Chapter 14
EVENTS MODULE
Cell Exclusion/Inclusion
EDDIR, OPTION: Specifies the direction for deactivating cells. Only valid for an
actual event.
OPTION
– FACE,IFACE. The direction is chosen using a face number,
IFACE from 1 to 6. Face 1 is equivalent to Face 2, Face 3 is
equivalent to Face 4 and Face 5 is equivalent to Face 6 (see
Figure 14-1).
– LOCAL,ICSYS(1),IDIR. The direction is chosen using a valid
coordinate system ICSYS and a component IDIR (1, 2 or 3).
– VERTEX,NV1,NV2. The direction is chosen using the
orientation of a vector defined by two vertices NV1 and NV2.
– VSET. The direction is chosen using the current vertex set.
4
3
4
8
1
5
7
1
6
2
2
3
5
6
Figure 14-1
pro-STAR cell face numbering convention
Cell Exclusion/Inclusion
EECELL, OPTION, COPTION: Excludes specified cells for the current event set
up. Only valid for an ACTUAL event.
OPTION
COPTION
EICELL, OPTION, COPTION: Includes specified cells for the current event set
up. Only valid for an ACTUAL event (see command EICOND for conditions
Version 3.26
14-11
EVENTS MODULE
Chapter 14
Boundary Attachment
associated with included cells).
OPTION
COPTION
EICOND, OPTION: Sets up conditions associated with included cells. The
conditions will apply to newly included cells for the event, not already included
cells.
OPTION
– CURRENT. The cells are included with the conditions they
had when they were excluded.
– INITIAL. The cells are included with the initial conditions
specified in pro-STAR.
– USERSPECIFIED. The conditions for the cells are specified in
user subroutine UBINIT.
Boundary Attachment
EACOMPRESS: Compresses deleted attached sets out of the list.
EADELETE, NBA1, NBA2, NBAINC: Deletes previously defined attached
boundary sets.
NBA1,
NBA2,
NBAINC
– Deletes sets numbered NBA1 to NBA2 by NBAINC.
EAGENERATE, NREP, NBINC, NBA1, NBA2, NBAINC: Generates additional
14-12
Version 3.26
Chapter 14
EVENTS MODULE
Boundary Attachment
attached sets by offsetting a previously defined starting set.
NREP,
NBINC
– Generates NREP sets incrementing each boundary number by
NBINC.
NBA1,
NBA2,
NBAINC
– Initial set of boundary pairs defined by NBA1 to NBA2 by
NBAINC.
Note: Only attachment boundary types can be used to define an attached pair.
EALIST, NBA1, NBA2, NBAINC, OPTION: Lists attached boundary set
definitions.
NBA1,
NBA2,
NBAINC
– Lists attached sets NBA1 to NBA2 by NBAINC.
OPTION
– BRIEF (default). Only the boundaries will be listed.
– VERBOSE. Boundaries and distances between centroids of the
boundaries will be listed.
EAMATCH, NREG1, NREG2, IGLOCAL(1), DX1, DY1, DZ1, DX2, DY2,
DZ2, TOL(.0001): Matches boundaries on two faces by comparing the boundary
centroids in a local coordinate system and creates the appropriate attached set list.
Version 3.26
NREG1,
NREG2
– Region definitions of the first and second attachment sides.
NREG1 cannot be equal to NREG2.
IGLOCAL
– Local coordinate system to use in matching up comparable
boundaries.
DX1, DY1,
DZ1
– Offsets added to the centroids of the boundaries belonging to
NREG2.
DX2, DY2,
DZ2
– Supplementary offsets added to the centroids of the boundaries
belonging to NREG1 in order to match the centroids of
boundaries in NREG2. Used only if a match for the previous
set of offsets is not found.
TOL
matched.
14-13
EVENTS MODULE
Chapter 14
Boundary Detachment
EATTACH, NB1, NB2, NREP(1), NOFF(0): Defines a attached pair of
boundaries.
NB1, NB2
– A pair of boundary definition numbers that form an attached
set. NOTE: The actual coupling of U, V and W is a function of
boundary orientation or local coordinate system orientation as
defined in the REGION specification.
NREP
– Repeats this command NREP times offsetting the boundaries
by NOFF.
Boundary Detachment
EDCOMPRESS: Compresses deleted detached sets out of the list.
EDDELETE, NBD1, NBD2, NBDINC: Deletes previously defined detached
boundary sets.
NBD1,
NBD2,
NBDINC
– Deletes sets numbered NBD1 to NBD2 by NBDINC.
EDETACH, OPTION, BOPTION: Defines detached boundaries. The detached
boundary set number will correspond to the next available number.
OPTION
14-14
Version 3.26
Chapter 14
EVENTS MODULE
Automatic Event Generation
BOPTION
– BRANGE,NB1,NB2,NBINC. Boundaries in the range NB1 to
NB2 in increments of NBINC will be added/deleted. If BSET
is used, all boundaries in the current set will be
added/removed.
– REGION,NR. Boundaries in the region NR will be
added/removed.
Note: Only attachment boundary types will be added to the detachment list.
EDLIST, NBD1, NBD2, NBDINC: Lists detached boundary set definitions.
NBD1,
NBD2,
NBDINC
– Lists attached sets NBD1 to NBD2 by NBDINC.
Automatic Event Generation
MIXASI, LF(case.evn), IGRPR, RPM, ICROT(2), THETA(360.):
Automatically generates a complete events data file for mixing vessels with
arbitrary sliding interface. In order to attach boundaries properly, the interface must
have 1:1 correspondence (i.e. no couples on the interface).
LF
– File name of the file used to create the events data.
IGRPR
– Group number of rotating cells.
RPM
– Rotating speed.
ICROT
– Coordinate system for rotation (must be a cylindrical
coordinate system).
THETA
– Angular extent of domain in degrees.
MIXVESSEL, LF(case.evn), IGRPS, IGRPR, ICOR, RPM, ICROT(2),
NREV(1): Automatically generates a complete events data file for mixing vessels.
Version 3.26
LF
– File name of the file used to create the events data.
IGRPS
– Group number of stationary cells.
14-15
EVENTS MODULE
Chapter 14
IGRPR
– Group number of rotating cells.
ICOR
– Corner cell number of rotating cells.
RPM
– Rotating speed.
ICROT
– Coordinate system for rotation (must be a cylindrical
coordinate system).
NREV
– Number of revolutions.
EVCHECK, OPTION: Sets the option for checking events.
OPTION
– PREP. The option is set to pre-processing and the PREP event
flags are used in loading and execution of events.
– POST. The option is set to post-processing and the POST event
flags are used in loading and execution of events.
Note: The command EVLOAD,UPTO,STORED automatically defaults to the
POST option.
EVEXECUTE, STATUS: Executes events.
OPTION
– ON. Executes all events up to the time of loading by:
– Deleting deactivated cells and re-defining vertices of
adjacent cells.
– Modifying cells with fluid stream changes to a different type.
– Re-defining attaches in terms of the minimum vertex
numbers if coincident.
A summary of the events execution statistics is produced, with
brief or detailed list of attaches which are not coincident, if
such attaches are found.
– OFF. Turns off events execution by restoring original
connectivity data.
Note:
1. Because the vertices get replaced, attached faces can no longer be seen after
events execution.
2. Loading another event time after this command will basically reset the model
to its original connectivities.
3. No events execution can take place if the events are not completely loaded.
14-16
Version 3.26
Chapter 14
EVENTS MODULE
4. This command is automatically called by the LOAD and STORE commands
if there is a moving mesh.
EVFLAG, OPTION, STATUS, TYPE: Sets various event checking flags for
commands that involve loading and executing events.
OPTION
– PREP. Sets pre-processing events checking flags.
– POST. Sets post-processing events checking flags.
STATUS
– /ON/OFF/.
TYPE
– ALL (default). Sets all of the following flags.
– CONDITIONAL. Processes conditional events (EVLOAD
command).
– UPARM. Processes user-defined subroutine UPARM (EGRID
and EVLOAD commands).
– GRID. Processes grid change commands (EGRID and
EVLOAD commands).
– NEWXYZ. Processes user-defined subroutine NEWXYZ
(EGRID and EVLOAD commands).
– DEACTIVE. Lists deactivated cells that have non-zero volume
(EVLOAD command).
– ACTIVE. Lists active cells that have zero volume (EVLOAD
command).
– ATTACHES. Lists attaches that have non-coincident vertices
(EVEXECUTE command).
– NEWSET. Creates a new cell set of cells which fail events
loading (EVEXECUTE and EVLOAD commands).
– SCDEF. Creates scratch files with the original connectivity and
geometry data so that a previously loaded step can be
re-loaded. If back tracking is not desired, it is suggested that
this flag be turned off because considerable amount of disk
space is needed for large models (EVCOMPRESS,
EVDELETE, EVLOAD, EVREAD, EVSAVE, EVSTEP,
MMPISTON, MMVALVE and MMVCURTAIN commands).
Notes:
1. The TYPE parameters can be used in combination to set more than one
parameter at once (for example, EVFLAG, ON, GRID, UPARM, COND).
2. The EVEXECUTE and EVLOAD commands are called by the LOAD and
STORE commands when there is a moving mesh.
3. The EGRID command is called by the MIXASI, MIXVESSEL, MMVALVE,
MMPISTON and MMVCURTAIN commands.
The following are defaults for the PREP and POST options:
Version 3.26
14-17
EVENTS MODULE
Chapter 14
TYPE
PREP
POST
COND
ON
ON
UPARM
ON
OFF
GRID
ON
OFF
NEWXYZ
ON
OFF
DEACTIVE
OFF*
OFF**
ACTIVE
OFF*
OFF**
ATTACHES
OFF***
OFF***
NEWSET
OFF*
OFF**
SCDEF
ON
ON
*Done at every event/time step depending upon whether the grid change
commands are absolute/relative.
**Only done at the stored time step.
***On events execution only.
EVLOAD, OPTION: Loads event information up to the time specified by the
option. The CPLOT command can be used after this to view the mesh at this point.
An events file must be connected and pre-processed (using the EVPREP command)
before this command can be executed. If the grid change commands reference
external user-defined subroutines UPARM and NEWXYZ, these must be compiled
and linked into pro-STAR. Note that ‘excluded’ cells will be deleted and ‘included’
cells will be added by this command.
OPTION
14-18
– LIST. Gives the status of loading of events.
– FIRST. Loads the event associated with the first time of
occurrence.
– UPTO,NEXT,NTH(1). Loads up to the next NTH time of
occurrence.
– UPTO,TOPTION. Loads all subsequent events up to the time
of occurrence indicated by TOPTION. TOPTION can be one
of TIME,TIME, DEGREE,DEGREE, PEXP,DISTANCE or
PCOMP,DISTANCE whose descriptions are as specified in the
EVSTEP command.
– UPTO,EVENT,EVNO. Loads all subsequent events up to time
of occurrence of event EVNO.
Version 3.26
Chapter 14
EVENTS MODULE
OPTION
– UPTO,STORED. Loads all subsequent events up to the time
specified:
– By the STORE command after a transient run. The new
vertex locations in this case are obtained from the transient
output file and not from the grid change commands. This
feature is automatically invoked by the STORE command if
a valid events data file is connected. Or
– By the LOAD 9 command. The new vertex locations in this
case are obtained from the post output file and not from the
grid change commands.
– UPTO,LAST. Loads all subsequent events up to the last time
of occurrence.
– ONLY,EVENT,EVNO. Loads only event EVNO. Rather than
load all previously occurring events, this command loads only
the characteristics of the specified event. It is the user’s
responsibility to get the right connectivity data. This command
is useful for mixer/sliding problems where events do not have
activations or deactivations and have attachments and
detachments only, that is, cases where every event is an
independent entity.
– RESET. Unloads all processed events and sets the model back
to its original state.
Note:
1. Only events saved in the events data file will be loaded.
2. The current event, if any, will be deleted and the last loaded event will become
the current event.
3. This command is automatically called by the LOAD and STORE commands
if there is a moving mesh.
EVPREP: Checks the events in time sequence and prepares a valid events data file.
The following checks are performed:
1.
2.
3.
4.
5.
6.
Whether there are any actual events.
Whether the actual events are defined in ascending time order.
Whether the conditional events referenced exist.
Cells are not activated unless they have been deactivated.
All attaches and detaches reference currently active cells.
Attachments are unique.
An additional flag is introduced which gives the maximum number of current
attaches in any event. If all checks are okay, a flag is set up so that the events data
file can be processed for animation or STAR analysis.
Version 3.26
14-19
EVENTS MODULE
Chapter 14
Arbitrary Sliding Interface
PLATTACH, STATUS: Turns the plotting of the attached faces off/on. This
command works only after events have been loaded using the EVLOAD command.
OPTION
– /OFF/ON/.
EASI, NEVENT, OPTION: Includes sliding sets specified in a sliding event to the
current event.
NEVENT
– Previously stored sliding event.
OPTION
– /DISABLE/ENABLE/IGNORE/. If ENABLE, the conditions
of NEVENT are added to the current event. If DISABLE, the
conditions of NEVENT are deleted from the current event. If
IGNORE, the reference to NEVENT is deleted from the
current event.
EMSLIDE, OPTION, COPTION: Defines the master list of boundaries for the
sliding interface. All boundaries specified must be of type ATTACH.
OPTION
– /LIST/ADD/DELETE/CLEAR/.
COPTION
– REGION,NREG1,NREG2,NREGINC. All boundaries in
regions NREG1 to NREG2 by NREGINC will be included.
– BOUNDARY,NB1,NB2,NBINC. All boundaries from NB1 to
NB2 by NBINC will be included. BSET may be used to
include all boundaries in the current set.
EOSLIDE, IGLOCAL(1), DX1, DY1, DZ1, DX2, DY2, DZ2, TOLIN(.01),
TOLPL(.25), TOLANG(15.): Supplies the offsets needed to match the two sliding
regions. The offsets prescribed in this command are with respect to the model’s
pre-analysis condition and it is the user’s responsibility to specify them
14-20
Version 3.26
Chapter 14
EVENTS MODULE
appropriately so that the initial match definitions are developed.
IGLOCAL
– Local coordinate system to use in matching up comparable
boundaries. This coordinate system must already exist.
DX1, DY1,
DZ1
– Offsets added to the centroids of the boundaries belonging to
NREG2.
DX2, DY2,
DZ2
– Supplementary offsets added to the centroids of the boundaries
belonging to NREG1 in order to match the centroids of
boundaries in NREG2. Used only if a match for the previous
set of offsets is not found.
TOLIN
face is shrunk by a factor of 1.–TOLIN when checking).
TOLPL
TOLANG
– Tolerance value for matching the normal to a slave face with
the normal to the corresponding master face.
EPSLIDE, STATUS: Enables (or disables) the arbitrary sliding interface partial
boundary capability for a sliding event.
STATUS
– OFF. Disables arbitrary sliding interface partial boundary
capability.
– ON,TOL(0.02). Enables arbitrary sliding interface partial
boundary capability. TOL is a tolerance used with matched
boundaries to determine whether boundaries that differ in area
are classified as partial boundaries. A partial boundary is
assumed when an area of more than TOL*(face area) cannot be
projected onto the matching boundaries. Setting TOL equal to
or greater than 1.0 is the same as disabling arbitrary sliding
interface partial boundary capabilities for the event.
ESSLIDE, OPTION, COPTION: Defines the slave list of boundaries for the
sliding interface. All boundaries specified must be of type ATTACH.
Version 3.26
14-21
EVENTS MODULE
Chapter 14
OPTION
– /LIST/ADD/DELETE/CLEAR/.
If the option is ADD or DELETE.
COPTION
– REGION,NREG1,NREG2,NREGINC. All boundaries in
regions NREG1 to NREG2 by NREGINC will be included.
– BOUNDARY,NB1,NB2,NBINC. All boundaries from NB1 to
NB2 by NBINC will be included. BSET may be used to
include all boundaries in the current set.
EVSLIDE, NEVENT: Defines a sliding event. Sliding events may be referenced
by actual events via the EASI command. Each sliding event contains two lists of
boundaries defined using the EMSLIDE (the master list) and the ESSLIDE (the
slave list) which will be matched using the offsets prescribed in the EOSLIDE
command to create sets when the event is saved. This set is used as an initial guess
by STAR to match the arbitrary sliding interfaces.
NEVENT
– Event number for the sliding event.
14-22
Version 3.26
Chapter 15
CHEMICAL MODULE
Scheme Definition
Chapter 15
CHEMICAL MODULE
HELP
or
STATUS: Gives the status of the CHEMICAL reactions module.
Scheme Definition
CDCHEM, LF(case.chm), OPTION: Writes out details of chemical reaction
schemes in coded form.
LF
– File name to which the information will be written.
OPTION
– ALL (default). Writes out all chemical reaction schemes.
– ICSC1,ICSC2,ICSCINC. Writes out chemical reaction
schemes from ICSC1 to ICSC2 in increments of ICSCINC.
Note: Because the ignition details and the scalar map are model dependent
parameters, these will not be written to the coded file.
CRDELETE, ICSC: Deletes a chemical reaction scheme.
ICSC
– Chemical reaction scheme number to be deleted.
CRLIST, OPTION, ICSC1, ICSC2, ICSCINC: Lists the chemical reaction
schemes defined.
Version 3.26
15-1
CHEMICAL MODULE
Chapter 15
Scheme Definition
OPTION
– /BRIEF/FULL/.
ICSC1,
ICSC2,
ICSCINC
– Defined chemical reaction schemes from ICSC1 to ICSC2 in
increments of ICSCINC will be listed.
CRMODEL, ICSC, TYPE, OPTION: Defines the chemical reaction scheme.
15-2
ICSC
– Chemical scheme number to be defined. The default is the
currently active scheme defined by the CRTPE command. If
there is no active type, ICSC defaults to 1.
TYPE
– /PPDF/LSOURCE/REGVAR-PR/COMPLEX/:
– PPDF. Presumed probability density function reaction
scheme.
– LSOURCE. Local source reaction scheme where the reaction
is specified by the REACTION and RRATE commands.
– REGVAR-PR. Flame-area combustion: Weller models,
CFM-ITNFS or Magnussen model.
OPTION
– For TYPE = PPDF:
– /ADIABATIC/NONADIABATIC/.
– For TYPE = LSOURCE: UFAC,/DIFLAME/PRMX/:
– UFAC. Under-relaxation factor for the reaction rate. For
steady-state cases, the default is 0.5. For transient cases, the
value is fixed at 1.0.
– /DIFLAME/. Diffusion flame option.
– PRMX. Premixed option. Leading reactants are at constant
mixture fractions given by comment MIXFRACTION.
Version 3.26
Chapter 15
CHEMICAL MODULE
Scheme Definition
OPTION
– For TYPE = REGVAR-PR: UFAC,/W1EQ/W2EQ/W3EQ/
/CFMI/MAGN/,OPTIONS:
– UFAC. See above (in TYPE = LSOURCE).
– W1EQ,COPT,AHGW(2.0),TDEL(10.0),DK0(1.0E-3),LFS,
IFUEL,IEGR. Weller one-equation model:
– COPT. Conditional enthalpy solution switch (NO/YES).
– AHGW,TDEL,DK0. Weller constants.
– LFS. Laminar flame speed model (GULDER/
METGHALCHI).
– IFUEL. Fuel identifier for Gulder laminar flame speed
model (/ISOOCTANE/CH4/PROPANE/METHANOL/
/ETHANOL/).
– IEGR. EGR (exhaust gas recirculation) switch (NO/YES).
– W2EQ,COPT,AHGW(2.0),DK0(1.0E-3),WRIN1(0.62),
WRIN2(0.28),LFS,IFUEL,IEGR. Weller two-equation
model:
– COPT,LFS,IFUEL. See above.
– AHGW,DK0,WRIN1,WRIN2. Weller constants.
– LFS,IFUEL,IEGR. See above.
– W3EQ,COPT,AHGW(2.0),DK0(1.0E-3),WRIN1(0.62),
WRIN2(0.28),LFS,IFUEL,IEGR. Weller three-equation
model:
– See above for all constant definitions.
– CFMI,COPT,ALPHA(2.1),BETA(1.0),AA(0.1),
TDEL(1.0E-4),DK0(2.0E-3),IGCELL(0),LFS,IFUEL,IEGR.
CFM-ITNFS two-equation model:
– COPT. See above.
– ALPHA,BETA,AA. CFM constants.
– TDEL,DK0,IGCELL. CFM constants.
– LFS,IFUEL,IEGR. More constants (see above).
– MAGNUSSEN,COPT,IEGR. Magnussen model:
– COPT. Conditional enthalpy solution switch (NO/YES).
– IEGR. See above.
– COMPLEX,/STAR/ULIB/:
– STAR. Reaction rate calculated by STAR.
– ULIB. Reaction rate calculated by a user library.
– For TYPE = COMPLEX: /STAR/USER/STKINETICS/:
– STAR. Reaction rate calculated by STAR.
– USER. Reaction rate calculated by user subroutine
REACUL.
– STKINETICS. Reaction rate calculated by STAR/KINetics.
CRTYPE, ICSC: Changes the currently active chemical reaction scheme number.
Version 3.26
15-3
CHEMICAL MODULE
Chapter 15
Scheme Definition
ICSC
– Chemical reaction scheme number, which must have been
previously defined (see command CRMODEL).
CRUNDELETE, ICSC: Undeletes a previously deleted chemical reaction scheme.
ICSC
– Chemical reaction scheme number to be undeleted.
HRCO, ICSC, STATUS(OFF): Activates or deactivates the heat of reaction
option for a given chemical reaction scheme.
ICSC
– Chemical reaction scheme number. The default is the current
chemical reaction scheme (see command CRTYPE).
STATUS
– /OFF/ON/.
REHT, ICSC, NREACT(1), TREHOR(298.0), Q(0.0): Defines heat of reaction
data for a given reaction in a given chemical reaction scheme. The HRCO command
must be set to ON for this scheme before using this command. The scheme must be
a LOCAL SOURCE model (see command CRMODEL).
ICSC
NREACT
– Reaction number in chemical reaction scheme ICSC.
TREHOR
– Reference temperature at which the heat of reaction is
evaluated (degrees Kelvin).
Q
– Heat of reaction (J/kg).
SBREACTION, ICSC, OPTION: Defines sub-reaction models for a given
chemical reaction scheme.
15-4
Version 3.26
Chapter 15
CHEMICAL MODULE
Local Source Schemes
ICSC
chemical reaction scheme (see command CRTYPE). The
scheme must be a PPDF model (see command CRMODEL).
OPTION
– PSPPDF (default). Equilibrium PPDF reaction using
polynomials.
– SPPDF. Equilibrium PPDF reaction using lookup table.
– MPPDF. Multi-fuel PPDF reaction. This option cannot be used
when soot modelling is on (see command SOOT).
– FLAMELET. PPDF reaction using the laminar flamelet model.
CRPRODUCTS, NPROD(1): Defines the products in the current chemical
reaction scheme (for LOCAL SOURCE or REGVAR-PR schemes only). The user
will be prompted for the names of the products.
NPROD
– Number of products (max = 50).
CRREACTANT, NREACT(1), STATUS, MFRAC: Defines a reactant to be
used in the current chemical reaction scheme (for LOCAL SOURCE or
REGVAR-PR schemes only). The user will be prompted for the name of the
reactant.
NREACT
– Reactant number (1 to 30).
STATUS
– OFF. Deactivates the reactant.
– ON. Calculates reactant mass fraction by solving the standard
transport equation.
– FIXED-FRACTION. Uses a fixed mass fraction for the
reaction.
MFRAC
– The mass fraction of a reactant in the background fluid
(default = 0.233 for NREACT = 1, default = 0.0 for
NREACT > 1).
Note: Reactant 1 by default is OXYGEN.
Version 3.26
15-5
CHEMICAL MODULE
Chapter 15
LREACT, NLREACTANTS(1): Defines the leading reactants in the current
chemical reaction scheme (for LOCAL SOURCE or REGVAR-PR schemes only).
The user will be prompted for the names of the leading reactants.
NLREACTANTS – Number of leading reactants to be used (max = 30).
LSOURCE, OPTION: Defines all the constituents of a local source chemical
reaction scheme. The scheme is the currently active scheme defined in the CRTYPE
command.
OPTION
– /LIST/DEFINE/OFF/ON/.
– LIST (default). Lists the current scheme, if it is a local source
scheme.
– DEFINE. Interactively asks the user for the constituents of
the current scheme (leading reactants, reactants and
products), the reactions and their rates and the ignition
parameters.
– OFF. Turns off the local source reactions temporarily for the
current scheme.
– ON. Turns the local source reactions back on for the current
scheme.
MAGNUSSEN, OPTION: Defines timescale of eddy break-up for combustion
scheme.
OPTION
– /STANDARD/MODWALL/LATCT/.
REACTION, RNUM(1): Defines a reaction to be used in the current chemical
reaction scheme (for LOCAL SOURCE or REGVAR-PR schemes only). The
leading reactants, reactants and products should be defined prior to this command.
The program will prompt for the amount in kilomoles of the fuels associated with
the reaction, the reactants consumed and the fuels (by-product), reactants and
products produced. Note that defining a reaction automatically turns it on.
RNUM
15-6
– Reaction number. Cannot be more than the number of reactants
in the current chemical reaction scheme (see command
LREACT).
Version 3.26
Chapter 15
CHEMICAL MODULE
Note: Reaction 1 is allowed to produce leading reactants 2 to 30 as by-products.
Reaction 2 is allowed to produce leading reactants 3 to 30 as by-products. Etc.
RRATE, RNUM, RATE, TYPE, TSCALE, OPTION: Defines the reaction rate
for a current local source chemical reaction process.
Version 3.26
RNUM
– Predefined reaction number. Reactions are defined using the
REACTION command.
RATE
– EDBR (default). Eddy break-up reaction rate.
– CHKI. Chemical kinetic reaction rate.
– COMBINED. Combined eddy break-up and chemical kinetic
reaction rate.
– COMTIME. Combined time scale based on eddy break-up and
chemical kinetics.
– USER. User-supplied reaction rate via user subroutine
REACFN.
TYPE
– HOMOGENEOUS (default). The reaction occurs within the
fluid.
– HETEROGENEOUS. The reaction occurs at fluid boundaries
specified by user subroutine BCDEFW.
TSCALE
Used only for EDBR, COMB or COMT models:
– LOCAL (default). Reaction rate is based on local time scale.
– GLOBAL. Reaction rate is based on global time scale.
OPTION
– STANDARD (default). Uses default parameter values for the
reaction model selected.
15-7
CHEMICAL MODULE
Chapter 15
OPTION
– SPECIFY. The user will be prompted for various parameters.
– EDBR rate constants (for EDBR, COMB or COMT models):
/PRODUCT/NOPRODUCT/,AMIX(4.0),BMIX(0.5)
where /PRODUCT/NOPRODUCT/ specifies whether to
include the product mass fractions in calculating the reaction
rate, and AMIX and BMIX are constants used in this
reaction. PRODUCT is the default when coal combustion
modelling is off; NOPRODUCT is the default when coal
combustion modelling is on (see command COALMODEL).
– CHKI rate constants (for CHKI, COMB or COMT models):
ARHN(1.0E12),EACT(1.0E08),EXPT(0.0),EXPF(1.0),
EXR1(1.0),EXR2(1.0),EXR3(1.0)
ARHN = Arrhenius constant;
EACT = activation energy;
EXPT = temperature exponent;
EXPF = leading reactant concentration exponent;
– EXR1,EXR2,EXR3 = reactant concentration exponents.
RSTATUS, RNUM(1), OPTION, ICSC: Lists a chemical reaction, copies a
chemical reaction from an existing chemical reaction scheme or turns a chemical
reaction off or on. This command is not valid for a PPDF scheme.
RNUM
– Reaction number. Cannot be more than the number of reactants
in the chemical reaction scheme ICSC (see command
LREACT).
OPTION
– LIST (default). Lists reaction RNUM from chemical scheme
ICSC.
– GET. Copies reaction RNUM from chemical scheme ICSC to
reaction RNUM of the current chemical scheme. ICSC may
not be the same as the current chemical scheme number.
Note: Reactant and product names are not copied.
– ON. Turns on reaction RNUM of chemical scheme ICSC. A
reaction is automatically turned on when it is defined.
– OFF. Turns off reaction RNUM of chemical scheme ICSC.
ICSC
– Chemical reaction scheme number. If left blank (except for the
GET option), the current chemical scheme is used (see
command CRTYPE).
Note: A reaction is automatically turned on when it is defined.
15-8
Version 3.26
Chapter 15
CHEMICAL MODULE
PPDF Scheme
PPDF Scheme
DILUTANT, ICSC, NDLT, DILUTANTNAME: Defines dilutant numbers and
dilutant names for a given chemical reaction scheme.
ICSC
– Chemical reaction scheme number. The default is the
current chemical reaction scheme (see command
CRTYPE). The scheme must be a PPDF model (see
command CRMODEL).
NDLT
– Dilutant number. Must be from 1 to 4.
DILUTANTNAME – Dilutant name. May be up to 10 characters. If left blank,
dilutant NDLT of chemical reaction scheme ICSC will
be removed.
FLCO, ICSC, NOFL, NOCH, CHAR, CHIN, V: Defines or modifies the
fuel/oxidiser/product composition and/or chemical valence in a flamelet
calculation.
ICSC
– Reaction scheme number.
NOFL
– Flamelet number.
NOCH
– Keyword CHAR number.
CHAR
– FUEL. Fuel stream definition keyword.
– OXID. Oxidiser stream definition keyword.
– PROD. Product definition keyword.
– VALE. Chemical element valence definition.
CHIN
– Chemical species name or element name.
V
– Mole fraction of a species or valence of an element.
FLCP, ICSC, IOR, IDE: Copies file flame'IOR'.inp'ICSC' to file
flame'IDE'.inp'ICSC'.
ICSC
IOR
– Flamelet number being copied.
IDE
– Destination flamelet number for the copy operation.
Version 3.26
15-9
CHEMICAL MODULE
Chapter 15
PPDF Scheme
FLDELETE, ICSC, NOFL, CHAR: Deletes a line containing keyword CHAR in
the flamelet input file.
ICSC
NOFL
CHAR
– Character string.
FLGENERATE, ICSC, NOFL: Generates a flamelet input file with default
contents. This file will be named ‘flameXX.inpYY’ where XX is the flamelet
number NOFL and YY is the chemical reaction scheme number ICSC. Other
commands (such as FLCO and FLDELETE) can be used to modify this file if
necessary.
ICSC
NOFL
FLKV, ICSC, NOFL, CHAR, V: Defines control parameters for flamelet
calculations.
ICSC
NOFL
CHAR
– Keyword needed for defining the flamelet input file.
V
– Keyword value (if needed).
FLPLOT, ICSC, NOFL(1), IREG(1): Plots the instantaneous values of
temperature, density, specific heat and mass fractions as functions of the mixture
fraction for the current flamelet.
15-10
ICSC
– Reaction scheme number. The default is the current chemical
reaction scheme (see the CRTYPE command).
NOFL
Version 3.26
Chapter 15
CHEMICAL MODULE
PPDF Scheme
IREG
– Graph register number.
FLR1, ICSC: Performs a flamelet chemistry calculation for a given chemical
reaction scheme.
ICSC
scheme must have a FLAMELET subreaction model (see
command SBREACTION).
FLR2, ICSC, NOFL(1): Generates a laminar flamelet library for a given chemical
reaction scheme and flamelet number.
ICSC
NOFL
GFTB, ICSC: Generates a look-up table for a given chemical reaction scheme.
ICSC
POLYNOMIAL, NAME, NORDER, NC1(0), NC2(NORDER): Defines a
polynomial function to describe various parameters in the current chemical reaction
scheme (which must be a PPDF scheme). The user will be prompted for the
polynomial coefficients. The nth-order polynomial is defined as:
P(X) = C0 + C1*X + C2*X**2 + … + Cn*X**n
Version 3.26
15-11
CHEMICAL MODULE
Chapter 15
PPDF Scheme
where n is NORDER, X is the fuel mixture fraction and P(X) is the mass fraction of
the scalar product, the reciprocal of density or the temperature.
NAME
– The product name (up to 20 characters, no blanks or commas).
The keywords DENSITY or TEMPERATURE may be used in
this field, where DENSITY indicates that the polynomial is to
be defined for the reciprocal of density and TEMPERATURE
indicates that the polynomial is to be defined for temperature.
NORDER
– Order of the polynomial (min = 1, max = 24). The polynomial
will contain (NORDER + 1) coefficients. If left blank and the
polynomial has already been defined, then the order of the
polynomial will not change.
NC1, NC2
– Defines polynomial coefficients NC1 to NC2.
PPDF, OPTION: Defines or lists the Presumed Probability Density Function
reaction scheme parameters for the current chemical reaction scheme (which must
be a PPDF scheme).
15-12
Version 3.26
Chapter 15
CHEMICAL MODULE
PPDF Scheme
OPTION
– LIST,LOPTION. Lists the specified product coefficients. This
is the default option.
– LOPTION:
– ALL (default). Lists all products.
– IPROD. Lists product number IPROD (must be from 1 to
48).
– Product Name. Lists the named product.
– /DENSITY/TEMPERATURE/. Lists density or
temperature coefficients.
– DBASE,RATIO(2.0). Prompts for a leading reactant (fuel)
name from the internal database ‘ppdf.dbs’. The names and
coefficients of the scalar polynomials for the remaining
constituents are included from this database. Currently, the
fuels (leading reactants) available in the internal database are
NAPHTHALENE (C10H8) and PROPANE (C3H8).
– RATIO. The ratio of time scales between velocity and scalar
variable fluctuations.
– UDEFINE,RATIO(2.0),NPROD. The constituents of the
reaction are user-defined and will be prompted for. The
coefficients of the constituents and those for density and
temperature must subsequently be specified using the
POLYNOMIAL command.
– RATIO. The ratio of time scales between velocity and scalar
variable fluctuations.
– NPROD. Number of scalar products to be specified
(excluding density and temperature). NPROD must be from
1 to 48. The user will be prompted for the product names,
which may be up to 20 characters and should have no blanks
or commas.
– GSTORE,DELTAM(0.01),REG1(1). Stores the variation of
mass fractions, density and temperature with respect to the
mixture fraction in graph registers. The values will be
calculated at every DELTAM from 0 to 1. Register REG1 will
contain the mixture fraction values and registers REG1+1 to
REG1+IPROD will contain the mass fraction values for the
scalar species. REG1+IPROD+1 will contain densities and
REG1+NPROD+2 will contain temperature values,
respectively. This command will also plot the values in frames
1 to 3.
– OFF. Turns off the PPDF reaction temporarily for the current
scheme.
– ON. Turns the PPDF reaction back on for the current scheme.
TBIN, ICSC, N1, N2: Creates the PDF integration input file.
Version 3.26
15-13
CHEMICAL MODULE
Chapter 15
Ignition
ICSC
N1
– Number of mixture fraction points in the look-up table.
N2
– Number of mixture fraction variance points in the look-up
table.
N3 to N32
– Flamelet numbers which will be included in the lookup table.
Those numbers will be input when this command is being
executed. The total number cannot exceed 30.
Ignition
IGN2, ICTID, TIGN(0.0), FRAF(0.0), OPTION: Defines the ignition parameters
for the second ignition sequence for the current chemical reaction scheme. The
TWOIGNITION command must be set to ON for this scheme before using this
command. The scheme must be a LOCAL SOURCE, REGVAR-PR or COMPLEX
model (see command CRMODEL).
ICTID
– The cell table number denoting the group of cells in which a
second ignition (sparking) takes place. This must be a fluid cell
table. The default is the current cell table.
TIGN
– Second ignition temperature (required for CHKI, COMB or
COMT reactions).
FRAF
– Fraction of leading reactant burnt (required for EDBR, COMB
or COMT reactions).
OPTION
– TIME,TMIN(0.0),TMAX(0.0). Second ignition takes place
between times TMIN and TMAX. This is the default option.
However, it is not valid for steady-state analyses.
– ITER,ITMIN(1),ITMAX(ITMIN). Second ignition takes place
between iterations ITMIN and ITMAX.
IGNITION, ICTID, TIGN(0.0), FRAF(0.0), OPTION: Defines the ignition
parameters for the current chemical reaction scheme. This command is valid for
LOCAL SOURCE and REGVAR-PR schemes only.
ICTID
15-14
– The cell table number denoting the group of cells in which
ignition (sparking) takes place. This must be a fluid cell table.
The default is the current cell table.
Version 3.26
Chapter 15
CHEMICAL MODULE
Ignition
TIGN
– Ignition temperature (required for CHKI, COMB or COMT
reactions).
FRAF
– Fraction of leading reactant burnt (required for EDBR, COMB
or COMT reactions).
OPTION
– TIME,TMIN(0.0),TMAX(0.0). Ignition takes place between
times TMIN and TMAX. This is the default option. However,
it is not valid for steady-state analyses.
– ITER,ITMIN(1),ITMAX(ITMIN). Ignition takes place
between iterations ITMIN and ITMAX.
IGNMODEL, OPTION: Defines the ignition model characteristics.
OPTION
– NONE. No ignition calculation.
– 4STEP,CETNUM(60.0),GRADT4(1.0E+6),FTYPE. Four-step
kinetics model will be used. Two passive scalars, named
RADIC1 and RADIC2, will be defined if they do not already
exist.
– CETNUM. Cetane number of the fuel
(15 ≤ CETNUM ≤ 100, use 60 for n-Heptane).
– GRADT4. Cell temperature gradient.
– FTYPE. Fuel type on which the ignition reaction is based.
Choices are N-HEPTANE (default) and N-DODECANE.
– SHELL,TCHOP(1100.0),GRADTS(1.0E+6),RONS(70.0),
TLIM(1100.0),FMCP(0.2),FTYPE. Shell kinetics model will
be used. Three passive scalars, named RADIC1, RADIC2 and
RADIC3, will be defined if they do not already exist.
– TCHOP. The temperature above which the shell model may
not be used to represent the ignition process. The
recommended value is 1100 (K).
– GRADTS. Cell temperature gradient.
– RONS. Octane number.
– TLIM. The temperature above which ignition is switched off
and the combustion starts.
– FMCP. Fuel mass fraction parameter Bf in the shell model.
– FTYPE. Fuel type on which the ignition reaction is based.
Choices are n-Dodecane (default), n-Heptane, HMN, Octane,
Propane and User. User subroutine FULPRO will be used for
the user-defined fuel.
KNOCK, ICSC, STATUS: Activates/deactivates the knock model for a given
Version 3.26
15-15
CHEMICAL MODULE
Chapter 15
Scalar Mapping
chemical reaction scheme.
ICSC
chemical reaction scheme (see the CRTYPE command). The
scheme must be a REGVAR-PR model (see command
CRMODEL).
STATUS
– OFF (default). Switches the knock model off.
– ON,TCHOPK(1500.0),TGRADK(1.0E+6),RONK(70.0),
FMCPK(0.001),IFTYPK. Switches the knock model on.
– TCHOPK. The temperature above which the knock model
may not be used.
– TGRADK. Temperature gradient.
– RONK. Octane number.
– FMCPK. Regress variable limit.
– IFTYPK. Fuel type on which the knock reaction is based.
Choices are Octane (default), n-Dodecane, n-Heptane, HMN,
Propane and User. User subroutine FULPRO will be used for
the user-defined fuel.
TWOIGNITION, ICSC, STATUS(OFF): Activates or deactivates the second
ignition sequence for a given chemical reaction scheme.
ICSC
scheme must be a LOCAL SOURCE, REGVAR-PR or
COMPLEX model (see command CRMODEL).
STATUS
– /OFF/ON/.
Scalar Mapping
CRSCALAR, OPTION, ICSC, SCOPT: Lists, defines or stoichiometrically
checks the thermo-chemical properties of the scalars that describe the chemical
reaction scheme. For LOCAL SOURCE and REGVAR-PR schemes, all the leading
reactants, reactants, products and reactions must be defined prior to executing this
command. For PPDF schemes, the required scalars will be defined (if not already
defined).
15-16
Version 3.26
Chapter 15
CHEMICAL MODULE
Coal Combustion
OPTION
– LIST (default). Lists the scalar species numbers for which the
scalar properties are defined. The properties associated with
each of these species can be listed using the SCLIST command
and can be modified using the SCMODIFY command. The
RSMODIFY command can be used to assign initial mass
fraction to regions where the constituents (leading reactants
and reactants) occur.
– MAP. Maps scalar species numbers to the constituents of the
reaction scheme and defines their initial conditions and
properties. The scalars defining the constituents will be
mapped from the data base, except for PPDF schemes where
the required products will be defined as scalars. For LOCAL
SOURCE schemes, this option automatically does the
stoichiometric checks for all the reactions defined for this
scheme (with the BRIEF option). Once this option is executed
successfully, the scheme is completely defined. Any changes to
the leading reactants, reactants, products or reactions means
that the scalars associated with each species must be
re-mapped.
– CHECK. Does the stoichiometric checks for every reaction in
the scheme. In other words, it checks that:
Total sum of [kmoles of reactant(i)*molwt(i)] =
Total sum of [kmoles of product(j)*molwt(j)]
Every LOCAL SOURCE chemical scheme must pass the
stoichiometric check for every reaction defined in it. This
option is not valid for PPDF schemes.
ICSC
– The chemical reaction scheme number. The default is the
current chemical reaction scheme (see command CRTYPE).
SCOPT
– For the MAP option: /UDEFINED/DBASE/
– UDEFINE (default for MAP option). Undefined scalar
properties are user-defined and will be prompted for.
– DBASE. Undefined scalar properties are extracted from the
standard properties database ‘props.dbs’ if available.
– For the CHECK option: /BRIEF/VERBOSE/
– BRIEF (default for CHECK option). Performs checks with
brief output.
– VERBOSE. Performs checks with verbose output.
– SCOPT is not used for the LIST option.
Coal Combustion
COALMODEL, STATUS: Activates/deactivates coal combustion modelling.
Version 3.26
15-17
CHEMICAL MODULE
Chapter 15
Coal Combustion
STATUS
– OFF (default). Turns off coal combustion modelling.
– ON. Turns on coal combustion modelling.
CODB
COEBREAKUP, VOPTION, SOPTION, AMCH4(0.0), AMCO(0.0),
AMH2(0.0), AMC(0.0), AMO2(0.0), AMH2O(0.0): Defines extended eddy
breakup model coal combustion parameters.
VOPTION
– OPT1 (default). Combustible volatiles consist of C and H2
only.
– OPT2. Combustible volatiles consist of CH4, CO and H2 only.
– USER. User-defined volatile composition.
SOPTION
– SINGLE (default). Single-step oxidation mechanism.
– 2STEP. Two-step oxidation mechanism.
AMCH4
– CH4 mass fraction in volatiles.
AMCO
– CO mass fraction in volatiles.
AMH2
– H2 mass fraction in volatiles.
AMC
– C mass fraction in volatiles.
AMO2
– O2 mass fraction in volatiles.
AMH2O
– H2O mass fraction in volatiles.
COGLOBAL, OPTION, VOPTION, POPTION: Defines global coal
combustion model.
OPTION
15-18
– CONSERVED (default). Conserved scalars mixed-is-burned
model.
– EDDY. Eddy breakup model.
Version 3.26
Chapter 15
CHEMICAL MODULE
Coal Combustion
VOPTION
– COAL (default). Volatiles specific heat derived from coal
calorific values.
– CH4. Volatiles specific heat same as CH4.
– MASS. Uses mass-weighted specific heat based on volatile
composition.
POPTION
– PRINT (default). Coal combustion will be printed in output
file.
– NOPRINT. Coal combustion will not be printed in output file.
COMISC, FOXIN(0.233), FH2OIN(0.0), ZETA(0.2), CSPLIT(1.0),
QFAC(1.5), COALCV(3.0E7), DEVTMP(298.0): Defines miscellaneous
parameters for the coal combustion model.
FOXIN
– Mass fraction of oxygen at inlets.
FH2OIN
– Mass fraction of free moisture at inlets.
ZETA
– Char nitrogen to NOx conversion efficiency.
CSPLIT
– Fraction of N in volatiles.
QFAC
– Q-factor.
COALCV
– Coal calorific value.
DEVTMP
– Coal devolatilisation temperature.
COPANALYSIS, PAASH(0.14), PAH2O(0.0), PAVM(0.313), PAFC(0.547):
Defines the mass fractions for the proximate analysis of coal.
PAASH
– Mass fraction of ash.
PAH2O
– Mass fraction of inherent moisture content.
PAVM
– Mass fraction of volatile matter.
PAFC
– Mass fraction of fixed carbon.
COSCHAR, AKOC(1.3), ACTC(9.27E7): Defines the model constants for the
char burnout models.
Version 3.26
15-19
CHEMICAL MODULE
Chapter 15
Coal Combustion
AKOC
– Pre-exponential factor for the char combustion model.
ACTC
– Activation energy for the char combustion model.
COSTATUS: Displays the coal combustion modelling status.
COSUBMODEL, DOPTION, VOTIM(12.0), COPTION, CATIM(1.0),
DEVCAR(0.99): Defines the coal combustion sub-models.
DOPTION
– CONSTANT (default). Constant rate coal devolatilisation
model.
– SINGLE. Single-step devolatilisation model.
– 2STEP. Two competing steps devolatilisation model.
VOTIM
– Timescale for the constant rate devolatilisation model.
COPTION
– FIRST (default). First-order effective char burnout model.
– CONSTANT. Constant rate char combustion model.
– HALF. Half-order oxygen diffusion/chemical kinetic rate
model.
CATIM
– Timescale for the constant rate char burnout model.
DEVCAR
– Controls when char combustion will begin. Char combustion
will begin when the pyrolysis ratio is greater than DEVCAR.
COSVOLATILE, AKOV(2.0E4), ACTV(4.94E7), BTS1(0.0), BTS2(0.0),
ETS1(0.0), ETS2(0.0), APH1(0.0), APH2(0.0): Defines the model constants for
the various coal devolatilisation models.
15-20
AKOV
– Pre-exponential factor for the single-step devolatilisation
model.
ACTV
– Activation energies for the single step devolatilisation model.
BTS1
– First pre-exponential factor for the two competing steps
devolatilisation model.
BTS2
– Second pre-exponential factor for the two competing steps
Version 3.26
Chapter 15
CHEMICAL MODULE
Emissions
ETS1
– First activation energy for the two competing steps
ETS2
– Second activation energy for the two competing steps
APH1
– Mass stoichiometric coefficient for the one-reaction path.
APH2
– Mass stoichiometric coefficient for the two-reaction path.
COUANALYSIS, UAC(0.857), UAH(0.057), UAO(0.070), UAN(0.016):
Defines the mass fractions for the ultimate analysis of coal.
UAC
– Mass fraction of carbon.
UAH
– Mass fraction of hydrogen.
UAO
– Mass fraction of oxygen.
UAN
– Mass fraction of nitrogen.#
Emissions
NOX, ICSC, STATUS, THERMAL, TUCHIN(0.0), FACTOR(0.6), PROMPT,
FUEL: Turns NOx modelling on or off. After executing this command, except
when NOx modelling is turned off, pro-STAR will call the NOXC command to
prompt for 14 additional NOx constants. The user may hit return at this prompt to
accept the defaults or enter ‘NOCHANGE’ to leave the NOx constants unchanged
from previously defined values.
Version 3.26
ICSC
– Chemical reaction scheme number.
STATUS
– /ON/OFF/1/2/3/4/5/6/7/. Turns modelling on or off or uses one
of seven combinations:
Status
Equivalent Command
1
2
3
4
5
6
7
NOX, ON, ON, 20.0, 0.6, OFF, OFF
NOX, ON, OFF, , , OFF, ON
NOX, ON, OFF, , , ON, OFF
NOX, ON, ON, 20.0, 0.6, OFF, ON
NOX, ON, ON, 20.0, 0.6, ON, OFF
NOX, ON, OFF, , , ON, ON
NOX, ON, ON, 20.0, 0.6, ON, ON
15-21
CHEMICAL MODULE
Chapter 15
Emissions
If STATUS is not ON, then these remaining fields may be left blank:
THERMAL
– /ON/OFF/USER/.
TUCHIN,
FACTOR
– Only used if THERMAL is ON.
PROMPT
– /OFF/ON/USER/.
FUEL
– /OFF/ON/USER/.
NOXC, CONS1(1.8E+11), CONS2(3.8E+10), CONS3(1.8E+7),
CONS4(3.8E+6), CONS5(7.1E+10), CONS6(1.7E+11), CONS7(1.255E+4),
CONS8(-3.837E+4), CONS9(-425.), CONS10(-4.68E+3), CONS11(-2.082E+4),
CONS12(-450.), CONS13(-2.456E+4), CONS14(-3.109E+4): Specifies 14
additional constants for the NOX command. ‘NOCHANGE’ may be entered in the
CONS1 field to leave the constants unchanged (this will simply list the current
values of the constants).
SOOT, ICSC, STATUS, SGSCALE(1.0), FRSCALE(1.0), PISCALE(1.0),
OXSCALE(1.0): Specifies parameters used for modelling soot formation for a
given chemical reaction scheme.
ICSC
scheme must be a PPDF model with a subreaction model other
than MPPDF, or a LOCAL SOURCE diffusion flame model
(see command CRTYPE and command SBREACTION).
STATUS
– /OFF/ON/.
SGSCALE
– Scaling factor for surface growth rate.
FRSCALE
– Scaling factor for fragmentation rate.
PISCALE
– Scaling factor for particle inception rate.
OXSCALE
– Scaling factor for oxidation rate.
15-22
Version 3.26
Chapter 15
CHEMICAL MODULE
Complex Chemistry
Complex Chemistry
CHEREACTION, OPTION: Turns chemical reaction calculations on or off
(default).
OPTION
– /OFF/ON/
CHMSOLVER, OPTION: Defines the numerical method to be used for solving
the transport equations for a complex chemistry model.
OPTION
– POINT. The point-coupled method is activated.
– TIME. The time-split method is activated.
CKELEMENT, ICSC, OPTION, ELEM1, …, ELEM17: Defines chemical
elements for a complex chemistry model. Complex chemistry information for a
chemical reaction scheme is stored in a file named cplx.inpNN, where NN is the
chemical reaction scheme number (see also command CKFO, command CKLIST,
command CKREACTION, command CKRO, command CKSPECIES and
command CKTHIRD).
ICSC
scheme must be a complex chemistry model (see command
CRMODEL).
OPTION
– ADD (default). Adds a list of chemical elements to the file.
– REMOVE. Removes a list of chemical elements from the file.
– REMALL. Removes all chemical elements from the file.
(Note: There is no way to undo this option!)
– LIST. Lists the chemical elements currently in the file.
ELEM1, …, – A list of up to seventeen chemical elements to add or remove.
ELEM17
These fields are not used for the REMALL or LIST options.
The items in this list must be valid element symbols (for
example, H for hydrogen and FE for iron).
CKFO, ICSC, IREAC, OPTION: Defines forward reaction species concentration
exponents for a complex chemistry model reaction. Complex chemistry information
Version 3.26
15-23
CHEMICAL MODULE
Chapter 15
Complex Chemistry
for a chemical reaction scheme is stored in a file named cplx.inpNN, where NN
is the chemical reaction scheme number (see also command CKELEMENT,
command CKLIST, command CKREACTION, command CKRO, command
CKSPECIES, and command CKTHIRD).
ICSC
CRMODEL).
IREAC
– Reaction number. The reaction must exist in the file.
OPTION
– ADD,SPEC1,V1,SPEC2,V2,…,SPEC5,V5. Adds a list of up
to five forward reaction species and their associated exponents
to reaction IREAC. Each reaction may have no more than ten
forward reaction species. Adding a species that already exists
will simply change the exponent of the species to the new
given value.
– REMOVE,SPEC1,SPEC2,…,SPEC10. Removes a list of
forward reaction species from reaction IREAC.
– REMALL. Remove all forward reaction species from reaction
IREAC. (Note: There is no way to undo this option!)
CKLIST, ICSC, OPTION: Lists the complex chemistry information for a given
chemical reaction scheme. Complex chemistry information is stored in a file named
cplx.inpNN, where NN is the chemical reaction scheme number. Such a file can
be created or modified using command CKELEMENT, command CKFO,
command CKREACTION, command CKRO, command CKSPECIES or command
CKTHIRD.
ICSC
CRMODEL).
OPTION
– ALL (default). Lists the entire file.
– ELEMENTS. Lists elements only.
– SPECIES. Lists species only.
– REACTION,NREAC. Lists reaction number NREAC only. If
NREAC is zero or left blank, all reactions will be listed.
CKREACTION, ICSC, IREAC, OPTION: Defines chemical reactions for a
15-24
Version 3.26
Chapter 15
CHEMICAL MODULE
Complex Chemistry
complex chemistry model. Complex chemistry information for a chemical reaction
scheme is stored in a file named cplx.inpNN, where NN is the chemical reaction
scheme number (see also command CKELEMENT, command CKFO, command
CKLIST, command CKRO, command CKSPECIES, and command CKTHIRD).
ICSC
CRMODEL).
IREAC
– Reaction number. A chemical reaction scheme may have up to
500 complex chemistry reactions.
OPTION
– RSTRING,APRE(0.0),TEXP(0.0),EACT(0.0). Adds a new
reaction to the file, or overwrites an existing reaction. For this
option, if IREAC is left blank, it will default to the current
maximum reaction number in the file plus one. IREAC may
not be greater than this default value.
– RSTRING. The reaction string, which may not be more than
37 characters long. The left and right sides of the reaction
must be separated by one of the following: =, ⇒, or ⇔.
– APRE. Pre-exponential factor in the Arrhenius formula.
– TEXP. Temperature exponent.
– EACT. Activation energy.
– MODIFY,APRE(0.0),TEXP(0.0),EACT(0.0). Modifies the
parameters of an existing reaction IREAC, without changing
the reaction itself. APRE, TEXP, and EACT are defined as
above.
– REMOVE (default). Removes reaction IREAC from the file.
Note that this will renumber each reaction that appears after
reaction IREAC, so as to fill the gap left by the removed
reaction.
– REMALL. Removes all reactions from the file. For this option,
IREAC is ignored. (Note: There is no way to undo this
option!)
– LIST. Lists reaction IREAC. If IREAC is left blank, all
reactions currently in the file will be listed.
CKRO, ICSC, IREAC, OPTION: Defines backward reaction species
concentration exponents for a complex chemistry model reaction. Complex
chemistry information for a chemical reaction scheme is stored in a file named
cplx.inpNN, where NN is the chemical reaction scheme number (see also
command CKELEMENT, command CKFO, command CKLIST, command
CKREACTION, command CKSPECIES, and command CKTHIRD).
Version 3.26
15-25
CHEMICAL MODULE
Chapter 15
Complex Chemistry
ICSC
CRMODEL).
IREAC
– Reaction number. The reaction must exist in the file.
OPTION
to five backward reaction species and their associated
exponents to reaction IREAC. Each reaction may have no
more than ten backward reaction species. Adding a species that
already exists will simply change the exponent of the species
to the new given value.
backward reaction species from reaction IREAC.
– REMALL. Removes all backward reaction species from
reaction IREAC. (Note: There is no way to undo this option!)
CKSPECIES, ICSC, OPTION, SPEC1, …, SPEC17: Defines chemical species
for a complex chemistry model. Complex chemistry information for a chemical
reaction scheme is stored in a file named cplx.inpNN, where NN is the chemical
reaction scheme number (see also command CKELEMENT, command CKFO,
command CKLIST, command CKREACTION, command CKRO and command
CKTHIRD).
ICSC
CRMODEL).
OPTION
– ADD (default). Adds a list of chemical species to the file.
– REMOVE. Removes a list of chemical species from the file.
– REMALL. Removes all chemical species from the file. (Note:
There is no way to undo this option!)
– LIST. Lists the chemical species currently in the file.
SPEC1, …,
SPEC17
– A list of up to seventeen chemical species to add or remove.
Each species may have up to 16 characters. These fields are not
used for the REMALL or LIST options.
CKTHIRD, ICSC, IREAC, OPTION: Defines third-body reaction enhancement
factors for a complex chemistry model reaction. Complex chemistry information for
15-26
Version 3.26
Chapter 15
CHEMICAL MODULE
Complex Chemistry
a chemical reaction scheme is stored in a file named cplx.inpNN, where NN is
the chemical reaction scheme number (see also command CKELEMENT,
command CKFO, command CKLIST, command CKREACTION, command
CKRO, and command CKSPECIES).
ICSC
CRMODEL).
IREAC
– Reaction number. The reaction must exist in the file and must
be a third-body reaction. A third-body reaction is one that
contains a species ‘M’ on both sides of the equation (for
example: H + OH + M = H2O + M).
OPTION
to five third-body enhanced species and their associated
exponents to reaction IREAC. Each reaction may have no
more than ten third-body enhanced species. Adding a species
that already exists will simply change the exponent of the
species to the new given value.
third-body enhanced species from reaction IREAC.
– REMALL. Removes all third-body enhanced species from
reaction IREAC. (Note: There is no way to undo this option!)
COMCHECK, ICSC: Checks the reaction mechanism of a complex chemistry
model for the current reaction scheme.
ICSC
COMSET, ICSC: Sets up the reaction mechanism of a complex chemistry model
for the current reaction scheme.
ICSC
Version 3.26
15-27
CHEMICAL MODULE
Chapter 15
STAR/KINetics
MIXFRACTION, ICSC, RNUM, MIXF: Defines the mixture fraction of leading
reactants. This is either a constant (for premixed reactions) or the initial mixture
fraction value (for the Weller three-equation model).
ICSC
RNUM
– Reaction number.
MIXF
– Mixture fraction.
STAR/KINetics
CKBREGION, IREG(0), STATUS: Turns STAR/KINetics surface chemistry on
or off for a boundary region. STAR/KINetics modelling must be turned on globally
before using this command (see command CKIN). STAR/KINetics surface
chemistry must also be turned on before using this command (see command
CKPREP).
IREG
– Boundary region number. The region must be either wall or
baffle. The keyword ALL may be used in place of IREG to
specify all defined wall and baffle regions.
CKCTABLE, ICTID, STATUS, AREA(0.0): Turns STAR/KINetics surface
chemistry on or off for a cell table. STAR/KINetics modelling must be turned on
globally before using this command (see command CKIN). STAR/KINetics surface
chemistry must also be turned on before using this command (see command
CKPREP).
ICTID
– Cell table entry number. The default is the currently active cell
table (see command CTYPE). The cell table must be fluid,
and must have porosity turned on (see command CTABLE).
The keyword ALL may be used in place of ICTID to specify
all defined fluid cell tables.
STATUS
– /OFF/ON/.
AREA
– Internal surface area per unit volume. This is ignored if
STATUS if OFF.
15-28
Version 3.26
Chapter 15
CHEMICAL MODULE
STAR/KINetics
CKGOPTION, IMCELL(1), RELAX(0.0), IGNOPT, ITSTART(1),
ITEND(ITSTART), TIGNIT(273.15), ICTID: Sets STAR/KINetics gas-phase
chemistry options. STAR/KINetics modelling must be turned on globally before
using this command (see command CKIN).
IMCELL
– Monitoring cell number.
RELAX
IGNOPT
– NOIGNITION (default). Ignition will not be used. If this
option is chosen, then the ITEND, TIGNIT, and ICTID fields
are ignored.
– IGNITION. Ignition will be used.
ITSTART
– Starting iteration for chemistry (or ignition).
ITEND
– Ending iteration for ignition. This field is used only when
IGNOPT is IGNITION.
TIGNIT
– Ignition temperature. This field is used only when IGNOPT is
IGNITION.
ICTID
– Ignition cell type. The default is the currently active cell table
(see command CTYPE). The cell table must be fluid. This
field is used only when IGNOPT is IGNITION.
CKIN, STATUS: Activates or deactivates STAR/KINetics modelling.
STATUS
– /OFF/ON/.
CKMAT, IMAT(MATCUR), STATUS: Turns STAR/KINetics modelling on or
off for a specific material. STAR/KINetics modelling must be turned on globally
before using this command (see command CKIN).
IMAT
– Material number. The default is the currently active material
number (see command PMATERIAL). The material must be
fluid. The keyword ALL may be used in place of IMAT to
specify all defined fluid materials.
STATUS
– /ON/OFF/.
Version 3.26
15-29
CHEMICAL MODULE
Chapter 15
STAR/KINetics
CKPOST, STATUS, OPTION: Sets STAR/KINetics-related items to be output to
the transient post (.pstt) file. STAR/KINetics modelling must be turned on
globally before using this command (see command CKIN). This command is valid
only for transient cases.
STATUS
– /OFF/ON/.
OPTION
– /BULK/SITE/,INUM,/CONCENTRATION/PRODUCTION/.
Sets output of bulk or site species concentration or production
rate. INUM is the number of the species. The keyword ALL
may be used in place of INUM.
– SCALAR,ISC. Sets output of scalar ISC production rate. The
keyword ALL may be used in place of ISC.
– ENTHALPY,/GASPHASE/SURFACE/. Sets output of
gas-phase or surface enthalpy production rate.
CKPREP, GASCHEM, SURFCHEM, CHEMPROP: Sets STAR/KINetics
modelling options and writes STAR/KINetics files. STAR/KINetics modelling must
be turned on globally before using this command (see command CKIN).
GASCHEM
– /OFF/ON/. Gas chemistry is off or on.
SURFCHEM – /OFF/ON/. Surface chemistry is off or on.
CHEMPROP – /OFF/ON/. Properties are not (OFF) or are (ON) set using
STAR/KINetics.
Note: This command is not yet finished.
CKSFRACTION, OPTION: Sets STAR/KINetics site and bulk species fractions.
OPTION
– /SITE/BULK/. The user will be prompted to enter the fractions
for each site or bulk species.
CKSOPTION, IMCELL(1), RELAX(0.0): Sets STAR/KINetics surface
chemistry options. STAR/KINetics modelling must be turned on globally before
using this command (see command CKIN).
15-30
Version 3.26
Chapter 15
CHEMICAL MODULE
STAR/KINetics
IMCELL
– Monitoring cell number.
RELAX
Version 3.26
15-31
Chapter 16
POST MODULE
Housekeeping
Chapter 16
POST MODULE
Housekeeping
CLRWALL: Removes all the wall shells created upon first use of the GETWALL
command, setting the model back to its initial state.
HELP
or
PLIST: Lists the contents of the currently loaded post file.
STATUS: Displays the status of certain variables within this module. It also
displays a list of variables that are available for post-processing from the currently
loaded post file (see command LOAD) or transient file (see command TRLOAD).
SUBTITLE, OPTION: Allows the user to place up to two subtitles on each plot.
The user is prompted for the subtitles. If the user returns a blank line for either
subtitle, the subtitle will remain unchanged.
OPTION
– NONE to clear the subtitles to blank lines.
Loading Data
CGGCELL, PARAMETERS: Retrieves cell centred post-processing data from
Version 3.26
16-1
POST MODULE
Chapter 16
Loading Data
files that are compliant with the CFD General Notation System (CGNS)
specification and stores them in memory for printing, plotting, and other
manipulation. The data are considered constant over the volume of each cell. The
data are stored in the six available post registers as follows:
•
•
vector items are stored in the first three post registers;
scalar items are stored in the last three post registers.
All items currently stored in any of the 6 post registers are cleared each time a new
CGGC command is issued.
For the data to be plotted properly:
•
•
vector data corresponding to U, V, and W velocities are stored in post registers
one, two, and three, respectively;
scalar data in post register four.
The post-processing data are referenced by the CGNS data array labels which are
output during the CGNS grid import stage. When the three components of velocity
are referenced by their standard CGNS labels, they are automatically stored in post
registers one, two, and three. When attempting to load velocities into the scalar
registers, the CGNS velocity data labels must be prefixed with an ‘S’ to denote a
scalar velocity.
The CGNS post-processing data file name defaults to the file name of the last
CGNS grid imported. The file name is limited to 80 characters.
Additional Notes: It is assumed that the CGNS file contains one base node. The
post-processing data in all CGNS zones are stored.
PARAMETERS
– /CGNS FILENAME/. The name of the CGNS file where
the data is stored.
– /SOLUTION NODE/. The number of the solution node
where the post-processing data is stored.
– /VECTOR ARRAY NAME1/. CGNS data label for the
first vector quantity, usually corresponding to the U
component of velocity, is stored in register one.
second vector quantity, usually corresponding to the V
component of velocity, is stored in register two.
third vector quantity, usually corresponding to the W
component of velocity, is stored in register three.
– /SCALAR ARRAY NAME4/. CGNS data label for the
first scalar quantity, stored in register four. The scalar item
to be plotted must be stored in this register.
second scalar quantity, stored in register five.
third scalar quantity, stored in register six.
16-2
Version 3.26
Chapter 16
POST MODULE
Loading Data
CGGVERTEX, PARAMETERS: Retrieves vertex centred post-processing data
from files that are compliant with the CFD General Notation System (CGNS)
specification and stores them in memory for printing, plotting, and other
manipulation. The data are considered constant over the volume of each cell. The
data are stored in the six available post registers as follows:
•
•
vector items are stored in the first three post registers;
scalar items are stored in the last three post registers.
All items currently stored in any of the 6 post registers are cleared each time a new
CGGV command is issued.
For the data to be plotted properly:
•
•
vector data corresponding to U, V, and W velocities are stored in post registers
one, two, and three, respectively;
scalar data in post register four.
The post-processing data are referenced by the CGNS data array labels which are
output during the CGNS grid import stage. When the three components of velocity
are referenced by their standard CGNS labels, they are automatically stored in post
registers one, two, and three. When attempting to load velocities into the scalar
registers, the CGNS velocity data labels must be prefixed with an ‘S’ to denote a
scalar velocity.
The CGNS post-processing data file name defaults to the file name of the last
CGNS grid imported. The file name is limited to 80 characters.
Additional Notes: It is assumed that the CGNS file contains one base node. The
post-processing data in all CGNS zones are stored.
PARAMETERS
– /CGNS FILENAME/. The name of the CGNS file where
the data is stored.
– /SOLUTION NODE/. The number of the solution node
where the post-processing data is stored.
first vector quantity, usually corresponding to the U
component of velocity, is stored in register one.
second vector quantity, usually corresponding to the V
component of velocity, is stored in register two.
third vector quantity, usually corresponding to the W
component of velocity, is stored in register three.
first scalar quantity, stored in register four. The scalar item
to be plotted must be stored in this register.
second scalar quantity, stored in register five.
third scalar quantity, stored in register six.
Version 3.26
16-3
POST MODULE
Chapter 16
Loading Data
GETBOUNDARY, VECOPT, SCALAROPT
or
GETBOUNDARY, VECOPT
or
GETBOUNDARY, SCALAROPT: Defines which post-processing items the user
wishes to store in memory for printing, plotting and/or manipulation. The data are
boundary data and for plotting purposes they are considered constant over the area
of each cell face. Upon first use of this command or the GETWALL command,
pro-STAR automatically creates wall shells on the boundaries, with the following
cell types:
Cell Type
On Boundaries
MXTB+1
MXTB+2
MXTB+3
MXTB+4
Cyclic and symmetry non-partial boundaries
Wall non-partial boundaries
Other non-wall non-partial boundaries
Partial boundaries
The data can then be plotted (using WPLOT), printed, etc. with reference to any set
of wall shells.
Please bear in mind that the items that can be stored into memory depend on the
simulation setup. If a certain quantity is not being solved for, then it will not be
present in the results file. Issue the command PLIST to determine which items are
actually stored in the results file.
VECOPT
The following vector data can usually be loaded:
– ALL (default). Loads all three components of the standard
computational velocity into post registers 1-3.
– /U/V/W/. Loads only the U-, V- or W-component of the
standard computational velocity into post registers 1, 2 or 3,
respectively.
– NONE. No vector data will be loaded into post registers 1-3.
SCALAROPT The following scalar data can usually be loaded into post
register 4:
– NONE (default). No scalar data.
– /SU/SV/SW/. Scalar components of the standard
computational velocity.
– VMAGNITUDE. Scalar magnitude of the standard
16-4
Version 3.26
Chapter 16
POST MODULE
Loading Data
SCALAROPT – /P/PSTATIC/PTERMO/PTOTAL/,/RELATIVE/
/ABSOLUTE/. P stands for the computed pressure values (or
piezometric pressure). PSTATIC = P + rho0*g*h and is
applicable particularly in buoyancy problems. The rho0*g*h
term is calculated in pro-STAR on a per material basis, where
rho0 is a reference density value and h is the distance to the
datum, where rho0 is defined.
PTERMO = PSTATIC – 2./3.*rho*k (if the flow is turbulent,
in which case k is defined)
PTOTAL = PTERMO + .5*rho*V**2 + rho*k
(incompressible) or
PTERMO*(TTOTAL/T)**(GAMMA/(GAMMA-1))
(compressible flow). When ABSOLUTE is used, then the
default reference values specified in pro-STAR are added to
each computed cell value on a per material basis.
– CONC, NSC(1). Mass fraction of scalar species NSC.
– /RSUU/RSVV/RSWW/RSUV/RSVW/RSUW/. Normal and
shear Reynolds stresses.
– /V22/F22/A2/. V2F and Suga non-linear KEA2 stresses. ED
is used for V t in the Spalart-Allmaras model or OMEG in the
k-ω models.
– G. P1 radiation intensity.
– /COND/CP/DENSITY/ED/ENTHALPY/LAMVISC/
/MACH/TE/VIS/. Other scalar items.
GETCELL, VECOPT, SCALAROPT
or
GETCELL, VECOPT
or
GETCELL, SCALAROPT: Defines which post-processing items the user wishes
to store in memory for printing, plotting and other manipulation. The data are stored
as cell data and are considered constant over the volume of each cell. All items
currently stored in any of the six post registers are cleared each time a new
GETCELL command is issued.
VECOPT
Version 3.26
16-5
POST MODULE
Chapter 16
Loading Data
VECOPT
respectively.
– FLAV. Loads the FLux Averaged Velocity into post registers
1-3.
– FLUX. All six mass flux components are loaded
simultaneously. The fluxes can then be displayed on an
EHIDDEN contour plot and/or summed using the
FLUXSUM command. Individual flux components may be
loaded using one of /F1/F2/F3/F4/F5/F6/. If any of these flux
options are chosen, no SCALAROPT may be used.
register 4:
– /P/PSTATIC/PTERMO/PTOTAL/,/RELATIVE/
rho0 is a reference density value and h is the distance to the
(incompressible) or
– /T/TTOTAL/TU/,/ABSOLUTE/RELATIVE/. Temperature,
total temperature or unburnt fuel temperature. When
ABSOLUTE is used, then the default reference values
specified in pro-STAR are added to each computed cell value
on a per material basis.
– TWOLAYER. Cells within the boundary layer will have a
value of 1.0, cells in the near-wall layer will have a value of
0.0 and all other cells will have a value of –1.0.
– FMU. The value of FMU will be extracted for both boundary
and near-wall layer cells from the post data file which was
connected using the LOAD command. The unused cells will
have a value of 1.0.
16-6
Version 3.26
Chapter 16
POST MODULE
Loading Data
SCALAROPT – /RSUU/RSVV/RSWW/RSUV/RSVW/RSUW/. Normal and
is used for V t in the Spalart-Allmaras model or OMEG in the
k-ω models.
/MACH/TE/VIS/VOIDFRACTION/. Other scalar items.
GETDROPLET, OPTION: Loads droplet data for plotting. The data can be
results from the transient post file (case.pstt), droplet initial conditions as
specified in the DROPLET module or droplet/particle values stored in the track file.
OPTION
– POST. Data are loaded from the current post data file.
– INIT. Data are loaded from the currently defined initial
conditions (DROPLET module).
– TRACK,LF(case.trk),/PARTICLE/STREAK/. Data will
be loaded from the track file LF pertaining to either droplets or
particles and the values will be plotted as particles or colour
contoured streaks.
GETUSERDATA, LF(case.usr), DATATYPE, DOPTION, FOPTION,
NFILES(0), NOFFSET(0), INITOPT
or
GETUSERDATA, LF(case.usr), SURF: Reads a file of vertex or cell data into
the post registers. This data can be plotted, printed or otherwise manipulated exactly
as if it had come from the post-processing file (case.pst). The user will be
prompted for a data label and units definition that will then be put on any plots the
user subsequently makes.
LF
DATATYPE – VERT. The data are vertex data.
– CELL. The data are cell data.
– SURF. This option is for STAR/KINetics surface data written
out by STAR. The user is then prompted to choose from a list
of variables, and data corresponding to that variable are stored
in post register 4. WPLOT can be used to plot the data.
Version 3.26
16-7
POST MODULE
Chapter 16
Loading Data
DATATYPE – CELG. This option is for general cell data written out by
STAR. The user is prompted to choose from a list of variables,
and data corresponding to that variable are stored in post
register 4. CPLOT can be used to plot the data.
DOPTION
– SCALAR. The data are SCALAR data (one data item per
record) and will be stored in post register 4.
– VECTOR. The data are VECTOR data (three data items per
record) and will be stored in post registers 1-3.
– BOTH. The data are three VECTOR items followed by one
SCALAR item and will be stored in post registers 1-4.
– ALL. The data are three VECTOR items followed by three
SCALAR items and will be stored in post registers 1-6.
– /1/2/3/4/5/6/. The data are SCALAR data (one data item per
record) and will be stored in the specified post register.
FOPTION
– CODED. The input file is coded (ASCII) and all data are in the
format: Cell or Vertex, 1-6 data items (I9,6X,6G16.9).
– BINARY. The input file is binary (unformatted) and data are in
the order: Cell or Vertex, 1-6 data items.
– USER. The input file is coded (ASCII) and the user will be
prompted for a FORTRAN format specification describing the
data records. Data records not conforming to the specification
will be skipped.
– FREE. The input file is in free format (i.e. arbitrary length
fields separated by blanks or commas). Records in free format
cannot have any non-numeric characters present (other than
the negative sign or the characters ‘e’ or ‘E’ denoting the
exponent).
NFILES
– Up to 100 files can be specified. If NFILES > 0, this command
will prompt for the names of the files and these can be loaded
sequentially using the ULOAD command. If NFILES = 0, the
current file LF will be the only loaded user file.
NOFFSET
– Offset to add to the cell or vertex numbers in the file.
INITOPT
– INITIAL. The post registers are initialised to zero before
reading in new data.
– NOINITIAL. The post registers are not initialised before
reading in new data. This allows files to add to what is already
in the post registers.
GETVERTEX, VECOPT, SCALAROPT, REFOPTION, IMAT(1)
or
GETVERTEX, VECOPT
or
16-8
Version 3.26
Chapter 16
POST MODULE
Loading Data
GETVERTEX, SCALAROPT, REFOPTION, IMAT(1): Defines which
post-processing items the user wishes to store in memory for printing, plotting and
other manipulation. The data are stored as vertex data. All items currently stored in
any of the six post registers are cleared each time a new GETVERTEX command
is issued.
VECOPT
respectively.
– COOR. Loads vertex coordinates from analyses with moving
meshes into post registers 1-3. The user can then plot using
the deformed geometry.
register 4:
– /P/PSTATIC/PTERMO/PTOTAL/,/RELATIVE/
rho0 is a reference density value and h is the distance to a
(incompressible) or
Version 3.26
16-9
POST MODULE
Chapter 16
Loading Data
SCALAROPT – /T/TTOTAL/TU/. Temperature, total temperature or unburnt
fuel temperature.
– STREAM. Stream function for two-dimensional models.
– /RSUU/RSVV/RSWW/RSUV/RSVW/RSUW/. Normal and
is used for Vt in the Spalart-Allmaras model or OMEG in the
k-ω models.
/MACH/TE/VIS/. Other scalar items.
REFOPTION – For P, PSTATIC and PTOTAL, REFOPTION defaults to
RELATIVE. For T, TTOTAL and TU, REFOPTION defaults
to ABSOLUTE. When ABSOLUTE is used, then the default
reference values specified in pro-STAR are added to each
computed vertex value on a per material basis.
IMAT
– pro-STAR cannot associate vertices with a material number.
Therefore, when calculating items such as PSTAT or
T,ABSO, a reference material must be given. The reference
value for this material is then added to the computed values
for all vertices. In cases involving multiple materials
(multiple fluid streams and/or conjugate heat transfer) where
the reference pressures or temperatures vary per material, the
user must take care to look at only one material property set
at a time. Alternatively, the user can load cell data, where the
appropriate reference values can be loaded per material.
GETWALL, WALLOPT: Defines which wall data items the user wishes to store
in memory for printing, plotting and/or manipulation. Upon first use of this
command or the GETBOUNDARY command, pro-STAR automatically creates
wall shells on the boundaries, with the following cell types:
Cell Type
On Boundaries
MXTB+1
MXTB+2
MXTB+3
MXTB+4
Partial boundaries
of wall shells.
16-10
Version 3.26
Chapter 16
POST MODULE
Loading Data
WALLOPT
Version 3.26
– Vector items (placed in post registers 1-3):
– FXYZ. Shear force vector.
– /FX/FY/FZ/FXY/FXZ/FYZ/. Loads only specified
components of the shear force vector. FX indicates load only
x-component, FXY indicates load only x- and y-components,
etc.
– FTOT,/P/PSTAT/,/RELA/ABSO/. Total force vector
calculated using piezometric pressure (P) or static pressure
(PSTAT). The pressure can be either relative (RELA) or
absolute (ABSO).
– /FTX/FTY/FTZ/FTXY/FTXZ/FTYZ/,/P/PSTAT/,
/RELA/ABSO/. Loads only specified components of the total
force vector. FTX indicates load only x-component, FTXY
indicates load only x- and y-components, etc.
16-11
POST MODULE
Chapter 16
Loading Data
WALLOPT
16-12
– Scalar items (placed in post register 4):
– SFXYZ. Shear force magnitude.
– /SFX/SFY/SFZ/. Magnitude of x-, y- or z-components of the
shear force.
– SFTOT,/P/PSTAT/,/RELA/ABSO/. Total force magnitude,
calculated using piezometric pressure (P) or static pressure
(PSTAT). The pressure can be either relative (RELA) or
absolute (ABSO).
– /SFTX/SFTY/SFTZ/,/P/PSTAT/,/RELA/ABSO/. Magnitude
of x-, y- or z-components of the total force.
– DISTANCE. Centroidal normal distance of near-wall cell
from the wall.
– YPLUS. Dimensionless normal distance from the wall.
– TEMPERATURE. Wall temperature.
– HTRANSFER. Heat transfer wall function.
– MTRANSFER,NSC(1). Mass transfer wall function for
scalar species NSC.
– HFLUX. Heat flux at the wall.
– MFLUX,NSC(1). Mass flux at the wall for scalar species
NSC.
– TIRAD. Thermal incident radiation.
– TRAD. Thermal radiosity.
– SIRAD. Solar incident radiation.
– SRAD. Solar radiosity.
– NEARWALL. Places the value of the currently loaded cell
post data for the cell nearest each wall in to the wall post slot.
– PATFLUX,PATCH_NUM,/RECEIVE/TRANSMIT/,
/FLUX/PERCENTAGE/. Post-processes the radiative heat
flux for patch number PATCH_NUM.
– PATCH_NUM. Patch number of the patch to be analysed.
– /RECEIVE/TRANSMIT/. Determines whether the analysis
is based on received or transmitted radiation.
– RECEIVE. For the selected patch, calculate and plot
incident radiative heat flux from all other patches by
post-processing radiosity flux (FLUXJ in file
case.pst) and view factor (VFAC in file case.vfc).
– TRANSMIT. For the selected patch, calculate and plot its
radiative heat flux (FLUXI in file case.pst) to all
other patches by post-processing radiosity flux and view
factor.
– /FLUX/PERCENTAGE/. Measurement units for radiative
heat flux.
– FLUX. Radiative heat flux is measured in Watts.
– PERCENTAGE. Radiative heat flux is a percentage of the
total amount of incident or emitted radiative heat flux for
that patch.
Version 3.26
Chapter 16
POST MODULE
Loading Data
WALLOPT
– Calculated items (placed in post register 4):
– HCOEF,TBULK(TDATUM). Heat transfer coefficient.
TBULK is the bulk mean temperature.
– MCOEF,MBULK(0.0),NSC(1). Mass transfer coefficient.
MBULK is the bulk mean mass fraction for scalar species
NSC.
– TAW. Please note: The command is primarily intended to
provide estimates of the Adiabatic Wall Temperatures for
adiabatic walls when turbulent wall functions are employed,
but will return values for all walls, regardless of imposed
thermal boundary condition, even when wall functions are
not employed.
An adiabatic wall temperature will be calculated from the
near wall conditions using the following definition:
2
2
V parallel
V normal
TAW = T s + 0.5 ----------------- + 0.5 ------------------ ( Pr T )
cp
cp
– where T s is the static temperature in the near wall cell,
V normal is the velocity normal to the wall (often zero or very
small), V parallel is the velocity parallel to the wall (relative to
any wall motion), c p is the specific heat (evaluated at T s if
variable), and the Pr T is the turbulent Prandtl number as
input by the user with the turbulence model (defaults to 0.9).
GMAP, IREGS, IREGC, IGV, IGC, RANGE: Maps values from graph registers
to post registers for cells or vertices. This command is used to map one-dimensional
profiles of data onto the model.
IREGS
– Post register number to store the interpolated values.
IREGC
– Post register containing the cell or vertex coordinate at which
the value is to be interpolated. This may be stored by using the
OPERATE,GETC,X,… or the OPERATE,GETV,X,… type
commands.
IGV
– Graph register containing values to be mapped.
IGC
– Graph register containing coordinates at which the values in
graph register IGV are located.
RANGE
– If cell values, one of /NC1,NC2,NCINC/CSET/ALL/. If vertex
values, one of /NV1,NV2,NVINC/VSET/ALL/.
Version 3.26
16-13
POST MODULE
Chapter 16
Loading Data
LOAD, LF(case.pst), MOVOPT: Opens the STAR post-processing file. The
user may switch among different post files (from different iterations, for example)
by reissuing this command. The SMAP file could also be read using this command
provided that the SMAP is performed using a post file with version 3.20 or higher.
LF
– Name of post file.
MOVOPT
– NOMVG. Does not apply any events to bring the current
geometry up to the time indicated on the post file. The current
geometry will remain unchanged.
– MVGRID. Applies all events to the current geometry to match
the time to that stored on the post file. The current geometry is
updated. An events file must be connected
(EVFILE,CONNECT) for this option to operate correctly.
SAVUSERDATA, LF(case.usr), DOPTION, FOPTION, RANGE: Writes
the currently stored cell, vertex or wall post data to a file.
LF
– Name of file to write data to.
DOPTION
– SCALAR (default). The scalar post register (4) will be written.
– VECTOR. The vector post registers (1, 2 and 3) will be
written.
– BOTH. Both the vector and the scalar post registers (1 to 4)
will be written.
– ALL. All post registers (1 to 6) will be written.
– /1/2/3/4/5/6/. A single post register will be written.
FOPTION
– CODED (default). The output file is coded (ASCII) and will be
written in the format: Cell or Vertex Number, 1-6 data items
(I9,6X,6G16.9).
– BINARY. The output file is binary (unformatted) and will be
written in the order: Cell or Vertex Number, 1-4 data items.
– USER. The output file is coded (ASCII) and the user will be
prompted for a FORTRAN format specification describing the
data records.
RANGE
– Defines which cells/vertices for which to write post data. If cell
or wall post data is loaded, one of
/ALL/CSET/NC1,NC2,NCINC/. If vertex post data is loaded,
one of /ALL/VSET/ /NV1,NV2,NVINC/. The default is ALL.
STORE, STOPT: Stores a time step location from a transient data file for loading
16-14
Version 3.26
Chapter 16
POST MODULE
Loading Data
post data. The default is always the last (or only) time step in the data file.
STOPT
– ITSTEP,ITNUM. Stores a given time step by its step number
ITNUM.
– TIME,T. Stores a given time step by its time T. If the
interpolation flag is turned on using the TRINTERPOLATE
command, an intermediate time may be specified in which case
the data is interpolated using values at the two adjacent time
steps.
– FIRST. Stores the first time step in the file.
– NEXT. Stores the time step immediately following the
currently loaded step.
– LAST. Stores the last time step in the file.
TRLOAD, LF(case.pstt), OPTION, NFILES(0): Opens one or more STAR
transient data files and lists their time step information.
LF
– Name of the transient file. This field is ignored if NFILES is
greater than 0.
OPTION
– NOMVGR. Moving grid operations are turned off. Thus,
cell/vertex values can be viewed without executing the moving
grid operations that are time intensive. However, results of cell
averaging schemes will be incorrect in this case. This is the
only valid OPTION for analyses without moving grid
operations.
– MVGRID. Moving grid operations are turned on. This is the
default for analyses with moving grid operations. If events
processing was initiated, a valid events file must be connected
before loading post data (see command EVFILE).
– NFILES. The number of transient files to load. If NFILES = 0,
file LF will be the only transient file loaded. If NFILES > 0, the
LF field will be ignored, and the command will instead prompt
for the names of the transient files, which will then be loaded
sequentially. NFILES can not be greater than 100.
TRUNCATE, TSTEP (currently stored time step): Places an (irremovable) end
of file mark on a STAR transient post data file (which has been connected using the
TRLOAD command) at the indicated time step. This is useful in situations such as
transient particle tracking when the solution beyond a certain point diverges or must
be ignored for some reason.
Version 3.26
16-15
POST MODULE
Chapter 16
Manipulating Data
TSTEP
– Time step number at which the solution is no longer valid.
ULOAD, OPTION: Loads user data from previously defined user files that have
been connected using the GETUSERDATA command. NFILES files can be
connected; see the GETUSERDATA help for more details.
OPTION
– FIRST (default). Loads user data from the first connected file.
– NEXT. Loads user data from the next connected file.
– LAST. Loads user data from the last (NFILES-th) connected
file.
– FILEN(1). Loads connected file number FILEN.
– LIST. Lists the names of the files that have been connected.
Manipulating Data
CAVERAGE, NC1, NC2, NCINC, OPTION: Produces a set of vertex data by
computing an inverse distance weighted average of all the centroidal post data
variables of the cells connected to each respective vertex. The boundary conditions
are NOT retained by this process. After averaging, the post data are treated as vertex
data and the user will see smooth contours rather than checkerboard effect,
characteristic of cell data contour plots. After using this command, wall data may
be plotted with either the WPLOT or CPLOT commands.
Using NC1, NC2 and NCINC to cut down on the list of cells included in the
averaging computation may be useful in multistream analyses (for example, where
the user does not wish the program to average the values from two different streams
at a single baffle). It may also be used to prevent the program from averaging in
shells that have been defined for display purposes, but have no data values
associated with them. Regardless of the range used, solid cells are included only for
the temperature solution when conjugate heat transfer is turned on.
16-16
NC1, NC2,
NCINC
– Initial set defined by NC1 to NC2 by NCINC which
determines the cells to be included in the averaging process.
ALL or CSET may be used in place of NC1.
OPTION
– BOTH. Both slave and master vertices across coupled
interfaces will be interpolated with respect to the adjacent face
they lie in.
– SLAVE. Only slave vertices will be interpolated.
– MASTER. Only master vertices will be interpolated.
Version 3.26
Chapter 16
POST MODULE
Manipulating Data
14.1, 14.2, 15.1
CHANGE, RANGE, A(1.), B(0.), NREG1(1), NREG2(6): Changes the values of
all currently stored post data items by the formula NEW VALUE = A * OLD
VALUE + B. This can be used to change the units of an item or (in conjunction with
the UPDATE command) modify the restart file in some manner. All changes made
are lost when new data are loaded unless the UPDATE command is used to make
them permanent.
RANGE
– Defines the range of items to be averaged.
– For cell data one of /ALL,,/CSET,,/NC1,NC2,NCINC/.
– For vertex data one of /ALL,,/VSET,,/NV1,NV2,NVINC/.
A, B
– Coefficients to use in changing values as defined above.
NREG1,
NREG2
– Only post registers NREG1 to NREG2 will be changed. The
default is post registers 1 to 6.
DGENERATE, NSET, NOFF, N1(1), N2(N1), NINC(1): Takes the loaded set of
cell or vertex post data and generates a new set for which the cell (or vertex)
numbers are incremented by NOFF, while the actual values are the same as the
original set. This can be helpful in constructing post plots for problems with cyclic
geometry. The range may be specified by CSET if cell data are loaded or VSET if
vertex data are loaded.
Warning: Do not use the UPDATE command to attempt to modify the post data
file (case.pst) after using DGENERATE to create data for cells that did not
originally exist on the post data file. It will not work! DGENERATE will also not
work with wall data.
NSET
– The number of times that the data are repeated (NSET must be
at least 2 to generate anything new).
NOFF
– The cell or vertex offset from the original data to each set of
generated data.
N1
– Starting number of original data set.
N2
– Ending number of original data set.
NINC
– Increment of original data set.
Version 3.26
16-17
POST MODULE
Chapter 16
Manipulating Data
OPERATE, FUNCTION, PARAMETERS: Allows the user to load any cell or
vertex variable on one or more post data files (which are connected using the LOAD
command) and/or perform vector arithmetic on one or more variables. The user is
allowed to store up to six data items at any one time in post registers 1 to 6. After
performing appropriate calculations, the user may use all of the other features found
in pro-STAR to print, sort, average and plot contours of the newly created data. Data
used for contour plotting and sorting must be stored in register number 4 only. Data
used for vector plotting must be stored in registers 1,2 and 3 corresponding to the
X, Y and Z directions. In every operation below, the data to be operated on resides
in IREG1 (and IREG2 if applicable). The resultant is then stored in IREGS. IREGS
may, in all cases, be the same as one of the starting registers.
Multiregister Functions
16-18
Function
Parameters
Definition
ADD
IREG1,IREG2,IREGS
V(IREGS)=V(IREG1)+V(IREG2)
SUBT
IREG1,IREG2,IREGS
V(IREGS)=V(IREG1)-V(IREG2)
MULT
IREG1,IREG2,IREGS
V(IREGS)=V(IREG1)*V(IREG2)
DIVI
IREG1,IREG2,IREGS
V(IREGS)=V(IREG1)/V(IREG2)
X**Y
IREG1,IREG2,IREGS
V(IREGS)=ABS(V(IREG1))**V(IREG2)
MAX
IREG1,IREG2,IREGS
V(IREGS)=MAX(V(IREG1),V(IREG2))
MIN
IREG1,IREG2,IREGS
V(IREGS)=MIN(V(IREG1),V(IREG2))
SWAP
IREG1,IREG2
Registers IREG1 and IREG2 are swapped
CLEAR
IREG1,IREG2,IRINC
V(IREG)=0.,IREG=IREG1,IREG2,
IRINC
VMAG
None
V(4)=SQRT(V(1)**2+V(2)**2+
V(3)**2)
ROTATE
IPSYS
Rotates currently stored vector components to another system. The vectors are
assumed to exist in the global Cartesian
system
UNROTATE None
Rotates vectors from current local system
back to global
REFRAME
LOCAL,ICSYS(1),
OMEGA(RPM)
Subtracts R*OMEGA from all velocities.
R is about the Z axis of coordinate system
ICSYS
REFRAME
COMPUTATIONAL
Translates velocities from the stationary
reference frame back to the computational
frame.
Version 3.26
Chapter 16
POST MODULE
Manipulating Data
Multiregister Functions
Function
Parameters
Definition
REFRAME
STATIC
Translates velocities from the computational reference frame back to the static
frame.
GRADIENT SOLIDOPT(N/Y),
ICSYS(1)
Takes the gradient of the (vertex) scalar
data stored in register 4. The vector components of the gradient (ds/dx, ds/dy,
ds/dz) will be stored in registers 1 to 3,
while the magnitude of this gradient vector will be stored in register 4 (overwriting
the original data). The gradient is calculated with respect to coordinate system
ICSYS. If SOLIDOPT = N, the gradient is
calculated for fluid cells only. If
SOLIDOPT = Y, then the gradient is calculated for both fluid and solid cells.
/CURL/
ROTOR/
SOLIDOPT(N/Y),
ICSYS(1)
Takes the curl (rotor) of the (vertex) vector
data stored in registers 1 to 3. The
cell-centred vector components of the curl
will be stored in registers 1 to 3 (overwriting the original data), while the curl magnitude will be stored in register 4. The curl
is calculated with respect to coordinate
system ICSYS. If SOLIDOPT = N, the
curl is calculated for fluid cells only. If
SOLIDOPT = Y, then the curl is calculated for both fluid and solid cells.
SNRM
/VERT/CELL/
Computes the cell or vertex average surface normal and stores them in registers 1
-3
FAVERAGE IREG
Computes face-averaged data from the
(vertex) data currently stored in register
IREG.
* Both UNROTATE and REFRAME assume that three velocity components are
stored in registers 1, 2 and 3.
Scalar/Vector Functions
Function
Parameters
Definition
(For each of these functions, PI or E may be entered for scalar value S.)
Version 3.26
16-19
POST MODULE
Chapter 16
Manipulating Data
Scalar/Vector Functions
Function
Parameters
Definition
SADD
S,IREG1,IREGS
V(IREGS)=S+V(IREG1)
SSUB
S,IREG1,IREGS
V(IREGS)=S–V(IREG1)
SMUL
S,IREG1,IREGS
V(IREGS)=S*V(IREG1)
SDIV
S,IREG1,IREGS
V(IREGS)=S/V(IREG1)
V**S
S,IREG1,IREGS
V(IREGS)=ABS(V(IREG1))**S
FILL
S,IREGS
V(IREGS)=S
Single Register Functions
Function
Parameters
Definition
SINE
IREG1,IREGS
V(IREGS)=SIN(V(IREG1))
ASIN
IREG1,IREGS
V(IREGS)=ASIN(V(IREG1))
COSI
IREG1,IREGS
V(IREGS)=COS(V(IREG1))
ACOS
IREG1,IREGS
V(IREGS)=ACOS(V(IREG1))
TANG
IREG1,IREGS
V(IREGS)=TAN(V(IREG1))
ATAN
IREG1,IREGS
V(IREGS)=ATAN(V(IREG1))
X**2
IREG1,IREGS
V(IREGS)=V(IREG1)**2
SQRT
IREG1,IREGS
V(IREGS)=V(IREG1)**.5
CUBR
IREG1,IREGS
V(IREGS)=V(IREG1)**.33333
ABSO
IREG1,IREGS
V(IREGS)=ABS(V(IREG1))
LOGN
IREG1,IREGS
V(IREGS)=LN(V(IREG1))
ALOG
IREG1,IREGS
V(IREGS)=INV LN(V(IREG1))
INVERT
IREG1,IREGS
V(IREGS)=1./V(IREG1)
COPY
IREG1,IREGS
V(IREGS)=V(IREG1)
NORMALIZE
IREG1,IREGS
V(IREGS)=V(IREG1)/ABS(LARGEST
MEMBER OF V(IREG1))
CLIP
IREG1,VMIN,VMAX,IREGS,N1,N2,NINC. (This function can
be used on a range or CSET instead of the entire list.)
V(IREGS)=MAX(VMIN,V(IREG1))
AND MIN(VMAX,V(IREG1))
16-20
Version 3.26
Chapter 16
POST MODULE
Manipulating Data
Cell Data Functions
Version 3.26
Function
Parameters
Definition
GETC
/X/Y/Z/,ICSYS(1),
IREGS,/RADI/DEGR/
Loads the /X/Y/Z/ cell centroid coordinates
in local system ICSYS into register IREGS.
If the coordinate is an angle (Y for cylindrical systems, Y and Z for spherical systems), than one can specify whether the
angles are to be loaded in radians (default)
or degrees.
GETC
VOLU,IREGS
Loads fluid and solid cell volumes into register IREGS.
GETC
AREA,IREGS
Loads the shell and baffle cell areas into
register IREGS.
GETC
LENGTH,IREGS
Loads line cell lengths into register IREGS.
GETC
CELL POST DATA
ITEM,IREGS
Loads a cell post data item into register
IREGS. Valid cell post data items include:
/COND/CP/DENS/ED/ENTH/F1/F2/F3/
/F4/F5/F6/FMU/G/LAMV/MACH/RSUU/
/RSUV/RSUW/RSVV/RSVW/RSWW/
/V22/F22/A2/SU/SV/SW/TE/TWOL/VIS/
/VMAG/VOID/
See the GETCELL command for definitions. Note that the following cell post data
items require more arguments:
/CONC/P/PSTAT/PTERM/PTOT/T/TTOT/
/TU/
These items are described below.
GETC
CONC,IREGS,NSC(1) Loads the mass fractions of scalar species
NSC into register IREGS.
GETC
/P/PSTAT/PTERM/
/PTOT/, IREGS,
/RELA/ABSO/
GETC
/T/TTOT/TU/, IREGS, Loads the absolute or relative temperatures
/ABSO/RELA/
into register IREGS.
Loads the relative or absolute pressures
(piezometric, thermodynamic, static or
total) into register IREGS.
16-21
POST MODULE
Chapter 16
Manipulating Data
Cell Data Functions for Dispersed Phase on Eulerian Multiphase
16-22
Function
Phase No.
Parameters
Definition
EGEC
PHASE(2)
/X/Y/Z/,ICSYS(1),
IREGS,/RADI/DEGR/
Loads the dispersed phase
/X/Y/Z/ cell centroid coordinates in local system ICSYS
into register IREGS. If the
coordinate is an angle (Y for
cylindrical systems, Y and Z
for spherical systems), then
one can specify whether the
angles are to be loaded in
radians (default) or degrees.
EGEC
PHASE(2)
VOLU,IREGS
fluid and solid cell volumes
EGEC
PHASE(2)
AREA,IREGS
shell and baffle cell areas into
register IREGS.
EGEC
PHASE(2)
LENGTH,IREGS
line cell lengths into register
IREGS.
EGEC
PHASE(2)
CTYPE,IREGS
cell table numbers into register IREGS.
EGEC
PHASE(2)
CELL POST DATA
ITEM,IREG
Loads a dispersed phase cell
post data item into register
IREGS. Valid cell post data
items include:
/VIS/DENS/LAMV/DP/
/MOMT/VMAG/VOID/
/COND/F1/F2/F3/F4/F5/F6/
/SU/SV/SW/
See command EGECELL for
definitions.
EGEC
PHASE(2)
CONC,IREGS,NSC(1) Loads the dispersed phase
mass fractions of scalar species NSC into register
IREGS.
Version 3.26
Chapter 16
POST MODULE
Manipulating Data
Vertex Data Functions
Function
Parameters
Definition
GETV
/X/Y/Z/,ICSYS(1),
IREGS,/RADI/DEGR/
Loads the /X/Y/Z/ vertex coordinates in
local system ICSYS into register IREGS. If
the coordinate is an angle (Y for cylindrical
systems, Y and Z for spherical systems),
then one can specify whether the angles are
to be loaded in radians (default) or degrees.
GETV
VERTEX POST DATA Loads a vertex post data item into register
ITEM,IREGS
IREGS. Valid vertex post data items
include:
/COND/CP/DENS/ED/ENTH/G/LAMV/
/MACH/RSUU/RSUV/RSUW/RSVV/
/RSVW/RSWW//V22/F22/A2/SU/SV/SW/
/TE/VIS/VMAG/VOID/
See the GETVERT command for definitions. Note that the following vertex post
data items require more arguments:
/TU/
GETV
GETV
/P/PSTAT/PTERM/
/PTOT/, IREGS,
/RELA/ABSO/
GETV
/ABSO/RELA/
Vertex Data Functions for Dispersed Phase on Eulerian Multiphase
Version 3.26
Function
Phase No.
Parameters
Definition
EGEV
PHASE(2)
/X/Y/Z/,ICSYS(1),
IREGS,/RADI/DEGR/
/X/Y/Z/ vertex coordinates in
local system ICSYS into register IREGS. If the coordinate is an angle (Y for
cylindrical systems, Y and Z
for spherical systems), then
one can specify whether the
angles are to be loaded in
16-23
POST MODULE
Chapter 16
Manipulating Data
Vertex Data Functions for Dispersed Phase on Eulerian Multiphase
Function
Phase No.
Parameters
Definition
EGEV
PHASE(2)
VERTEX POST DATA Loads a dispersed phase verITEM,IREGS
tex post data item into register IREGS. Valid vertex post
data items include:
/DP/DENS/LAMV/MOMT/
/SU/SV/SW/VIS/VMAG/
/VOID/COND/
See command EGEVERTEX for definitions.
EGEV
PHASE(2)
CONC,IREGS,NSC(1) Loads the dispersed phase
mass fractions of scalar species NSC into register
IREGS.
Boundary Data Functions
16-24
Function
Parameters
Definition
GETB
/X/Y/Z/,ICSYS(1),
IREGS,/RADI/DEGR/
Loads the /X/Y/Z/ boundary centroid coordinates in local system ICSYS into register
IREGS. If the coordinate is an angle (Y for
cylindrical systems, Y and Z for spherical
systems), then one can specify whether the
or degrees.
GETB
AREA,IREGS
Loads the boundary areas into register
IREGS.
GETB
BOUNDARY POST
DATA ITEM,IREGS
Loads a boundary post data item into register IREGS. Valid boundary post data items
are:
/SU/SV/SW/TE/ED/VIS/DENS/
/LAMV/CP/.
/COND/MACH/VMAG/ENTH/VOID/G/
/AREA/RSUU/RSUV/RSUW/RSVV/
/RSVW/RSWW/V22/F22/A2/.
See the GETB command for definitions.
Note that the following boundary post data
/TU/.
Version 3.26
Chapter 16
POST MODULE
Manipulating Data
Boundary Data Functions
Function
Parameters
Definition
GETB
GETB
/P/PSTAT/PTERM/
/PTOT/, IREGS,
/RELA/ABSO/
GETB
/ABSO/RELA/
Boundary Data Functions for Dispersed Phase on Eulerian Multiphase
Version 3.26
Function
Phase No.
Parameters
Definition
EGEB
PHASE(2)
/X/Y/Z/,ICSYS(1),
IREGS,/RADI/DEGR/
/X/Y/Z/ boundary centroid
coordinates in local system
ICSYS into register IREGS.
If the coordinate is an angle
(Y for cylindrical systems, Y
and Z for spherical systems),
then one can specify whether
the angles are to be loaded in
EGEB
PHASE(2)
AREA,IREGS
boundary areas into register
IREGS.
EGEB
PHASE(2)
BOUNDARY POST
DATA ITEM,IREGS
Loads a dispersed phase
boundary post data item into
register IREGS. Valid boundary post data items are:
/SU/SV/SW/VIS/DENS/
/LAMV/DP/MOMT/VMAG/
/VOID/COND/
See command EGEBOUNDARY for definitions.
EGEB
PHASE(2)
CONC,IREGS,NSC(1) Loads the mass fractions of
scalar species NSC into register IREGS.
16-25
POST MODULE
Chapter 16
Manipulating Data
Wall Data Functions
16-26
Function
Parameters
Definition
GETW
/X/Y/Z/,ICSYS(1),
IREGS,/RADI/DEGR/
Loads the /X/Y/Z/ wall centroid coordinates in local system ICSYS into register
IREGS. If the coordinate is an angle (Y for
cylindrical systems, Y and Z for spherical
systems), then one can specify whether the
or degrees.
GETW
/AREA/,IREGS
Loads the wall areas into register IREGS.
GETW
WALL POST DATA
ITEM,IREGS
Loads a wall post data item into register
IREGS. Valid wall post data items are:
/SFXYZ/SFX/SFY/SFZ/DIST/YPLUS//TE
MP/.
/HTRANS/HFLUX/TIRAD/TRAD/
/SIRAD/SRAD/.
/NEARWALL/.
See the GETWALL command for definitions. Note that the following wall post data
/SFTOT/SFTX/SFTY/SFTZ/MTRAN/
/MFLUX/.
/HCOEF/MCOEF/.
GETW
/SFTOT/SFTX/SFTY/
/SFTZ/,IREGS,
/P/PSTAT/PTERM/,
/RELA/ABSO/
Loads the total force magnitude or the
/X/Y/Z/ components thereof into register
IREGS. The total force can be calculated
using piezometric pressure (P), static pressure (PSTAT) or thermodynamic pressure
(PTERM). The pressure can be either relative (RELA) or absolute (ABSO).
GETW
/MTRANS/MFLUX/,
IREGS,NSC(1)
Loads the mass transfer wall function or
mass flux at the wall for scalar species NSC
into register IREGS
GETW
HCOEF,IREGS,
TBULK(TDATUM)
Loads the heat transfer coefficient into register IREGS. TBULK is the bulk mean temperature.
GETW
MCOEF,IREGS,
MBULK(0.0),NSC(1)
Loads the mass transfer coefficient into register IREGS. MBULK is the bulk mean
mass fraction for scalar species NSC.
Version 3.26
Chapter 16
POST MODULE
Manipulating Data
Wall Data Functions
Function
Parameters
Definition
GETW
TAW
Calculates adiabatic wall temperature,
TAW based on velocity, real specific heat,
and Prandtl number. For details, see command GETWALL. Loads TAW into post
register 4.
Other Load/Write Functions
Version 3.26
Function
Parameters
Definition
GETU
LF(case.usr),
/CELL/VERT/,
IREGS,/CODE/BINA/
Loads user data on file LF into post register
IREGS.
WRITE
IREG1,
LF(case.usr),
/BYCELL/BYVERT/,
/CODE/BINA/
Writes data from post register IREGS to
file LF in binary or coded format. The
option /BYCELL/BYVERT/ determines
whether data are referenced to cell or vertex numbers and is only used for wall or
boundary data (otherwise, leave blank). For
wall data using the BYVERT option, the
data are written to the file as
(4(I9,1X),G16.9). Otherwise, the data are
written as (I9,6X,G16.9).
PUTC
CELL POST DATA
ITEM,IREGS
Puts cell data in post register IREGS back
on the post data file as the given cell data
item (only if that cell data item is already
on the post data file). Valid cell data items
are:
/COND/CP/DENS/ED/F1/F2/F3/F4/F5/F6/
/LAMV/P/RSUU/RSUV/RSUW/RSVV/
/RSVW/RSWW/V22/F22/A2/SU/SV/SW/
/T/TE/VIS/G/
See command GETCELL for definitions.
PUTC
CONC,IREGS,NSC(1) Puts cell data in post register IREGS back
on the post data file as the mass fraction of
scalar NSC (only if that scalar is already on
the post data file).
PLLOAD
NONE
Sets program keys needed to plot post registers 1 to 3 as vector quantities.
16-27
POST MODULE
Chapter 16
Manipulating Data
Other Load/Write Functions
Function
Parameters
Definition
FLUX
NONE
Sets program keys needed to plot post registers 1 to 6 as flux quantities (i.e. each register represents one face of a given cell).
PMAP, ICTID(1), NC1(1), NC2(NC1), NCINC(1), PERC(10.0), NEWSET:
Maps the currently stored post data onto another model. That model may be a shell
mesh enabling the viewer to plot results on a completely arbitrary surface passing
through the model. It may also be a three-dimensional model (such as fine model of
a previously coarse-gridded region) in which case the mapped results can be used
to provide a reasonable initial field guess for restarts. If the user is mapping vertex
data, the model being mapped to should not share vertices with the model for which
the original post data was generated. The selected cells from which the original data
is being mapped should be either all two-dimensional or all three-dimensional.
ICTID
– The reference cell type of the cells to which the post data will
be mapped. If ICTID = ‘VSET’, then PMAP will map post to
all the vertices in the current VSET. This option is allowed
only for mapping vertex data. If ICTID= ‘ALLSEC’, then the
post data is mapped to all of the sections defined by the
PSCREATE command.
NC1, NC2,
NCINC
– A range or set of cells surrounding the new model.
PERC
– Percentage amount to move a vertex towards the centroid of
the nearest cell, if found outside the cell.
NEWSET
– Builds a new cell set consisting of the mapped cells.
PSYS, IPSYS(1): Resolves incoming vector components into a predefined local
coordinate system (IPSYS). Subsequent printing and plotting of vector data are with
reference to this coordinate system. The user must reissue the GETCELL or
GETVERTEX command after each use of this command.
IPSYS
– Number of a local coordinate system. The default is the global
Cartesian system.
16-28
Version 3.26
Chapter 16
POST MODULE
Manipulating Data
SORT, OPTION: Sorts stored post-processing data according to the value of the
currently stored scalar item. The data can then be printed in ascending or descending
order using the appropriate option on the PRINT command. The sorted order is lost
whenever the user passes out of the POST module or if the user replaces cell data
with vertex data or vice versa.
OPTION
– NOSORT. Undoes the effects of the sorting operation.
– ACTUAL. Sorts using the actual values of the scalar.
– ABSOLUTE. Sorts using the absolute value of the scalar.
Note: The SORT command is obsolete. Its functionality has been superseded by
new options in the PRINT command.
UNITS, UOPT: Allows the program to automatically convert the units of post data
items from SI (which is what STAR works in) to English system units.
UOPT
– SI. The program will leave all post data items in their original
units.
– ENGLISH. The program will automatically convert all post
data items to the English system and change.
Warning: Using the UPDATE command to write out post data items that have been
converted to the English system will lead to unpredictable results.
UPDATE: After a set of post data has been altered using the CHANGE command,
this command rewrites the post-processing file to make the change permanent. Only
cell data may be written back to the post file. The process of UPDATING a file does
not alter any boundary values stored on that file.
VAVERAGE, RANGE: Produces a set of cell data by averaging all the vertex post
data variables connected to each respective cell. After averaging, the post data are
treated as cell data and the user will see the checkerboard effect characteristic of cell
data contour plots rather than smooth contours.
RANGE
Version 3.26
– Defines the range of cells to be included in the averaging
process. The user may pick one of
/ALL/CSET/NC1,NC2,NCINC/.
16-29
POST MODULE
Chapter 16
Reporting Data
Reporting Data
ACOEFF, OPTION, UREF, DREF, AREF, SREF, CX, CY, CZ, SCALE9:
Calculates aerodynamic coefficients over the currently selected set of wall shells.
The user must ensure that the appropriate total force components are loaded (usually
using GETWALL,FTOT). In moment calculations, model coordinates are used to
calculate moment arms and the vertex coordinates will be scaled before calculating
the resultant moments as per the specified scale factor.
OPTION
– DRAG. To calculate the force coefficients in each of the three
global Cartesian directions (i.e. Clift, Cdrag, Cside). Requires
UREF, DREF and AREF.
– MOMENT. To calculate the moment coefficients about each of
the three global Cartesian axes (i.e. Cyaw, Croll, Cpitch).
Requires UREF, DREF, AREF, SREF, CX, CY, CZ and
SCALE9.
UREF
– Reference velocity (typically free stream velocity).
DREF
– Reference density (typically with UREF gives the free stream
dynamic pressure).
AREF
– Reference area (typically frontal area or 1).
SREF
– Reference length (typically vehicle or chord length or 1).
CX, CY, CZ – Centre for calculation of moments.
SCALE9
– Scale factor to scale the vertices. This defaults to the one
specified in the post file.
INTEGRATE, RANGE: Integrates the currently selected (cell) post data items on
the plane defined by the SPOINT and SNORMAL commands and prints the results
to the screen. Cell data are treated as constant within the volume of each cell.
Therefore, the integration simply sums the cell value times the area of the slice
through each cell. Vector components (fluid velocities) are first resolved into a
system that is normal and parallel to the given plane. Then the normal component
only is used. This method is not exact and will provide only a rough estimate of the
integrated values. Obviously, finer meshes will yield more accurate values than
coarser meshes located in the same geometry. To use this command, make sure that
all three cell velocity components are loaded in the global Cartesian system and the
appropriate scalar (or user item created via the OPERATE command) is loaded into
register 4.
Note: The areas are all multiplied by the scale factor used last to write out geometry
16-30
Version 3.26
Chapter 16
POST MODULE
Reporting Data
file.
RANGE
– Defines the range of items to be scanned. For cell data, one of
PCROSS: When used on a surface contour plot, this command will enable the
cursor to be used for selecting a precise location on the plot. The program then
interpolates the stored post data and prints out the value at that precise location.
Note: PCROSS does not work on section plots.
PRINT, RANGE, SVMIN, SVMAX, IREGS(4), SOPTION: Prints the post
register data to the screen.
RANGE
– Defines the range of items to be printed.
– For cell data, one of /ALL,,/CSET,,/NC1,NC2,NCINC/.
– For vertex data, one of /ALL,,/VSET,,/NV1,NV2,NVINC/.
SVMIN,
SVMAX,
IREGS
– If both SVMIN and SVMAX are non-zero, then data will be
printed for only those cells/vertices for which the value in post
register IREGS is between SVMIN and SVMAX.
SOPTION
– NOSORT (default). Data will not be sorted before printing.
– SORT,IRGSORT(4),/ACTUAL/ABSOLUTE/,/DESCEND/
/ASCEND/. Data will be sorted by the values in post register
IRGSORT. The data can be sorted by actual or absolute values,
and printed in either descending or ascending order.
REFRAME, OPTION: Translates velocity vectors from one rotating frame of
reference into the global system or into another rotating frame of reference. All
velocities are initially computed by STAR relative to their frame of reference. As of
STAR-CD v3.01, however, all velocities are subsequently translated into the global
reference frame before being written to the post data file. The user must use the
GETCELL command to reload velocities each time the REFRAME setting is
changed.
If pro-STAR detects that the post data file was created by an older version of
STAR, it will automatically perform any special conversions necessary to make the
retrieved data consistent with the current REFRAME setting. The following option
descriptions assume that the post data file was created by STAR-CD v3.01 or later.
Version 3.26
16-31
POST MODULE
Chapter 16
Reporting Data
OPTION
– COMPUTATIONAL. The velocities are translated into the
original computational reference frame (i.e. into each rotating
frame of reference) by adding R*OMEGA to all velocities on a
per material basis. R and OMEGA are defined in the
PROPERTY module using the SPIN command.
– STATIC. All velocities are left in the global static system into
which they were translated before being written to the post file.
– LOCAL,ICSYS,OMEGA. All velocities are translated into a
local coordinate system by subtracting R*OMEGA from each
velocity, where R denotes the distance from the Z axis of local
coordinate system ICSYS and OMEGA is in revolutions per
minute.
SPRINT, RANGE, SVMIN, SVMAX: Prints the currently selected post data
items on the plane defined by the SPOINT and SNORMAL commands.
RANGE
– Defines the range of items to be printed. One of
SVMIN,
SVMAX
– If non-zero, then only values of the stored scalar item between
these two values will be printed.
SUMMARISE, RANGE: Provides the sum, average, area-weighted average,
minimum value/location and maximum value/location for each of the four post data
items stored. The data are scanned only over the specified cell or vertex range.
RANGE
– Defines the range of items to be scanned.
– For cell data, one of /ALL/CSET/NC1,NC2,NCINC/.
– For vertex data, one of /ALL/VSET/NV1,NV2,NVINC/.
TRINTERPOLATE, STATUS, AVGOPT: Turns on or off linear interpolation of
post data values for times specified with the STORE command. This command can
be used for times that fall in between time steps actually stored on the transient post
data file (which was connected using the TRLOAD command).
STATUS
16-32
– /OFF/ON/.
Version 3.26
Chapter 16
POST MODULE
Particle Tracking
AVGOPT
– NONE. Values will not be averaged.
– CAVERAGE,/CSET/ALL/. Cell values loaded with the
GETCELL command will be automatically averaged to give
vertex data considering either the current cell set (CSET) or all
the cells (ALL). Vertex data loaded with the GETVERTEX
command will not be altered.
– VAVERAGE. Vertex values loaded with the GETVERTEX
command will be automatically averaged to give cell data. Cell
data loaded with the GETCELL command will not be altered.
– BOTH,/CSET/ALL/. Cell values loaded with the GETCELL
command will be averaged to give vertex data considering
either the current cell set (CSET) or all the cells (ALL). Vertex
values loaded with GETVERTEX will be averaged to give cell
data.
Particle Tracking
PARTICLE, OPTION, PARAMETERS: Manages the particle list. Particles are
imaginary spheres which can be introduced into the flow field and tracked. The
starting location of a particle is specified by its associated vertex. This vertex may
be part of a cell definition or exist independently anywhere within the solution
domain. Other particle data include diameter, density, initial velocity and release
time. Once particles are defined, the PTRACK command can be used to track the
trajectory of each particle in the list.
Version 3.26
16-33
POST MODULE
Chapter 16
Particle Tracking
16-34
ADD
– NV1(1),NV2(NV1),NVINC(1),DIAM,DENS,/UIN,VIN,WIN,
ICSVEL(1)/FLOW/NORM,VMAG/CIRCLE/
/RELATIVE,ANGLE/CONSTANT/,VMAG,RADIUS,
NPARTT,NPARTR/,NRELE(1),TRELE1(0.),DTRELE,
OMEGA(0.), ICSROT(2). Adds particles with starting
locations at vertices NV1 to NV2 by NVINC with NRELE
release times beginning at TRELE1 and incremented by
DTRELE. Particles have diameters of DIAM, densities of
DENS and initial velocity components of (UIN, VIN, WIN) in
coordinate system ICSVEL. The particles are given an
additional initial velocity component of OMEGA(rpm) × R
due to rotation about the Z axis of cylindrical coordinate
system ICSROT. If the keyword FLOW is used instead of UIN,
or if the particles are massless, then the initial conditions are
taken to be equal to the fluid velocity at the particle starting
location. Body forces due to rotational fields and gravity (SPIN
and ACCEL commands) are included in the tracking
calculations. If DIAM = 0 or DENS = 0, then the particles are
treated as massless. If the keyword NORM is used instead of
UIN, then the initial velocity is computed in the direction of
the normal to the cell face on which the particle lies, with a
magnitude VMAG. If the keyword CIRCLE is specified, with
the option RELATIVE with an entrance ANGLE, the initial
velocity for each particle has a direction based on the particle’s
location, and the entrance angle, with the magnitude VMAG.
The particles are released at a relative angle to the z-axis. If the
option CONSTANT is used with the CIRCLE keyword, the
user is prompted to specify direction cosines DX, DY and DZ
and the particles are released in that direction. NPARTT and
NPARTR are the number of particles in the theta and radial
direction, respectively.
DELETE
– /IP1(1),IP2(IP1),IPINC(1)/GROUP,IGRP1,IGRP2/. Deletes
particles IP1 to IP2 by IPINC. If the keyword GROUP is used
instead of IP1, the particles deleted are from group IGRP1 to
IGRP2.
GROUP
– NPTGR. Sets the group number for the next set of particles to
NPTGR.
Version 3.26
Chapter 16
POST MODULE
Particle Tracking
MODIFY
– /IP1(1),IP2(IP1),IPINC(1)/GROUP,IGRP1,IGRP2/,OPTION2.
Modifies particles IP1 to IP2 by IPINC. If the keyword
GROUP is used instead of IP1, the particles modified are from
group IGRP1 to IGRP2. Valid values for OPTION2 are as
follows:
– VELOCITY,FLOW (default). Modifies the initial velocity of
the particles to be equal to the fluid velocity at the particle
starting location.
– VELOCITY,UIN,VIN,WIN,ICSVEL(1),OMEGA(0.0),
ICSROT(2). Modifies the initial velocity of the particles to
be (UIN,VIN,WIN) in coordinate system ICSVEL. See
above for definitions of OMEGA and ICSROT.
– DIAMETER,DIAM(0.0). Modifies the diameter of the
particles to be DIAM.
– DENSITY,DENS(0.0). Modifies the density of the particles
to be DENS.
– RELEASE,TRELE(0.0). Modifies the release time of the
particles to be TRELE.
– GROUP,NPTGR. Modifies the group number of the particles
to be NPTGR.
LIST
– /IP1(1),IP2(IP1),IPINC(1)/GROUP,IGRP1,IGRP2/. Lists all
particles and their initial conditions within the range IP1 to IP2
by IPINC. If the keyword GROUP is used instead of IP1, the
particles listed are from group IGRP1 to IGRP2.
PTOPTION, /ALL/IP1, IP2, IPINC(1)/GROUP, IGRP1, IGRP2(IGRP1)/,
OPTION: Sets the colour and line width used to draw particle tracks. The options
can be set for all particles, individual particles, or groups of particles. The valid
options are:
OPTION
– DEFAULT. Resets the colour and line width of the indicated
particles to the defaults.
– COLOR,/AUTO,PEN/. Sets the colour of the indicated
particles to a specific pen colour. If AUTO is selected (the
default), the particles will cycle through the first six colour
pens.
– WIDTH,VAL(3). Sets the line width of the indicated particles
to the given number of pixels.
PTPLOT, OPTION, LFP(case.trk), TROPTION, TISTRT(0),
Version 3.26
16-35
POST MODULE
Chapter 16
Particle Tracking
TISTOP(TMAX), TIDISP(TMAX/25), TIINC(TIDISP/2), NREP(1), /PART,
IPART1(1), IPART2(999999)/GROUP, IGRP1, IGRP2/, RIBSIZ(.01*track
length), OVERLAYOPT(NOVR), RIBFAC(1.), IR(0): Plots or clears particle
tracks. Particles must first be tracked using the PTRACK command. The particles
will be coloured either by geometry colours (alternating between the first six
coloured pens) or scalar values, depending on the current plot option set with the
POPTION command. If the current POPTION is set to CONTOUR or BOTH, the
particles will be coloured with the current scalar value until the PTPLOT command
is issued again.
OPTION
– PLOT. Coordinates are read from the particle track file and
the particle tracks are plotted over the current plot.
– CLEAR. If the user has plotted tracks, this option deletes
the entities used to display the tracks, i.e. points, shells and
cell tables, in such a way that the tracks will not be
displayed at the next REPLOT. For OPTION = CLEAR, no
further fields are processed.
LFP
– File from which particle tracks are read.
TROPTION
– SEGMENTS. Particle tracks are plotted as streaks with
finite lengths. Each streak is plotted starting at time TISTRT
and ending at time TIDISP. At the end of each plot, TIINC
is added to both TISTRT and TIDISP and the streaks are
replotted. In this manner, TIDISP controls the length of
each streak and TIINC controls the speed at which it moves
forward.
– CONTINUOUS. Particle tracks are plotted continuously
from the starting point. TIINC controls how quickly the
leading point of each track advances through the flow field.
TISTOP represents the time after which no particle tracking
occurs. For this option, TIDISP is ignored.
– RIBBONS. Particle tracks are plotted as ribbons, i.e. a
small stripe rotated in proportion to the local tangential
vorticity. The ribbons can be coloured according to any
scalar field loaded into any of the six post registers. Ribbons
require 31 auxiliary values per point per track; MAXSC2
should be dimensioned accordingly.
TISTRT,
– See TROPTION above for usage of TISTRT, TISTOP,
TISTOP,
TIDISP, and TIINC.
TIDISP, TIINC
NREP
– Number of times to replay the entire particle track sequence
from the beginning. (If RIBBONS is active, NREP is
ignored.)
PART, IPART1, – If the PART option is specified, IPART1 and IPART2 are
IPART2
the first and last particles to plot.
16-36
Version 3.26
Chapter 16
POST MODULE
Particle Tracking
GROUP, IGRP1, – If the GROUP option is specified, all particles belonging to
IGRP2
groups ranging from IGRP1 to IGRP2 are plotted.
RIBSIZ
– The width of the ribbon in the model’s units. If not
specified, RIBSIZ is one hundredth of the track length.
OVERLAYOPT – NOVR. Non-overlay mode. Ribbons behave as shells in the
model, so that light shading, hidden line removal, etc., can
be applied.
– OVRL. Overlay mode. The ribbon plot will be
superimposed on any other geometrical entity in the screen.
RIBFAC
– Magnification factor for the rotation of the ribbon.
IR
– Post register to be used when colouring the ribbons. If
IR = 0, then the ribbons are contoured according to the local
tangential vorticity.
PTPRINT, LF(case.trk), OPTION, NPT1(1), NPT2(NPT1), NPTINC(1):
Prints values for particles/droplets from the track file.
LF
– Binary particle/droplet track file name.
OPTION
– /LOCATION/VELOCITY/OTHER/. OTHER for droplets
yields temperature, diameter, mass, density and count. It does
not apply to particles.
NPT1, NPT2, – Values for particles/droplets from NPT1 to NPT2 in
NPTINC
increments of NPTINC will be listed.
PTRACK, ROPTION, LFP(case.trk), TSTART, TSTOP, TINTEG,
WOPTION: Calculates particle tracks. Particle data must first be defined using the
PARTICLE command. The track of each defined particle is calculated and the track
coordinates are written out to a file. The PTPLOT command may then be used to
plot the particle track.
Version 3.26
16-37
POST MODULE
Chapter 16
Particle Tracking
ROPTION
– /STEADY/TRANSIENT/. This option specifies the type of
analysis used to create the particle tracks. STEADY assumes a
steady-state analysis in which the fluid velocity field is
constant over the entire time span of the particle tracks. The
user must first load a static post file (LOAD). For massless
particles, the STEADY option is analogous to streamline
computation. TRANSIENT assumes that the fluid velocity
field varies over time. Prior to using the TRANSIENT option,
the user must first load one or more transient post files
(TRLOAD). For massless particles, the TRANSIENT option is
analogous to pathline computation.
LFP
– File to which particle tracks are written.
TSTART
– Starting time of the analysis. TSTART is set to 0.0 for
steady-state analyses. Default for TRANSIENT is 0.0.
TSTOP
– Stopping time of the analysis. If no stopping time is specified,
it is calculated based on average flow velocity and domain size
for steady-state analyses, or defaulted to end-of-data for
transient analyses.
TINTEG
– Time step of integration. For steady-state analyses, if no time
step is specified, one is calculated based on local flow
velocities and cell sizes. TINTEG may be set to a negative
value for steady-state problems so that particle tracks may be
computed backwards in time. Default is 0.01 seconds for
transient analyses.
WOPTION
– /WADJ,F2(.5)/REST,Z0(0.1)/NOADJ/. This option defines an
adjustment made to the velocity field of cells located next to
wall boundaries. The WADJ option reduces the strength of any
velocity component pointed towards the wall by a factor of F2,
resulting in more accurate tracks and fewer particles
intersecting walls and stopping. The REST option restricts
particles to move along wall boundaries. The parameter Z0
indicates the enforced normal distance from the boundary to
the particle relative to the thickness of the fluid element
adjacent to the wall. Particles not contained in a cell bordering
a wall boundary shell will be ignored during the particle
tracking. NOADJ uses the velocities as calculated without
performing the adjustment.
PTREAD, LF(case.trk), TIME, LFB(case.lfb), IGROUP, DELTAT,
RFLAG, MAXDT: Reads particle tracks from a file and interpolates their position
based on TIME. The information is stored in the area reserved for fuel injection
16-38
Version 3.26
Chapter 16
POST MODULE
Particle Tracking
droplets, so the DPLOT command can be used to plot the particles after they are
read.
Normally, this command reads file LF and stores the information in memory so
that during the next execution of the command the file is not read and the
information in memory is used to calculate the particle positions. To force this
command to read the particle track data from the file, use a different file name for
LF or set the parameter RFLAG to 1.
LF
– File name.
TIME
– The requested time.
LFB
– Name of an optional file containing group and colour
information for the particles. The file must be coded (not
binary) and is read in free format. Each line in the file must
contain seven integer fields: starting track number, ending
track number, group number for the track range, and red,
green, and blue colour values for the track range. The colour
values must be between 0 and 100.
IGROUP
– The group of tracks that will be loaded by this command.
DELTAT
– Repeat the track every DELTAT time interval.
RFLAG
– If set to one, forces the command to reread the file LF.
MAXDT
– The maximum time over which droplet releases occur. The
number of such releases is equal to MAXDT/DELTAT.
PTSYMM, LF(case.trk), LFS(case.trk_s), SYMDIR: Takes the particle
track file and creates a second file with all the original tracks and a new set of tracks
in which the originals have all been reflected about a global symmetry plane.
LF
– Original particle track file.
LFS
– New track file with symmetry reflected tracks.
SYMPLANE – /X/Y/Z/.
PTVERTS, LFP(case.trk), IPART(1), NV1(1), NV2(NV1), NVINC(1):
Reads particle track number IPART from particle track file LFP and creates vertices
NV1 to NV2 by NVINC at equally spaced locations along the particle path. These
vertices can be used as sensors, for example, in order to calculate the value of any
vector or scalar post processing item along the path, or for any other purpose
Version 3.26
16-39
POST MODULE
Chapter 16
Particle Tracking
deemed suitable by the user.
16-40
Version 3.26
Chapter 17
Chapter 17
GRAPH MODULE
GRAPH MODULE
EXIT: Return to the PRO Module.
GRESET: Clears all graph registers and resets all graphical variables and logicals
to default values. This allows the user to redefine the number of registers
(NUMREG).
HELP, OPTION
or
HELP, COMMAND: Displays the command set for the GRAPH module or
displays more detailed information about a specific command within this module.
OPTION
– /ALL/REGISTER/FDEFINE/DRAW/.
– ALL. All commands in the module will be listed.
– REGISTER. Only commands dealing with register storage
and manipulation will be listed.
– FDEFINE. Only frame definition related commands will be
listed.
– DRAW. Only graph drawing and display related commands
will be listed.
The following is an outline of storing and plotting data using the graph module:
1. Define the total number of graph registers needed using the NUMREG
command.
2. Port data into these registers using the GDATA, GFILL or GINPUT for
external (foreign) data or GPARAM, GSTAR, GLOAD, GVALUE,
GTRANS, GPOST or GPTLOAD for data internal to pro-STAR or STAR.
3. The graph registers and line types and/or symbol types or bar types selected
for the y registers using the RTABLE command will be used to draw the
graph. Line, Symbol and Bar definitions can be manipulated using the
LINTYPE, SYMTYPE and BARTYPE commands. These entities can be
listed using the RTLIST, LINLIST, SYMLIST and BARLIST commands.
4. Display parameters can be modified using the GRDISPLAY command.
5. Define all characteristics of a frame using the FRDEFINE command or
individual characteristics using the options in the FRAME command. The
characteristics of a frame include:
Version 3.26
17-1
GRAPH MODULE
Chapter 17
(a)
(b)
(c)
(d)
(e)
(f)
(g)
(h)
(i)
GRTYPE. Graph type
LOCATE. Location
XREG. X-axis registers
YREG. Y-axis registers
XRANGE. X-axis range
YRANGE. Y-axis range
XTITLE. X-title location and description
YTITLE. Y-title location and description
LEGEND. Legend location and description
6. For labels specific to a certain frame, use the GRLABEL command.
7. Use the GDRAW command to draw the graph(s).
8. For multiple frame plotting, check the GSPLIT command to split the
definitions of the frames so that they do not overlap.
9. Use the ROPERATE command to manipulate data stored in graph registers.
10. Use the RCALC command to generate derivatives, integrated quantities or
series coefficients etc.
11. Use RCLEAR to clear data stored in registers.
12. Save data from graph registers for future use using the SDATA command.
NUMREG, NREG: Defines the storage space required for the data to be read.
NREG
– Number of graph registers for which storage space is needed.
The default is the maximum allowable number of registers or
20, whichever is less.
Note: The maximum number of terms per register depends upon the storage space
(MXSTOR) that the program has been compiled for with the relationship:
Number of terms = MXSTOR/NREG
NREG cannot be changed after data storage begins unless the command GRESET
is issued, which clears all the graph registers and resets all graphical parameters and
logicals to default values.
STATUS, OPTION: Gives the status of the GRAPH module.
OPTION
17-2
– DISPLAY,IFRM1(1),IFRM2(IFRM1),IFINC. Gives the
current status of display related parameters for frames IFRM1
to IFRM2 in increments of IFINC. The keyword ALL can be
used to give the status of all frames.
Version 3.26
Chapter 17
GRAPH MODULE
Register Storage
OPTION
– FRAME,IFRM1(1),IFRM2(IFRM1),IFINC. Gives the current
status of frame-related parameters for frames IFRM1 to
IFRM2 in increments of IFINC. The keyword ALL can be
used to give the status of all frames.
– REGISTER,IREG1(1),IREG2(IREG1),IRINC. Gives the
current status of graph registers for values stored in registers
IREG1 to IREG2 in increments of IRINC. The keyword ALL
can be used to give the status of all filled graph registers
Register Storage
EDLOAD, IREG, LF(case.ecd), VAR, ISRN(1), ITER1(1), ITER2(ITER1),
INCI(1), SCALEF(1.0), OFFSET(0.0): Loads STAR engineering monitoring data
into a graph register.
IREG
– Graph register to fill. Lowest register number not containing
data is default.
LF
– Name of engineering cell or region data file (*.ecd or
*.erd) containing data.
VAR
– Name of dependent variable to load.
ISRN
– Set or region number to load.
ITER1,
– Range of iterations (or time) to load. If ALL is entered for
ITER2, INCI ITER1, data for all iterations (or time steps) on the file will be
loaded. If data do not exist for an iteration, a 0. will be entered
in the graph register for that iteration.
SCALEF,
OFFSET
– Values read from the file are multiplied by SCALEF and added
to OFFSET before being placed in the graph register.
GDATA, LF(case.grf), NDATA(1), IREGS(1), IRINC(1), FOPTION,
ILOC(1): Reads data values into a graph register from an external file.
LF
Version 3.26
– File name in which data reside. For FOPTION = CODED,
USER or BINARY, the default is case.grf. For
FOPTION = SPEED, the default is case.spd01. STAR
creates one .spd file for each fluid material type in the model,
so the general form of these files is
case.spd0<material number>.
17-3
GRAPH MODULE
Chapter 17
Register Storage
NDATA
– Number of data sets to be extracted. For FOPTION = SPEED,
NDATA is read in from case.spd0<material number>.
IREGS
– Starting register to store the data values into. The keyword
NEXT can be used to indicate the first unused register after the
last used graph register. For FOPTION = SPEED, IREGS is
always set to 1.
IRINC
– Register number increment. For FOPTION = SPEED, IRINC
is always set to 1.
FOPTION
– CODED (default). The input file is coded and free formatted.
In this case, the file contains only the data to be read
– USER. The input file is coded and contains formatted data. In
this case, the user will be prompted for a FORTRAN format
specification describing the data records. Data records not
conforming to the specification will be skipped. The register
arrays are stored as real values, therefore format statements
should use only real descriptions (F, E or G formats and not I).
– BINARY. The input file is binary.
– SPEED. The input file is a coded STAR SPEED file containing
SPEED-specific data items.
ILOC
– Starting location (row) to store the data. If ADD, data from file
LF will be appended to previously existing data.
GFILL, IREGS(1), VSTART, VEND, VINC, NVAL, ILOC(1), ILINC(1): Fills
a graph register with values.
IREGS
– Graph register number to be filled. If the keyword NEXT is
entered, the lowest graph register not containing data will be
used.
VSTART
– Starting value.
VEND
– Last value.
VINC
– Increment in values.
NVAL
– Number of values to fill.
ILOC
– Location number to start the fill. If the keyword ADD is
entered, the data will be appended to previously existing data.
ILINC
– Location increment for fill.
Note: Only the maximum available number of terms will be filled. If NVAL is
blank, the number of values will correspond to VSTART,VEND,VINC. If NVAL
is not blank, VEND will not be used.
17-4
Version 3.26
Chapter 17
GRAPH MODULE
Register Storage
GINPUT, IREGS(1), ILOC(1), NVAL(0): Prompts for input of values into a
graph register.
IREGS
– Graph register number for the value(s) to be stored.
ILOC
– Starting location in graph register.
NVAL
– If NVAL = 0 (default), the user will be prompted for as many
values as there are available spaces in the graph register. The
user can enter ENDDATA to stop prompting for additional
values.
– If NVAL > 0, this is the number of values to be prompted for.
The user will be prompted for no more than the number of
available spaces in the graph register. Again, the user can enter
ENDDATA to stop prompting for additional values.
– If NVAL < 0, then the graph register values in locations ILOC
to ILOC+ABS(NVAL) will be deleted and compressed out.
GLOAD, IREGS(1), TYPE, N1(1), N2(N1), NINC(1), ILOC(1): Loads cell or
vertex numbers into a graph register.
IREGS
– Graph register number for storing the values. If the keyword
NEXT is entered, the lowest graph register not containing data
will be used.
TYPE
– /CELL/VERTEX/SENSOR/WALL/.
N1, N2,
NINC
– Values from N1 to N2 in increments of NINC will be stored in
graph register IREG. The keyword ALL can be used in place
of N1 to store all the cell, vertex, or sensor vertex numbers.
The keywords CSET or VSET may be used in place of N1
under the following conditions:
– If TYPE = CELL or WALL, the keyword CSET stores the
numbers of the cells in the current cell set.
– If TYPE = VERTEX, the keyword VSET stores the numbers
of the vertices in the current vertex set.
– If TYPE = SENSOR, the keyword VSET stores the numbers
of the vertices that are both sensors and in the current vertex
set.
ILOC
– Starting location number in IREG to begin the fill.
Version 3.26
17-5
GRAPH MODULE
Chapter 17
Register Storage
GPARAM, PARA, IREGS(1), ILOC(1): Stores current parameter value in a
graph register. If this command is executed within a loop (see command *DEFINE),
the value of the parameter at this point is stored.
PARA
– Parameter name.
IREGS
– Register number for the value to be stored.
ILOC
– Location in register.
GPOST, OPTION: Defines sensors and loads geometry and post data at the
sensors into the graph registers.
OPTION
– NV1,NV2,NSENS(20),IREGS(1). Sensors will be equally
spaced between vertices NV1 and NV2.
– SPLINE,NSP,NSENS(20),IREGS(1). Sensors will be equally
spaced along spline NSP.
– MAPLINE,,NSENS(20),IREGS(1). Sensors will be equally
spaced along a line drawn interactively by the user on top of
the current section plot.
– POINTS,/NOMAP/MAP/,NSENS(20),IREGS(1),X1,Y1,Z1,X
2,Y2,Z2. Sensors will be equally spaced along a line drawn
from coordinates (X1,Y1,Z1) to (X2,Y2,Z2) of the active
coordinate system. If MAP is used, the sensors will be mapped
onto the surface or section definition depending on which type
of plot is currently displayed.
– CSET,,,IREGS(1). Sensors will be defined at the centroids of
all the cells in the current cell set.
– VSET,,,IREGS(1). Sensors will be defined at all the vertices in
the current vertex set.
– SECTION,,,IREGS(1). Sensors will be defined along the
perimeter of the current section definition.
IREGS
– Starting graph register. If the keyword NEXT is entered, the
lowest graph register not containing data will be used. Note
that at least IREGS+10 graph registers are needed to store the
data. Register IREGS will contain the sensor number; register
IREGS+1 will contain the distance or spline distance from the
first newly-defined sensor; registers IREGS+2, IREGS+3, and
IREGS+4 will contain the X-, Y- and Z- coordinates of the
sensors; and registers IREGS+5 to IREGS+10 will contain the
post values from post registers 1 to 6.
17-6
Version 3.26
Chapter 17
GRAPH MODULE
Register Storage
GPTLOAD, LF(case.trk), NPT(1), IREGS(1): Loads data for a particular
particle/droplet from a track file into graph registers. For droplets, in addition to
time, distance, locations (X, Y and Z), velocities (U, V and W) and cell number, the
command will also store temperature, diameter, mass, density and count (number of
droplets in the parcel).
LF
– Particle/droplet track file name. (Must be binary.)
NPT
– Particle/droplet number.
IREGS
– Starting graph register number for storing the values. Note that
at least IREGS+8 registers are needed for particle tracks and at
least IREGS+13 registers are needed for droplet tracks.
Note: Use the PTLIST command for on-screen listing of these values.
GPUT, FNUM, ILOC, IREGX, IREGY, GX, GY: Puts a pair of x-y values into
graph registers.
FNUM
– Frame number from which the value is to be extracted
(default = 1).
ILOC
– Location at which these values are to be inserted.
IREGX
– X-value in register IR1. If blank, the x value will not be
inserted.
IREGY
– Y-value in register IR2. If blank, the y value will not be
inserted.
GX, GY
– Graph coordinates of the value to be extracted. If left blank, the
program will enable the cursor for use in picking the point.
GSTAR, LF(case.rsi), TYPE, IMAT(1), IREGS(1), ILOC(1), OPTION,
LOPTION: Gets STAR residuals (or rates of change) and monitored values from
a direct access file for a particular fluid or solid type and sets up graph frames based
on these values. These are set up to be plotted versus iteration number in frames 1
and 2 for fluids and frame 1 for solids.
Version 3.26
LF
– Name of a STAR residual post file.
TYPE
– /HEADER/FLUID/SOLID/. HEADER will list the
information in the direct access file.
17-7
GRAPH MODULE
Chapter 17
Register Storage
The following arguments are valid only if the FLUID or SOLID type is chosen:
IMAT
– Fluid or solid material number for which the values will be
extracted.
IREGS
– Starting register number to begin the storage. If the keyword
will be used. This will contain the iteration number.
ILOC
– Starting location number to start loading the values. If
CURRENT is used, then existing iterations in IREGS will be
overwritten by corresponding iterations from this file.
OPTION
– /BOTH. Extracts both residuals (or rates of change) and
monitored values.
– RESIDUAL. Only residuals (or rates of change) will be
extracted.
– MONITORED. Only monitored values will be extracted.
LOPTION
– ALL. Graph all iteration numbers in the file.
– ITER1(1),ITER2(ITER1),ITINC(1). Graph iteration numbers
in the range ITER1 to ITER2 by ITINC.
Note: Prior to storing data, it is advisable to check the file using the HEADER type
option. Frames 1 and 2 will be defined if the FLUID type is chosen. Frame 1 will
be defined if the SOLID type is chosen.
GTRANS, TYPE, IREGS, IREGL, ILOC(1), OPTION: Gets STAR transient
values from a file.
17-8
TYPE
– /GETC/GETV/GETW/. Type of data to be extracted. Cell,
vertex or wall data can be extracted.
IREGS
– Starting graph register number for storing the values. This
register will contain the iteration number. Register IREGS+1
will contain the time step values. Values for the option chosen
will be stored in registers IREGS+2 onwards. If the keyword
will be used.
IREGL
– Graph register number containing the cell, vertex or wall shell
numbers for which the values will be extracted. There should
be enough registers defined to fit all the values for all the items
present in this register.
ILOC
– Starting location number to start loading the values. If the
keyword ADD is entered, data will be loaded starting at the
first empty location in register IREGS.
Version 3.26
Chapter 17
GRAPH MODULE
Register Storage
OPTION
– ALL. Values for all time steps (all iterations) stored in the
current transients file will be extracted.
– TIME,TMIN,TMAX. Values between time steps TMIN and
TMAX will be extracted.
– ITER,ITMIN,ITMAX. Values between iterations ITMIN and
ITMAX will be extracted.
This command will prompt for the required arguments of the GETCELL,
GETVERTEX or GETWALL commands.
Note: Post values in the post registers, if present, will be destroyed. If the GETW
type is chosen, wall shell numbers have to be pre-stored in register IREGL. This is
done by executing a dummy GETW command prior to the execution of this
command and using the GLOAD command to load register IREGL with the
required cell (wall) numbers.
GVALUE, IREGS(2), IREGL(1), TYPE, OPTION: Puts geometry data or the
currently stored post data values (contained in POST registers 1-6) into a graph
register.
Version 3.26
IREGS
– Starting graph register number for storing the values. If the
keyword NEXT is entered, the lowest graph register not
containing data will be used.
IREGL
– Graph register number containing the cell or vertex numbers
for which the values are to be extracted.
TYPE
– /CELL/VERTEX/SENSOR/WALL/. This defines graph
register IREGL as containing either cell, vertex, sensor or wall
numbers.
OPTION
– /X/Y/Z/,ICSYS(1). If TYPE = CELL or WALL, this stores the
X-, Y- or Z-positions of the centroid of the cells or walls listed
in the graph register IREGL. If TYPE = VERTEX or
SENSOR, this stores the X-, Y- or Z-positions of the vertices
or sensors listed in the graph register IREGL. In all cases, the
locations are found with respect to coordinate system ICSYS
and are stored into graph register IREGS.
– GEOM,ICSYS(1). Like above, except that this stores all three
coordinate positions in graph registers IREGS to IREGS+2.
– /PST1/PST2/PST3/PST4/PST5/PST6/POST/. Stores the post
register values, if available, into graph register IREGS.
– POST. Stores all six post registers, if available, into graph
registers IREGS to IREGS+5.
17-9
GRAPH MODULE
Chapter 17
Register Labelling and Listing
OPTION
– BOTH,ICSYS(1). Stores the geometry data into graph
registers IREGS to IREGS+2 and the post register data into
graph registers IREGS+3 to IREGS+8. If no post data is
loaded, then just the geometry data are stored.
– SPLINE,NSPL(1),TOLSPL(0.1). If the cell centroids, vertices,
sensors or wall centroids specified in graph register IREGL are
less than a distance of TOLSPL from spline NSPL, this option
will store the distance along the spline in graph register
IREGS.
SDATA, LF(case.grf), NDATA(1), IGREG(1), IRINC(1), FOPTION:
Saves graph register data values into a file.
LF
– File name into which the data is to be written.
NDATA
– Number of graph registers to be saved.
IGREG
– Starting graph register from which to store the data.
IRINC
– Increment in graph register numbers.
FOPTION
– CODED (default). The output file is coded and contains data
written out in 9(1X,G13.6) format. Note that if the CODED
option is used, NDATA must not be more than 9.
– USER. The output file is coded and contains data in a format
specified by the user. The user will be prompted for a
FORTRAN format specification. Data not conforming to the
specification will be skipped. Items in the graph register arrays
are stored as real values, therefore, format specifications
should use only real descriptors (F, E, or G formats, and not I
format).
– BINARY. The output file is binary.
REGLIST, OPTION, IREG1(1), IREG2(IREG1), IRINC(1): Lists the values
stored in the specified graph registers.
OPTION
17-10
– BRIEF. A brief description of the registers in the range,
including the number of values, min, max and the register
label.
Version 3.26
Chapter 17
GRAPH MODULE
OPTION
– FULL. All values in the register will be listed. Only five
registers can be listed at a time.
IREG1,
IREG2,
IRINC
– Lists values from register IREG1 to register IREG2 with
increment of IRINC.
RLABEL, IREG(1), STATUS: Allows the user to define a text label for a graph
register. The text label is used in the graph legend. The command will prompt for
the text label.
IREG
– Graph register number.
STATUS
– ON (default). Writes the register text label in the legend.
– OFF. Does not write the register text label in the legend.
– DELETE. Deletes the register text label.
RTABLE, IREG(1), LINE/BAR(Y), SYMBOL(N), IREG2(0): Defines the
graph register type.
IREG
– Graph register number (1-NUMREG).
LINE/BAR
– If Y, the line type corresponding to IREG will be plotted. If N,
no lines will be plotted.
SYMBOL
– If Y, the symbol type corresponding to IREG will be plotted. If
N, no symbols will be plotted.
IREG2
– Second register, if needed: for difference bar graphs. The bar
plot will be the difference of the two values. Note that for
XBAR graphs, this corresponds to a y register and for YBAR
graphs this corresponds to an x register (default = 0).
RTLIST, IREG1(1), IREG2(IREG1), IRINC(1): Lists the graph register types.
IREG1,
IREG2,
IRINC
Version 3.26
– Lists types for registers from IREG1 to IREG2 with increment
IRINC. If ALL, all registers will be listed.
17-11
GRAPH MODULE
Chapter 17
Line/Symbol/Bar Type Definitions
BARLIST, IREG1(1), IREG2(IREG1), IRINC(1): Lists the different bar types.
IREG1,
IREG2,
IRINC
– Lists bar types for graph registers IREG1 to IREG2 with
increment IRINC. If ALL, all registers will be listed.
BARTYPE, IREG(1), ICOL(IREG), WIDTH(90), STYLE(1): Defines the bar
type to be used for plotting graph registers in bar graphs.
IREG
ICOL
– Colour pen to be used (1-99).
WIDTH
– Bar width (integer > 0, max = 100). This will give the width of
the bar with respect to the current plot. If 100 is used, there
will be no blank spaces in the plot for each set of bar plots.
STYLE
– Bar style.
Note: Current bar styles available are:
Style
Description
1
2
3
solid enclosed
solid open
empty
LINLIST, IREG1(1), IREG2(IREG1), IRINC(1): Lists the different line types.
IREG1,
IREG2,
IRINC
– Lists line types for graph registers IREG1 to IREG2 with
17-12
Version 3.26
Chapter 17
GRAPH MODULE
LINTYPE, IREG(1), ICOL(IREG), WIDTH(3), STYLE(1), NSKIP(0):
Defines the line type to be used for plotting graph registers.
IREG
ICOL
WIDTH
– Width of the pen to be used (integer > 0).
STYLE
– Line style (see below for definitions).
NSKIP
– Number of in-between points to skip (can be used to coarsen
the graph).
Note: Current line styles available:
Style
Description
1
2
3
4
5
6
7
8
solid
dot
dash
dash dot
filled polygon to bottom of frame
filled polygon to top of frame
filled polygon to left of frame
filled polygon to right of frame
SYMLIST, IREG1(1), IREG2(IREG1), IRINC(1): Lists the different symbol
types.
IREG1,
IREG2,
IRINC
– Lists symbol types for graph registers IREG1 to IREG2 with
SYMTYPE, IREG, ICOL(IREG), SIZE(8), STYLE(1), NSKIP(0): Defines the
symbol type to be used for plotting graph registers.
Version 3.26
IREG
ICOL
SIZE
– Symbol size (integer > 0). This is a percentage of the window
size.
17-13
GRAPH MODULE
Chapter 17
Register Manipulation
STYLE
– Symbol style (see below for definitions).
NSKIP
– Number of in-between points to skip (can be used to coarsen
the graph).
Note: Current symbol styles available:
Style
Description
1
2
3
4
5
6
7
8
9
10
solid dot
open dot
solid square
open square
solid triangle
open triangle
solid diamond
open diamond
solid inverted triangle
open inverted triangle
RCALCULATE, OPTION, REGS, REG1, REG2, VALUE1, VALUE2,
VALUE3: Calculates various series or summations based upon the option selected
and stores the result in a graph register.
17-14
OPTION
– /INT1/INT2/DER1/DER2/FOURIER/FEVAL/FORDER/.
REGS
– Graph register in which the values are stored.
Version 3.26
Chapter 17
GRAPH MODULE
REG1, REG2, – Depending upon the option chosen the following operations
VALUE1,
are performed:
VALUE2
– REGS = Single integration of REG2 with respect to
d(REG1) with initial value VALUE1 (INT1).
– VALUE3 specifies integration method.
– VALUE3 = 1 (trapezoidal rule).
– VALUE3 = 2 (second order curve).
– REGS = Double integration of REG2 and REG1 with initial
values VALUE2 and VALUE1 (INT2).
– REGS = Derivative of REG2 with respect to REG1 (DER1)
– REGS = Double derivative of REG2 with respect to REG1
(DER2).
– REGS = Fourier coefficients A and B up to order VALUE1
of values in REG2 and locations in REG1 (FOURIER).
– REGS = Fourier series evaluated at locations specified in
REG1 using the coefficients in REG2 up to order VALUE1
(FEVAL).
– REGS = Fourier series coefficient amplitudes up to order
VALUE1 of coefficients in REG2 for order tracking plots.
VALUE2 represents the step for each order and must be
greater than zero. VALUE3 is the offset in the y-direction.
The step values are stored in REG1 (FORDER).
REGS must be unique (different from REG1 and REG2).
RCLEAR, IR1, IR2, IRINC, ILOC1, ILOC2: Clears graph registers of values.
IR1, IR2,
IRINC
– Registers from IR1 to IR2 in increments of IRINC will be
cleared. If ALL is used, all registers will be cleared.
ILOC1,
ILOC2
– Values from locations ILOC1 to ILOC2 will be cleared. The
default is ALL where all values will be cleared.
RCLIP, IREGS, ILOCS, IREGF, ILOC1, ILOC2, ILINC: Clips values from
one graph register into another graph register.
Version 3.26
IREGS
– Graph register number for the values to be stored.
ILOCS
– Starting location in register IREGS to store the values.
IREGF
– Graph register number to clip the values from.
17-15
GRAPH MODULE
Chapter 17
ILOC1,
ILOC2,
ILINC
– Values from locations ILOC1 to ILOC2 by ILINC will be
clipped.
ROPERATE, OPTION, REG, REG1, REG2, SCALE1, SCALE2, FNCT1,
FNCT2: Stores the result of various operations on up to two graph registers in a
separate (output) graph register.
OPTION
– /ADD/MULTIPLY/DIVIDE/MINIMUM/MAXIMUM/.
REG
– Graph register number to be filled.
REG1, REG2, – Depending upon the option, the following operations will be
SCALE1,
performed on graph registers REG1 and REG2 to get graph
SCALE2,
register REG:
FNCT1,
– REG = (SCALE1*FNCT1(REG1)) +
FNCT2
(SCALE2*FNCT2(REG2))(ADD)
– REG = (SCALE1*FNCT1(REG1)) *
(SCALE2*FNCT2(REG2))(MULTIPLY)
– REG = (SCALE1*FNCT1(REG1)) /
(SCALE2*FNCT2(REG2))(DIVIDE)
– REG = MINIMUM(SCALE1*FNCT1(REG1),
SCALE2*FNCT2(REG2))(MINIMUM)
– REG = MAXIMUM(SCALE1*FNCT1(REG1),
SCALE2*FNCT2(REG2))(MAXIMUM)
SCALE1 and SCALE2 are scalar factors (default = 1.0). FNCT1 and FNCT2 are
regular library functions and may be:
FUNCTION – /SINE/COSINE/TANGENT/ASINE/ACOSINE/ATANGENT/
(radians).
– /DSIN/DCOSIN/DTANGEN/DASIN/DACOSIN/
/DATANGEN/ (degrees).
– /LOG10/LOGE/EXP10/EXPE/TANH/SQRT/ABSOLUTE/
/INVERSE/ **2/ **3/NINT/COSH/SINH/ or blank.
If REG2 is blank, the operation defaults to ADDition and if SCALE2 is not blank,
the following operation is performed:
REG = (SCALE1*FNCT1(REG1)) + SCALE2
17-16
Version 3.26
Chapter 17
GRAPH MODULE
Frame Definition
RSORT, IREGS(1), IREG1(2), IREG2(IREG1), IRINC(1), OPTION: Sorts
data values based on a graph register.
IREGS
– Register on which to base the sort.
IREG1,
IREG2,
IRINC
– Associated registers whose values will conform with the sort
of IREG. IREG1 to IREG2 with IRINC registers will be
affected.
OPTION
– /ASCEND/DESCEND/. Specifies ascending or descending
order for the sort.
Frame Definition
FRAME, FNUM, OPTION: Defines the characteristics of a frame, one by one.
Version 3.26
FNUM
– Frame number to be defined (1 to 6, default = 1).
OPTION
– GRTYPE,/CARTESIAN/POLAR/LOGLOG/XLOG/YLOG/
/XBAR/YBAR/PIE/,PERCENT. Defines the type of graph.
PERCENT is valid only for POLAR and PIE graphs. It gives
the radius of the minimum circle as a percentage of the
maximum circle (default = 0.0).
– LOCATE,/DEFAULT,PERCENT/CURSOR/ or
/SX1,SY1,SX2,SY2/ for non-polar graphs or
/SCX,SCY,SRAD/ for polar or pie graphs.
If DEFAULT, PERCENT, the graph size will be equal to a
percentage of the current window definition given by
PERCENT. If CURSOR, the cursor will be enabled to mark
the two opposite corners of the new graph frame.
– SX1,SY1. Coordinates of one corner of the graph window.
– SX2,SY2. Coordinates of the opposite corner of the graph
window.
– SCX,SCY. Screen coordinates of the centre of the polar plot.
– SRAD. Screen radius for the polar plot.
– XREG,/ADD/INITIALIZE/,IREG1,IREG2,…,IREG16.
Defines x-axis registers. ADD adds to the existing list. INIT
clears an existing list and defines a new list. IREG1 to IREG16
are register numbers to be plotted on the x-axis.
17-17
GRAPH MODULE
Chapter 17
Frame Definition
OPTION
17-18
– YREG,/ADD/INITIALIZE/,IREG1,IREG2,…,IREG16.
Defines y-axis registers. ADD adds to the existing list. INIT
clears an existing list and defines a new list. IREG1 to IREG16
are register numbers to be plotted on the y-axis. The registers
in XREG and YREG basically define the ordered pairs to be
plotted. The total number of y-axis registers defined will be the
number of graphs in the frame. For example:
FRAME,1,XREG,DEFI,1 and FRAME,1,YREG,DEFI,2,3
basically defines (1,2) and (1,3) as the two graphs to be plotted
in frame 1.
– XRANGE,XMIN,XMAX. Range for the x-axis. Values from
XMIN to XMAX will be plotted. The default is the entire
range.
– YRANGE,YMIN,YMAX. Range for y-axis. Values from
YMIN to YMAX will be plotted. The default is the entire
range.
– XTICK,MAJOR,NDIV,/REAL/INTEGER/,/INDENT/
/NOINDENT/,/BOTTOM/TOP/. Defines the tick marks for the
x-axis. Tick marks will be drawn at every segment of length
MAJOR with NDIV minor ticks with values being real/integer,
indented/not indented to prevent overlap, positioned at the
bottom/top, as specified.
– YTICK,MAJOR,NDIV,/REAL/INTEGER/,/LEFT/RIGHT/.
Defines the tick marks for the y-axis. Tick marks will be drawn
at every segment of length MAJOR with NDIV minor ticks
with values being real/integer, left/right, as specified.
– XTITLE,/DEFAULT/CURSOR/SX,SY/NONE/. Screen
coordinates for label starting position. If SX and SY are blank,
then the terminal crosshairs (cursor) will appear for the user to
mark the label position. The default location for the start of the
x-axis title is one-third the distance of the length of the axis
from the origin. The user will be prompted for the x-axis title
description. If NONE, no x-axis title will be present.
– YTITLE,/DEFAULT/CURSOR/SX,SY/NONE/. Screen
coordinates for label starting position. If SX and SY are blank,
then the terminal crosshairs (cursor) will appear for the user to
mark the label position. The default location for the start of the
y-axis title is one-third the distance of the length of the axis
from the origin. The user will be prompted for the y-axis title
description. If NONE, no y-axis title will be present.
Version 3.26
Chapter 17
GRAPH MODULE
Display
OPTION
– LEGEND,/DEFAULT/CURSOR/SX1,SY1,SX2,SY2/NONE/.
The terminal crosshairs (cursor) are used to mark any two
opposite corners of the region to be defined as the legend box.
– DEFAULT. The legend will be located at the default location
on the top right hand corner of the frame.
– SX1,SY1. Screen coordinates of one corner of the legend
box.
– SX2,SY2. Screen coordinates of the opposite corner of the
legend box.
– If NONE, no legend header will be present.
FRDEFINE, FNUM: Defines all characteristics of a frame.
FNUM
– Frame number to be defined (1 to 6, default = 1).
The user will be sequentially asked for:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
Type of graph
Location of frame
X-axis registers
Y-axis registers
Range for x-axis values
Range for y-axis values
X-axis tick marks
Y-axis tick marks
X-title location and description
Y-title location and description
Legend location and description
whose formats correspond to the definition of the individual options in the FRAME
command. Typing ABORT at any time will end the sequence.
Display
GMARK, IFRNUM(1), NMARK(1), LTYPE(1), STYPE(0), BTYPE(0),
XLOC, YLOC: Marks a graph frame with a line, symbol or bar. This command
will also prompt the user for the associated text.
Version 3.26
IFRNUM
– Frame number to mark.
NMARK
– Mark number. Up to 20 marks per frame are allowed.
LTYPE
– Graph register number referencing the line type used.
17-19
GRAPH MODULE
Chapter 17
Display
STYPE
– Graph register number referencing the symbol type used.
BTYPE
– Graph register number referencing the bar type used. If a bar
type is specified, this will override the LTYPE and STYPE
specifications.
XLOC,
YLOC
– Screen locations of the mark. If left blank, the program will
enable the cursor for use in picking the location.
Note: All marks of frame number IFRNUM can be explicitly turned off using
GRDISPLAY,IFRNUM,OFF,MARK.
GRDISPLAY, IFRNUM(1), STATUS(ON), OPTION(ALL), COLOR(1),
WIDTH/SIZE(0): Allows the user to turn several graph display options off or on
for a particular frame.
IFRNUM
– Frame number to affect.
STATUS
– /OFF/ON/.
OPTION
– One of /MAJOR/MINOR/XTITLE/YTITLE/FRAME/
/LEGEND/XSCALE/YSCALE/FBACK/LBACK/LHEAD/
/XAXIS/YAXIS/INFO/MARK/ALL/.
COLOUR
– One of 1 to 99.
WIDTH/
SIZE
– Width of the line or size of character (integer > 0, SIZE takes
values from 1 to 4 only).
Note: The following table shows the default status for the various options:
17-20
Description
Option
Status
Colour
Width
Size
Frame background
FBACK
OFF
0
–
–
Frame boundary
FRAME
ON
1
3
–
*Information
INFO
OFF
–
–
–
Legend boundary
LEGEND OFF
1
2
–
Legend header
LHEAD
ON
1
–
2
Legend background LBACK
ON
0
–
–
Mark
ON
1
–
–
MARK
Version 3.26
Chapter 17
GRAPH MODULE
Display
Description
Option
Status
Colour
Width
Size
Major grid lines
MAJOR
ON
1
2
–
Minor grid lines
MINOR
OFF
1
1
–
X axis line
XAXIS
ON
–
–
–
X axis scale values XSCALE ON
1
–
4
X axis title
XTITLE
ON
1
–
1
Y axis line
YAXIS
ON
–
–
–
Y axis scale values YSCALE ON
1
–
4
Y axis title
1
–
1
YTITLE
ON
*Information relating to the label; minimum and maximum values are printed
only if one graph is plotted.
If FRAME is OFF, MAJOR and MINOR get turned off automatically for plotting
purposes. IF MAJOR is OFF, MINOR gets turned off automatically for plotting
purposes.
If the option ALL is used, pre-set definitions for COLOUR and WIDTH/SIZE
will be used.
Defining a legend will turn LEGEND on.
If XAXIS and/or YAXIS are turned off, then the corresponding ticks at the major
and minor locations will also be turned off.
GRLABEL, FNUM, LNUM, STATUS, SIZE, IPEN, SX, SY: Allows the user to
add up to 20 different labels to a particular frame of the graph plot using screen
coordinates or the cursor device to define the label starting locations. This command
will prompt for the label text.
Version 3.26
FNUM
– Frame number for defining the label.
LNUM
– Label identifier (1 ≤ LNUM ≤ 20).
STATUS
– /OFF/ON/.
SIZE
– Character size of text.
IPEN
– Colour pen number to be used for text (1-99).
17-21
GRAPH MODULE
Chapter 17
Drawing
SX,SY
– Screen coordinates for label starting position. If SX and SY are
blank, then the terminal crosshairs (cursor) will appear for the
user to mark the label position.
GSPLIT, NFRAME, OPTION, PERCENT, FSTART, FINC: Splits the screen
into locations for the multiple frames.
NFRAME
– Number of frame locations to be defined (one of 2,3,4 or 6,
default = 2).
OPTION
– /HORIZONTAL/VERTICAL/. This is valid only if NFRAME
is 2 or 3. If HORIZONTAL, the screen is split horizontally. If
VERTICAL, the screen is split vertically.
PERCENT
– Percentage amount of the split screen to be used to draw the
frame (10-100, default = 70). Each frame will occupy this
percentage of the split window.
FSTART
– Starting frame number to be split (default = 1).
FINC
– Increment in frame number (default = 1).
Note: This command splits the current window definitions into NFRAME frames
with the specified OPTION.
Drawing
EDGRAPH, LF(case.ecd), VAR, N1(1), N2(N1), NINC(1), IREGS(1),
IFNUM(1): Defines a frame of STAR engineering monitoring data. A dependent
variable in the file is paired against iteration number (or time) for the selected range
of cell sets or regions.
LF
– Name of engineering cell or region data file (*.ecd or
*.erd) containing data.
VAR
– Variable to graph — one of the variables listed below from
Group 1 or Group 2.
Group 1 (for engineering cell data file *.ecd):
MASS
VOLU
17-22
– Mass
– Volume
Version 3.26
Chapter 17
GRAPH MODULE
Drawing
XAMOM
YAMOM
ZAMOM
– X component of Angular MOMentum
– Y component of Angular MOMentum
– Z component of Angular MOMentum
(Quantity)
Maximum
Value
Minimum
Value
Volume
Averaged
Value
Mass
Averaged
Value
(U velocity)
Umax
Umin
Uvav
Umav
(V velocity)
Vmax
Vmin
Vvav
Vmav
(W velocity)
Wmax
Wmin
Wvav
Wmav
(VMAGnitude)
VMAGmax
VMAGmin
VMAGvav
VMAGmav
(Pressure)
Pmax
Pmin
Pvav
Pmav
(TKEnergy)
TKEmax
TKEmin
TKEvav
TKEmav
(Dissipation)
EPSmax
EPSmin
EPSvav
EPSmav
(Temperature)
Tmax
Tmin
Tvav
Tmav
(Density)
RHOmax
RHOmin
RHOvav
RHOmav
(Length Scale)
LSmax
LSmin
LSvav
LSmav
(Time Scale)
TSmax
TSmin
TSvav
TSmav
(V2F)
V22max
V22min
V22vav
V22mav
(V2F)
F22max
F22min
F22vav
F22mav
(Reynolds Stress)
UUmax
UUmin
UUvav
UUmav
(Reynolds Stress)
VVmax
VVmin
VVvav
VVmav
(Reynolds Stress)
WWmax
WWmin
WWvav
WWmav
(Reynolds Stress)
UVmax
UVmin
UVvav
UVmav
(Reynolds Stress)
VWmax
VWmin
VWvav
VWmav
(Reynolds Stress)
UWmax
UWmin
UWvav
UWmav
(Scalar 1)
SC1max
SC1min
SC1vav
SC1mav
Group 2 (for engineering region data file *.erd):
ENin
Hflux
Mflux
SC1flu
Version 3.26
– for ENthalpy in/out.
– for Heat flux.
– for Mass flux.
– for SCalar 1 flux.
17-23
GRAPH MODULE
Chapter 17
Drawing
17-24
(Quantity)
Maximum
Value
Flux
Averaged
Value
Area
Averaged
Value
(U velocity)
Umax
Ufav
Uaav
(V velocity)
Vmax
Vfav
Vaav
(W velocity)
Wmax
Wfav
Waav
(VMAGnitude)
VMAGmax
VMAGfav
VMAGaav
(Pressure)
Pmax
Pfav
Paav
(TKEnergy)
TKEmax
TKEfav
TKEaav
(Dissipation)
EPSmax
EPSfav
EPSaav
(Temperature)
Tmax
Tfav
Taav
(Density)
RHOmax
RHOfav
RHOaav
(Length Scale)
LSmax
LSfav
LSaav
(Time Scale)
TSmax
TSfav
TSaav
(V2F)
V22max
V22fav
V22aav
(V2F)
F22max
F22fav
F22aav
(RS-Normal)
UUmax
UUfav
UUaav
(RS-Normal)
VVmax
VVfav
VVaav
(RS-Normal)
WWmax
WWfav
WWaav
(RS-Shear)
UVmax
UVfav
UVaav
(RS-Shear)
VWmax
VWfav
VWaav
(RS-Shear)
UWmax
UWfav
UWaav
(SCalar 1)
SC1max
SC1fav
SC1aav
(Quantity)
X-component Y-component Z-component
(Shear force)
Sxforce
Syforce
Szforce
(Normal force)
Nxforce
Nyforce
Nzforce
(Total force)
Txforce
Tyforce
Tzforce
(Shear torque)
Sxtorq
Sytorq
Sztorq
(Normal torque)
Nxtorq
Nytorq
Nztorq
(Total torque)
Txtorq
Tytorq
Tztorq
Version 3.26
Chapter 17
GRAPH MODULE
Drawing
N1, N2,
NINC
– Range of cell sets or regions to graph.
IREGS
– Starting graph register to store values. If the keyword NEXT is
entered, the lowest graph register not containing data will be
used. Register IREGS will contain values of iteration (or time).
Registers IREGS+1 to IREGS+NSETS, where NSETS is the
number of cell sets or regions indicated by the above range,
will contain values of variable VAR.
IFNUM
– Frame number to define.
GDRAW, FNUM1, FNUM2, FINC: Draws the graph.
FNUM1,
FNUM2,
FINC
– Frame FNUM1 (default = 1) to FNUM2 (default = FNUM1)
with increments of FINC (default = 1) will be plotted. If ALL,
all defined frames will be plotted.
GPAN, FNUM, SX, SY: Allows the user to change the centre of a graph using
either screen coordinates or the cursor to define the new centre. This command is
not valid for Polar and Pie plots.
FNUM
– Frame number to be panned (1 to 6 if defined, default = 1).
SX, SY
– Screen coordinates of the new centre. If left blank, the program
will enable the cursor for use in picking the point.
GPICK, FNUM, SX, SY: Gets the value of a picked point on the screen. This
command is not valid for Pie plots.
FNUM
– Frame number to be zoomed into (1 to 6 if defined,
default = 1).
SX, SY
– Screen coordinates of the value to be listed. If left blank, the
program will enable the cursor for use in picking the point.
Version 3.26
17-25
GRAPH MODULE
Chapter 17
Drawing
GREDRAW: Redraws the last graph. If user-defined parameters were changed
after an initial graph draw, these will be incorporated when the frames are re-drawn.
GZOOM, FNUM, STATUS, FX1, FY1, FX2, FY2: Allows the user to zoom in
on a portion of the graph plot using either screen coordinates or the cursor device to
define the region. This command is not valid for Polar and Pie plots.
FNUM
– Frame number to be zoomed into (1 to 6 if defined,
default = 1).
STATUS
– /OFF/ON/BACK/. OFF returns the screen to the default
settings. ON re-draws the plot based on the given screen
coordinates. BACK re-draws the plot based on a previous
GZOOM command settings.
FX1, FY1
– Screen coordinates of one corner of the region to be enlarged.
FX2, FY2
– Screen coordinates of the second corner of the region to be
enlarged.
If FX1,…,FY2 are all blank, then the terminal crosshairs (cursor) will appear and
the user should mark any two opposite corners of the region to be enlarged.
Note: The size of the frame remains the same, only the MIN & MAX values of the
two axis will change.
TBGRAPH, DEPVAR, VAR1, VAL1, VAR2, VAL2, …: Graphs selected
variables of the currently loaded table. All but one independent variable must be
fixed at some specified value.
DEPVAR
– Dependent variable to graph.
VAR
– Independent variable to fix when graphing.
VAL
– Value of fixed independent variable VAR.
17-26
Version 3.26
Chapter 18
ANIMATION MODULE
Chapter 18
ANIMATION MODULE
AOPTION, FUNCTION: Sets the animation parameters.
FUNCTION – /INITIAL/FINAL/TIME/PRECOMMAND/
/PLOTCOMMAND/POSTCOMMAND/WRITE/.
– /INITIAL/FINAL/,OPTION. Sets the animation parameters
for the initial or final view of an animation sequence by
copying the values currently in effect in the plot module. The
initial and final values can also be copied back to the plot
module so minor changes to an initial or final view can be
made easily. The values copied are the plot type, plot option,
surface, edge, view, angle, up axis, distance, centre,
perspective angle, light shading parameters and section
parameters.
– OPTION: /GET/PUT/. Gets the animation plot options
from the plot module or puts the animation plot options to
the plot module.
– TIME,INITIAL,FINAL,NFRAME,IROT. Sets the time of
the initial frame and final frame as well as the number of
frames required. Note that the number of frames includes
both the initial and final frames. The IROT flag is used to
control the direction of rotation if the initial and final view
are exactly 180 degrees apart. In this case, the default axis of
rotation is still found by finding the invariant vector direction
(eigenvector) between the two views. The vector is
calculated by normalising its length to one and making the
maximum component positive. Positive rotation is defined
about this axis using the right-hand rule.
– INITIAL. Time of the initial frame.
– FINAL. Time of the final frame.
– NFRAME. Number of frames to generate.
– IROT. Direction of rotation – greater than or equal to zero
is positive, less than zero is negative.
Version 3.26
18-1
ANIMATION MODULE
Chapter 18
FUNCTION
– PRECOMMAND,LOCATION. Sets the pro-STAR
commands to be executed just before the animation sequence
is run. pro-STAR prompts the user for the command
separately. Currently, the user can specify a maximum of 10
commands. If the user includes the string %TIME% in the
command, the RECRD command will replace this string
with the current time for that frame. Also by using
%TIME(FORMAT)%, the user can specify the format of
time where (FORMAT) is a legal format statement that
results in fewer than 20 characters. Before these commands
are executed, the equivalent of a ‘*SET,TIME,%TIME%,0’
command is executed so that all these commands can also
use the variable TIME to include the current time in a
command.
– LOCATION: /1-10/ERASE/. Specifies which of the ten
commands to change or erases them all.
– PLOTCOMMAND,INITIAL,SUBSEQUENT. Sets the plot
commands to be used during the animation sequence.
– INITIAL: /BLKPLOT/CPLOT/DPLOT/REPLOT/
/SPLOT/VPLOT/WPLOT/. Plots command for the first
frame.
– SUBSEQUENT: /BLKPLOT/CPLOT/DPLOT/
/REPLOT/SPLOT/VPLOT/WPLOT/. Plots commands for
the rest of the frame.
– POSTCOMMAND,LOCATION. Sets the pro-STAR
commands to be executed after the animation sequence is
run. pro-STAR prompts the user for the commands
separately. Currently, the user can specify a maximum of 10
commands. If the user includes the string %TIME% in the
command, the RECRD command will replace this string
with the current time for that frame. Also by using
%TIME(FORMAT)%, the user can specify the format of
time where (FORMAT) is a legal format statement that
results in fewer than 20 characters. Before these commands
are executed, the equivalent of a ‘*SET,TIME,%TIME%,0’
command is executed so that all these commands can also
use the variable TIME to include the current time in a
command.
– LOCATION: /1-10/ERASE/. Specifies which of the ten
commands to change or erases them all.
– WRITE, LF(case.anim). Writes to file LF all the
commands required to duplicate the current animation
parameters.
EXIT: Return to the PRO Module.
18-2
Version 3.26
Chapter 18
ANIMATION MODULE
GRAY: Plots a greyscale pattern. Several pictures of this pattern are taken at the
beginning of a roll of film before filming an animation sequence. These frames can
be used to correct for colour variations between rolls of film.
HELP
or
NPLOT, LF(case.plot), FRAME(1), OVEROPT, IPEN(0), COLORM,
PLTYPE: Plots the specified frame from the neutral plot file.
LF
– File name of the neutral plot file to be read. If neutral plots are
being written (as set in the TERMINAL command), LF cannot
be the same as the output neutral plot file (which defaults to
case.plot or is set in the NFILE command).
FRAME
– Sequence number of the frame to plot.
OVEROPT
– NOOVERLAY (default). The plot from the file will be plotted
alone.
– OVERLAY. The plot from the file will overlay the current plot.
IPEN
– If IPEN = 0, then the plot from the file will be drawn in its
original colours. Otherwise, the plot from the file will be
completely drawn using colour IPEN.
COLORM
– PREP/POST/. This is only required for neutral plot files
created with versions of pro-STAR before version 2.120. This
parameter specifies which colour map to use when plotting the
frame. The default is POST.
PLTYPE
– /VECT/RAST/. This is only required for neutral plot files
parameter specifies whether the frame was created as a vector
plot or a raster plot. The default is RAST.
PLAYBACK, LF(case.plot), FFRAME, LFRAME, NTIMES, NFRAME,
MININT, PAUSE, COLORM, PLTYPE: Plots and then animates the requested
frames from the neutral plot file.
LF
Version 3.26
– File name.
18-3
ANIMATION MODULE
Chapter 18
FFRAME
– Sequence number of the first frame to plot.
LFRAME
– Sequence number of the last frame to plot.
NTIMES
– The number of times to repeat the animation. Use zero for a
continuous display that is terminated with control-c.
NFRAME
– Number of frames to store on the graphics display. The default
is two. Zero or less displays the image directly onto the screen.
MININT
– The minimum number of intervals between each frame. An
interval is 1/60th of a second. For example, specifying this
parameter as 3 means that each frame will be displayed for at
least 1/20th of a second. Note: This feature may not be
PAUSE
– The number of seconds to pause before repeating the
animation sequence. Note: This feature may not be
COLORM
– PREP/POST/. This is only required for neutral plot files
parameter specifies which colour map to use when plotting the
frame. The default is POST.
PLTYPE
– /VECT/RAST/. This is only required for neutral plot files
parameter specifies whether the frame was created as a vector
plot or a raster plot. The default is RAST.
RECRD, LF(case.ani), SFRAME: Runs the animation sequence according to
the parameters set by the AOPTION command. pro-STAR commands are generated
and stored into file LF, which is then read by pro-STAR.
LF
– File name.
SFRAME
– The frame number to start with when running the sequence.
STATUS: Displays the status of all ANIMATION settings.
TMSTAMP, OPTION, STIME, ETIME, ICLROT, ICLRFL, X1, Y1, X2, Y2:
Puts a time stamp on the plot. A time stamp is a rectangular area that is filled in
proportion to how much time has elapsed up to the current plot. The rectangle is
18-4
Version 3.26
Chapter 18
ANIMATION MODULE
filled from left to right as time goes from STIME to ETIME. After the first issue of
the TMSTAMP command which sets the type and characteristics of the time stamp,
the command can be used again to change the current time displayed. If the CYLI
option is chosen, then the rectangle is filled from bottom to top to show the piston
position in an engine model animation. In this case, STIME is any time at bottom
dead centre and ETIME is the next time at bottom dead centre. If the CRANK
option is chosen, a circle is plotted and filled to indicate the crank angle. The STIME
and ETIME parameters are used in the same way as the CYLI option. X1 and Y1
are the coordinates of the centre of the circle while X2 and Y2 are those of any point
on the circumference of the circle. If X1, Y1, X2 and Y2 are not specified and there
is a plot on the screen, the user will be asked to use the cursor to define the box.
OPTION
– /OFF/BAR/CYLI/CRANK/TIME/. OFF turns the time stamp
off, BAR turns the regular (bar type) time stamp on, CYLI
turns the piston time stamp on, CRANK turns the crank angle
time stamp on and TIME sets the current time to STIME.
STIME
– The starting time of a plot sequence if OPTION is not OFF or
TIME, or the current time displayed if OPTION is TIME.
ETIME
– The ending time of a plot sequence.
ICLROT
– The colour index of the time stamp outline and lettering.
ICLRFL
– The colour index of the time stamp fill colour.
X1, Y1, X2, – The x and y coordinates of opposite corners of the time stamp
Y2
box.
Version 3.26
18-5
Chapter 19
EULERIAN MODULE
Chapter 19
EULERIAN MODULE
EBODY, IPHASE, IMAT, XDIR, YDIR, ZDIR, ICSYS(1), BFORCE(0.0):
Defines components of a body force for a dispersed phase and material.
IPHASE
– Phase number (2 in v3.20, 2 – N in future versions).
IMAT
XDIR, YDIR, – The vector indicating the direction of the body force. If all of
ZDIR
these fields are left blank, the default is XDIR = 0.0,
YDIR = 0.0, ZDIR = –1.0.
ICSYS
– The above vector is defined in coordinate system ICSYS,
which must be a Cartesian coordinate system.
BFORCE
– The body force magnitude.
EBRMONITOR, PHASE(2), IREG, /ALL/NONE/LIST/CLASSES/: Turns on
requests for STAR to write out dispersed PHASE data to a file containing specific
monitoring information on a boundary region-by-region basis.
PHASE
– Phase number (2 in v3.20, 2 – NPHASE in future versions).
IREG
– Boundary region number to monitor. The keyword ALL may
be used.
ALL
– Monitor all classes of data.
NONE
– Turn off monitoring for this region.
LIST
– List the classes monitored for this region.
CLASSES
– Any one or more of the following items are accepted:
– MFLU. Mass flux.
– ENIN. Enthalpy in/out.
– HFLU. Heat flux.
Each class below yields the maximum, flux-averaged and
area-averaged value per iteration or time step:
– VELO. U,V,W, Vmagnitude in coordinate system ICSYS.
– VF. Dispersed phase volume fraction.
– T. Dispersed phase temperature.
– DENS. Density.
Version 3.26
19-1
EULERIAN MODULE
Chapter 19
ECNDUCTIVITY, IPHASE(2), IMAT(1), OPTION: Sets the dispersed PHASE
thermal conductivity in material IMAT.
IPHASE
IMAT
OPTION
– CONSTANT,K(0.6203). Conductivity is constant and has a
value of K.
– POLYNOMIAL. Conductivity is defined by a polynomial
specified by the EPOK command for dispersed PHASE in
material IMAT.
– USER,K(0.6203). User subroutine CONDUC will be used to
define the conductivity. K is used for any cell not set in
CONDUC.
ECOPTION, OPTION: Defines solution control options for Eulerian multiphase.
OPTION
– AVVF. Solve for dispersed phase and continuous phase
volume fractions and take the average with volume fraction
limiting.
– DSVF. Solve for dispersed phase volume fraction only.
ECSMONITOR, PHASE(2), LF(case.set), NUMSET,
/ALL/NONE/LIST/CLASSES/: Turns on requests for STAR to write out
dispersed PHASE data to a file containing specific monitoring information on a
cell-set by cell-set basis. All the set definitions must be contained in a single set file
which has been created using pro-STAR command SETWRITE.
19-2
PHASE
LF
– File name in which set definitions are stored.
NUMSET
– Cell set number or four letter identifier of the set on file LF.
ALL
– Monitor all classes of data.
NONE
– Turn off monitoring for this cell set.
LIST
– List the classes monitored for this cell set.
Version 3.26
Chapter 19
EULERIAN MODULE
CLASSES
– Any one or more of the following items are accepted:
Each item below yields a value per iteration or time step:
– MASS. Mass.
– VOLU. Volume.
Each item below yields the minimum, maximum,
volume-averaged and mass-averaged variable per iteration or
time step:
– VELO. U,V,W, velocity magnitude in coordinate system
ICSYS.
– VF. Volume fraction.
– T. Temperature.
– DENS. Density.
EDENSITY, PHASE(2), IMAT(1), OPTION: Sets the dispersed PHASE density
calculation option for material IMAT.
PHASE
IMAT
OPTION
– CONSTANT,RHO(1000.). Density is constant and has a value
of RHO.
– ISOBARIC,DREF(1000.),BETA(0.0004). The density
equation solver is turned on to solve the isobaric equation. The
user must provide DREF (reference density) and BETA
(volumetric expansion coefficient).
EDRAG, PHASE(2), IMAT(1), OPTION, VALUE, EXPO(-1.7): Defines the
method of calculating the drag coefficient or drag force for a PHASE in material
IMAT.
Version 3.26
PHASE
IMAT
OPTION
– STANDARD. The drag coefficient is based on the standard
drag law for spherical particles (Schiller and Naumann).
– CONSTANT. The drag coefficient is a constant given by
VALUE.
– BUBBLE. The drag coefficient is derived for deforming gas
bubbles rising in still water (Wang curve-fit).
19-3
EULERIAN MODULE
Chapter 19
OPTION
– HIGHPL. The drag force is computed according to the high
particle loading formulation and is a combination of the
hindered settling effect for less dense and the Ergun law for
denser compaction.
– USER. User subroutine UEDRAG is activated for defining the
drag coefficient.
VALUE
– If OPTION is:
– CONSTANT, VALUE = constant drag coefficient value
(default = 0.44).
– HIGHPL, VALUE = transition volume fraction from dilute
to dense state (default = 0.2).
EXPO
– If OPTION is HIGHPL, EXPO is the exponent in the hindered
settling effect formulation.
EEDGRAPH, IPHASE(2), LF(case.ecd2), VAR, N1(1), N2(N1), NINC(1):
Graphs STAR engineering monitoring data for a dispersed PHASE in an Eulerian
multiphase calculation. A dependent variable in the file is graphed versus iteration
number (or time) for the selected range of cell sets or regions.
IPHASE
LF
– Name of engineering cell or region data file (*.ecd2 or
*.erd2) containing data.
VAR
– Variable to graph — one of the variables listed below from
Group-1 (cell-volume related data) or Group-2 (boundary
region surface data).
Group-1 (for engineering cell data file *.ecd2):
MASS
VOLU
19-4
– Mass.
– Volume.
(Quantity)
Maximum
Value
Minimum
Value
Volume
Averaged
Value
Mass
Averaged
Value
(U velocity)
Umax
Umin
Uvav
Umav
(V velocity)
Vmax
Vmin
Vvav
Vmav
(W velocity)
Wmax
Wmin
Wvav
Wmav
(Vmagnitude)
VMAGmax
VMAGmin
VMAGvav
VMAGmav
Version 3.26
Chapter 19
EULERIAN MODULE
(Quantity)
Maximum
Value
Minimum
Value
Volume
Averaged
Value
Mass
Averaged
Value
(VolumeFraction)
VFmax
VFmin
VFvav
VFmav
(Temperature)
Tmax
Tmin
Tvav
Tmav
(Density)
RHOmax
RHOmin
RHOvav
RHOmav
Group-2 (for engineering region data file *.erd2):
Mflux
ENin
Hflux
– for mass flux.
– for enthalpy in/out.
– for heat flux.
(Quantity)
Maximum
Value
Minimum
Value
Volume
Averaged
Value
(U velocity)
Umax
Ufav
Uaav
(V velocity)
Vmax
Vfav
Vaav
(W velocity)
Wmax
Wfav
Waav
(Vmagnitude)
VMAGmax
VMAGfav
VMAGaav
(VolumeFraction)
VFmax
VFfav
VFaav
(Temperature)
Tmax
Tfav
Taav
(Density)
RHOmax
RHOfav
RHOaav
N1, N2,
NINC
– Range of cell sets or regions to graph in NINC increments.
EEDLOAD, IPHASE(2), IREG, LF(case.ecd2), VAR, ISRN(1), ITER1(1),
ITER2(ITER1), INCI(1): Loads STAR engineering monitoring data for dispersed
PHASE into a graph register.
Version 3.26
IPHASE
IREG
– Graph register to fill. Lowest register number not containing
data is default.
19-5
EULERIAN MODULE
Chapter 19
LF
– Name of engineering cell or region data file (*.ecd2 or
*.erd2) containing data.
VAR
– Name of dependent variable to load.
ISRN
– Set or region number to load.
ITER1,
– Range of iterations (or time) to load. If ALL is entered for
ITER2, INCI ITER1, data for all iterations (or time steps) on the file will be
loaded. If data does not exist for an iteration, a 0. will be
entered in the graph register for that iteration.
EGEBOUNDARY, PHASE(2), VECOPT, SCALAROPT
or
EGEBOUNDARY, PHASE(2), SCALAROPT: Defines the Eulerian multiphase
data (PHASE > 1) which the user wishes to store in memory for printing, plotting,
and other manipulation. The data are stored as boundary data and for plotting
purposes they are considered constant over the area of each cell face. Upon first use
of this command or the EGEBOUNDARY command, pro-STAR automatically
creates wall shells on the boundaries with the following cell types:
Cell Type
On Boundaries
MXTB+1
MXTB+2
MXTB+3
MXTB+4
Partial boundaries
of wall shells. For the continuous phase (PHASE = 1), the GETBOUNDARY
command must be used.
19-6
PHASE
VECOPT
The following vector data may be loaded:
– ALL (default). Loads all three components of the
computational velocity of the selected phase into post
registers 1-3.
– /U/V/W/. Loads only the U-, V-, or W-component of the
registers 1, 2, or 3, respectively.
– NONE. No vector data will be loaded into post registers
1-3.
Version 3.26
Chapter 19
EULERIAN MODULE
SCALAROPT
The following scalar data may be loaded into post register 4:
– SCALARNAME. Uses command EPLIST PHASE to find
out the scalar names for disperse PHASE.
EGECELL, PHASE(2), VECOPT, SCALAROPT
or
EGECELL, PHASE(2), SCALAROPT: Defines the dispersed PHASE data for
Eulerian multiphase (PHASE > 1) which the user wishes to store in memory for
printing, plotting, and other manipulation. The data are stored as cell data and are
considered constant over the volume of each cell. All items currently stored in any
of the 6 post registers are cleared each time a new EGECELL command is issued.
For the continuous phase (PHASE = 1), the GETCELL command must be used.
PHASE
VECOPT
registers 1-3.
– FLAV. Loads the flux averaged velocity of the selected
phase into post registers 1-3.
– FLUX. All six mass flux components of the selected phase
are loaded simultaneously. The fluxes can then be displayed
on an EHIDDEN contour plot and/or summed using the
FLUXSUM command. Individual flux components may be
loaded using one of /F1/F2/F3/F4/F5/F6/. If any of these
flux options are chosen, no SCALAROPT may be used.
1-3.
SCALAROPT
out the scalar names for the dispersed PHASE.
EGEVERTEX, PHASE(2), VECOPT, SCALAROPT
or
EGEVERTEX, PHASE(2), SCALAROPT: Defines the Eulerian multiphase data
Version 3.26
19-7
EULERIAN MODULE
Chapter 19
(PHASE > 1) which the user wishes to store in memory for printing, plotting, and
other manipulation. The data are stored as vertex data. All items currently stored in
any of the 6 post registers are cleared each time a new EGEVERTEX command is
issued. For the continuous phase (PHASE = 1), the GETVERTEX command must
be used.
PHASE
VECOPT
registers 1-3.
– COOR. Loads vertex coordinates from analyses with
moving meshes into post registers 1-3. The user can then
plot using the deformed geometry.
1-3.
SCALAROPT
out the scalar names for the dispersed PHASE.
EGSTAR, IPHASE(2), LF(case.reu), TYPE, IMAT(1), IREGS(1),
ILOC(1), OPTION, LOPTION: Gets STAR residuals (or rates of change) and
monitored values from a direct access file for a dispersed Eulerian PHASE in
material IMAT. These are set up to be plotted versus iteration number in frames 1
and 2 for fluids, and frame 1 for solids.
19-8
IPHASE
LF
– Name of a STAR residual post file.
TYPE
– /HEADER/FLUID/. HEADER will list the information in the
direct access file.
IMAT
– Fluid material number for which the values will be extracted.
IREGS
– Starting register number to begin the storage. This will contain
the iteration number.
ILOC
– Starting location number to start loading the values. If
CURRENT is used, then existing iterations in IREGS will be
overwritten by corresponding iterations from this file.
Version 3.26
Chapter 19
EULERIAN MODULE
OPTION
– BOTH. Extracts both residuals (or rates of change) and
monitored values.
– RESIDUAL. Only residuals (or rates of change) will be
extracted.
– MONITORED. Only monitored values will be extracted.
LOPTION
– ALL. Graph all iteration numbers in the file.
– ITER1(1),ITER2(ITER1),ITINC(1). Graph iteration numbers
in the range ITER1 to ITER2 by ITINC.
Prior to storing data, it is advisable to check the file using the HEADER type option.
EGTRANS, IPHASE(2), LF(case.pstt), TYPE, IREGS, IREGL, ILOC,
OPTION: Gets STAR transient values for an Eulerian dispersed PHASE.
IPHASE
– Phase number (2 in v3.20, 2 NPHASE in future versions).
LF
– Name of a STAR transient post file.
TYPE
– /GETC/GETV/. Type of data to be extracted. Cell or vertex
data can be extracted.
IREGS
– Starting graph register number for storing the values. This
register will contain the iteration number. Register IREGS+1
will contain the time step values. Values for the option chosen
will be stored in registers IREGS+2 onwards.
IREGL
– Graph register number containing the cell or vertex numbers
for which the values will be extracted. There should be enough
registers defined to fit all the values for all the items present in
this register.
ILOC
– Starting location number to start loading the values (default =
1).
OPTION
– ALL. Values for all time steps (all iterations) stored in the
current transient file will be extracted.
– TIME,TMIN,TMAX. Values between time steps TMIN and
TMAX will be extracted.
– ITER,ITMIN,ITMAX. Values between iterations ITMIN and
ITMAX will be extracted.
This command will prompt for the required arguments of the EGECELL,
EGEVERTEX commands. Post values in the post registers, if present, will be
destroyed.
Version 3.26
19-9
EULERIAN MODULE
Chapter 19
EHTRANSFER, PHASE(2), IMAT(1), OPTION, VALUE(2.0): Defines the
Nusselt number for calculating the heat transfer coefficient between a dispersed
PHASE and the continuous phase.
PHASE
IMAT
OPTION
– CONSTANT. Nusselt number is a constant given by VALUE
(default is 2.0, corresponding to a single sphere).
– RANZ. Nusselt number is defined according to the Ranz and
Marshall model.
– USER. Nusselt number is specified through user subroutine
UEHEAT.
VALUE
– A user-specified value for option CONSTANT.
EINITIAL, PHASE(2), IMAT(1), UOPTION, UIN(0.0), VIN(0.0), WIN(0.0),
OMEGAIN(0.0), VFIN(0.1), TIN(293.0): Defines dispersed PHASE initial
conditions for a material IMAT. These are used during the first iteration before any
field results are available. Values have to be supplied only for equations that are
solved.
PHASE
IMAT
UOPTION
– /STANDARD/USER/. If UOPTION is USER, STAR will use
user subroutine INITFI to define initial conditions.
UIN, VIN,
WIN
– Components of velocity in the U, V and W directions,
specified in the coordinate system selected via command INIT.
OMEGAIN
– Initial omega.
VFIN
– Initial dispersed PHASE volume fraction.
TIN
– Initial dispersed PHASE temperature.
EINTERNAL, PHASE(2), IMAT(1), OPTION, MAXPACKING(0.63),
RESTITUTION(0.9): Defines a dispersed PHASE internal force, such as solid
particle stress, for a given material IMAT. The force acts within the dispersed phase
only.
PHASE
19-10
Version 3.26
Chapter 19
EULERIAN MODULE
IMAT
OPTION
– NONE. No internal force.
– SPRESSURE. Solid pressure force.
– KINETIC. Dispersed phase particles stress is based on
kinetic theory.
MAXPACKING – Maximum volume fraction for dispersed phase particles.
RESTITUTION – Restitution coefficient for the Kinetic Theory model.
ELVISCOSITY, PHASE(2), IMAT(1), OPTION: Sets the dispersed PHASE
molecular viscosity for material IMAT.
PHASE
IMAT
OPTION
– CONSTANT,LAMVIS(0.000889). Molecular viscosity is
constant and has a value of LAMVIS.
– INVISCID. Molecular viscosity is 0.0.
– NONNEWTONIAN,EM(0.0),EN(0.0). The molecular
calculated according to the non-Newtonian power law which
requires the constants EM and EN.
– SUTHERLAND,MU0(1.716E-5),CS(116.0). Molecular
viscosity is defined by Sutherland’s Law. MU0 is the reference
dynamic viscosity and CS is the Sutherland constant specified
at 273.15 degrees Kelvin (0 degrees Centigrade) and 101325
Pascals (1 atmosphere).
– POLYNOMIAL. Molecular viscosity is defined by a
polynomial specified by the EPLV command for the current
PHASE and material IMAT.
– USER,LAMVIS(0.000889). User subroutine VISMOL will be
used to define the molecular viscosity. LAMVIS is used for
any cell not set in VISMOL.
EMOLWT, IPHASE(2), IMAT(1), WTMOL(18.0): Sets the value of the
molecular weight of dispersed PHASE in material IMAT.
Version 3.26
IPHASE
IMAT
19-11
EULERIAN MODULE
Chapter 19
WTMOL
– The molecular weight value.
EMOMENTUM, PHASE(2), IMAT(1), MOMT, OPTION, VALUE: Defines
the interphase momentum transfer processes other than drag force for a PHASE in
material IMAT (drag force is defined through command EDRAG).
PHASE
IMAT
MOMT
– VIRM. Specifies the virtual or added mass force.
– LIFT. Specifies the lift force.
OPTION
– OFF. Corresponding force is switched off (default for
MOMT = VIRM).
– ON. Corresponding force applies with a constant coefficient
given by VALUE (default for MOMT = LIFT).
VALUE
– A constant virtual mass coefficient or lift force coefficient. The
default VALUE for MOMT = VIRM is 0.5. The default
VALUE for MOMT = LIFT is 0.25. This is ignored if
OPTION = OFF.
EMPHASE, NPHASE(2), IMAT(1), OPTION: Activates/deactivates a
multi-fluid model containing NPHASE phases for a given material stream IMAT.
NPHASE
– Maximum number of phases. (Note: The only valid value for
v3.20 is 2. This will be extended in future.)
IMAT
– Material number. (Note: For v3.20, only one material is
allowed, IMAT = 1. It is listed here to allow for future
extension.)
OPTION
– ON. Eulerian multiphase calculation is activated.
– OFF. Eulerian multiphase calculation is deactivated.
A dispersed phase can be in the form of bubbles, droplets or particles. For brevity,
the Help information provided refers to the dispersed phase only as particles.
EPCP, IPHASE(2), IMAT(1), OPTION: Defines a polynomial function to
19-12
Version 3.26
Chapter 19
EULERIAN MODULE
describe specific heat, enthalpy and entropy for dispersed PHASE in material
IMAT.
Version 3.26
IPHASE
IMAT
OPTION
CHEMKIN thermodynamic database. The dispersed phase
substance name will be prompted for. By default, the
CHEMKIN database consists of two ranges with coefficients
for specific heat (up to 5, the sixth value is for enthalpy and the
seventh for entropy) and the user can append to or modify the
database using the following format:
– Line 1: species name, optional comments, elemental
composition, phase, T(low), T(high), T(mid), additional
elemental composition, card number (col. 80); format
(A10,A14,4(A2,I3),A1,E10.0,E10.0,E8.0,(A2,I3),I1).
(col. 80); format (5(E15.0),I1).
chemkin.dbs file.
19-13
EULERIAN MODULE
Chapter 19
OPTION
cecthrm.dbs, containing the thermodynamic database used
by the NASA Chemical Equilibrium Codes. The dispersed
phase substance name will be prompted for. By default, the
CEC database consists of two ranges with coefficients for
specific heat (up to 5, the sixth value is for enthalpy and the
seventh for entropy) and the user can append to or modify the
database keeping in mind the following general format:
(A12,A6,4(A2,F3.0),A1,E10.0,E10.0,14X,I1).
(col. 80); format (5(E15.0),I1).
cecthrm.dbs file.
their values.
cleared.
from TRANGE1 to TRANGE2 (default is the entire range)
with temperature, specific heat, enthalpy and entropy values
stored in graph registers REG1, REG2, REG3 and REG4,
molecular weight (WTMOL) is specified, c p , h and s will be
stored.
19-14
Version 3.26
Chapter 19
EULERIAN MODULE
cp
----- =
R
h
--- =
R
n
i–1
∑ ai T
i=1
n
∑
i=1
i
ai T
---------- + a n + 1
i
s
--- = a 1 ln T +
R
n
∑
i–1
i=2
⎛a T
------------ ⎞ + a n + 2
⎝ i i–1⎠
EPHASE, IPHASE(1): Switches between phases.
IPHASE
– Phase number (1 or 2 in v3.20, 2 – NPHASE in future
versions).
EPLIST, PHASE(2): Lists stored data names in the currently loaded post file for a
dispersed PHASE.
PHASE
EPLV, IPHASE(2), IMAT(1), IPTYP(2), OPTION: Defines a polynomial
function to describe the molecular viscosity of a dispersed PHASE in material
IMAT.
Version 3.26
IPHASE
IMAT
19-15
EULERIAN MODULE
Chapter 19
IPTYP
– Parameter determining the polynomial form to use:
For IPTYP = 1
n
µ =
∑ ai T
(i – 1)
i=1
For IPTYP = 2
n
ln ( µ ) =
∑ ai ( ln T
(i – 1)
)
i=1
For IPTYP = 3
n
ln ( µ ) =
ai
--------------------(i – 1)
ln
T
i=1
∑
where a i are the prescribed coefficients.
OPTION
19-16
their values.
cleared.
– VISCO,SPECIES. Coefficients for the material are retrieved
from an internal database called visco.dbs. SPECIES is the
dispersed phase. This option allows only one temperature
Version 3.26
Chapter 19
EULERIAN MODULE
EPOK, IPHASE(2), IMAT(1), IPTYP(2), OPTION: Defines a polynomial
function to describe the dispersed PHASE thermal conductivity in material IMAT.
IPHASE
IMAT
IPTYP
below):
For IPTYP = 1
n
k =
∑ ai T
(i – 1)
i=1
For IPTYP = 2
n
ln ( k ) =
∑ ai ( ln T
(i – 1)
)
i=1
For IPTYP = 3
n
ln ( k ) =
ai
--------------------(i – 1)
ln
T
i=1
∑
where a i are the prescribed coefficients.
OPTION
Version 3.26
their values.
cleared.
19-17
EULERIAN MODULE
Chapter 19
OPTION
– CONDU,SPECIES. Coefficients for the material are retrieved
from an internal database called condu.dbs. SPECIES is the
dispersed phase. This option allows only one temperature
ERDEFINE, PHASE(2), NREGION: Defines the characteristics of a boundary
region for a dispersed PHASE. The boundary region type for region NREGION is
defined by using command RDEFINE. The option for using a table or user
subroutine is also specified in command RDEFINE.
PHASE
NREGION
– The region number to which the following characteristics will
be applied. Region 0 contains the values used for the default
domain boundaries.
Based on the boundary type (defined with command RDEFINE) and the equations
and options that have been turned on, pro-STAR will prompt for the following
values (not necessarily in the order given here):
BTYPE = INLET
19-18
Value
Description
When Prompted For
U,V,W
Velocity components
Always
OMEGA
Omega
Always
VF
Dispersed phase volume fraction
Always
DEN
Density
Always
T
Temperature
Version 3.26
Chapter 19
EULERIAN MODULE
BTYPE = WALL
Value
Description
When Prompted For
SPOPT
Always
BTYPE = PRESSURE (see also command ERTPRESSURE)
Value
Description
When Prompted For
U,V,W
Velocity components
UVW for phase 1 = Y
OMEGA
Omega
UVW for phase 1 = Y
BTYPE = CYCLIC
Value
Description
When Prompted For
TBULK
Bulk temperature
OPT1 for phase 1 = PARTIAL
and temperature solver on for
either phase
VFBULK
Bulk volume fraction
OPT1 for phase 1 = PARTIAL
and volume fraction solver on
BTYPE = BAFFLE
Note: Baffle boundaries have two sides. The following values will be prompted for
twice, once for each side. Entering ‘SAME’ on the second pass will assign the
values for side 1 to side 2.
Value
Description
When Prompted For
SPOPT
Always
ERELAX, PHASE(2), RLVEL, RLVF, RLT: Sets the value of the relaxation
factors used in solving for each of the respective variables. RLVEL is used for the
PHASE U, V and W. RLVF is used for the PHASE volume fraction, RLT for the
PHASE enthalpy equation. Two forms of this command can be used. The user can
type ‘ERELAX, 2, 0.2, 0.5, 0.5’ to change all of the values in one line.
Alternatively, the user may type ‘ERELAX,PHASE,RLVEL,0.2’ to change the
value of a single relaxation parameter. Typing ‘ERELAX,PHASE,DEFAULT’ sets
all variables to their recommended values.
Version 3.26
19-19
EULERIAN MODULE
Chapter 19
PHASE
RLVEL,
RLVF, RLT
– Under-relaxation factors as described above.
ERESIDUAL, PHASE(2), RSVF(1E-6): Sets the values of the residual error
tolerances used for judging convergence of the dispersed PHASE volume fraction.
Typing ‘ERESID,2,DEFAULT’ will set RSVF to its recommended value.
PHASE
– Phase number.
RSVF
– Provides the desired residual error tolerance for PHASE
volume fraction.
Note: The residual values for the dispersed phase UVW, T are the same as for the
continuous phase.
ERLIST, PHASE(2), NREG1(0), NREG2(NREG1), NRINC(1): Lists the
definition of each boundary region for a dispersed PHASE.
PHASE
NREG1,
NREG2,
NRINC
– List the definitions for regions NREG1 to NREG2 by NRINC.
ERMODIFY, PHASE(2), NREG(1): Modifies the characteristics of an already
defined boundary region for a dispersed PHASE. The program will prompt for
boundary condition values, which are dependent on the boundary type (BTYPE) of
the region and the set of equations turned on. Entering a ‘U’ for any value will leave
it unchanged from the previous definition. This command does not change the
BTYPE of a boundary region; to change the BTYPE, use the RDEFINE command
instead.
19-20
PHASE
NREG
– The region number whose characteristics will be modified.
Version 3.26
Chapter 19
EULERIAN MODULE
ERTPRESSURE, IPHASE(2), NREG(1), TOPTION, VOPTION: Sets
temperature and volume fraction options for pressure boundary regions in the
dispersed phase.
IPHASE
– Phase number (2 in v3.20, 2 – NPHASE in future versions)
NREG
– The boundary region number, which must be a pressure region.
TOPTION
– TEMPERATURE,T(293.0). Supplies a boundary temperature
value T for the dispersed phase.
– ZGRADT. Boundary temperatures will be calculated by
STAR.
VOPTION
– VOLFRACTION,VF(0.1). Supply the dispersed phase volume
fraction VF.
– ZGRADV. Dispersed phase volume fractions will be
calculated by STAR.
ESIZE, PHASE(2), IMAT(1), OPTION, VALUE(0.001): Defines the particle
diameter of a dispersed PHASE in material IMAT.
PHASE
IMAT
OPTION
– 1. Fixed size model.
VALUE
– Mean particle diameter (m).
ESOLVE, PHASE(2), LU, LV, LW, LVF, LT, LDEN, LLAMVIS, LCP,
LCONDUC: Controls the variables that are solved or calculated for the dispersed
PHASE in Eulerian multiphase simulation. Two forms of this command can be
used. The user can type ‘ESOLVE,2,Y,Y,N,Y,N,...’ in order to change all the
settings in one line. Alternatively, the user may type ‘ESOLVE,2,LVF (or any other
variable name),Y (or N)’ to change the value of a single parameter.
PHASE
Version 3.26
19-21
EULERIAN MODULE
Chapter 19
LU, LV, LW, – Provide either Y(es) or N(o) for each variable. A blank for a
LVF, LT,
LDEN,
setting.
LLAMVIS,
LCP,
LCONDUC
Notes:
1. The solution of a variable is sometimes conditional on having previously
issued another command that sets up all the parameters needed in that
solution process. The list of such variables and the corresponding command
that enables their solution is as follows:
Variable
Meaning
Command
LU
U component of velocity
EMPHASE
LV
V component of velocity
EMPHASE
LW
W component of velocity
EMPHASE
LVF
Volume Fraction
EMPHASE
LT
Temperature
ETEMP
LDEN
Density
EDENS
LLAMVIS
Molecular viscosity
ELVIS
LCP
Specific heat
ESPEC
LCONDUC
Thermal conductivity
ECNDUC
2. pro-STAR will automatically turn on the solution of any of the above
variables when the corresponding enabling command is first used. Thus,
turning on the solution explicitly via command SOLVE is unnecessary in this
case.
3. Command ESOLVE can be used at any stage to turn any variable solution off,
if that is required for whatever reason, e.g. turning off LU, LV or LW in
two-dimensional models. The solution can always be turned back on again if
required.
ESPECIFICHEAT, IPHASE(2), IMAT(1), OPTION: Sets the dispersed
PHASE specific heat for a given material IMAT. The notes for command
SPECIFICHEAT also apply here.
IPHASE
19-22
Version 3.26
Chapter 19
EULERIAN MODULE
IMAT
OPTION
– CONSTANT,C(4182.). The specific heat is constant and has a
value of C.
– POLYNOMIAL. The specific heat is defined by a polynomial
specified by the EPCP command for the dispersed PHASE in
material IMAT. The user must also provide the corresponding
molecular weight using command EMOLWT.
ESWEEP, IPHASE(2), NSVF: Sets the maximum number of sweeps used in
solving for the dispersed PHASE volume fraction equation.
IPHASE
– Phase Number (2 in v3.20, 2 - NPHASE in future versions).
NSVF
– Provide the maximum number of sweeps for the volume
fraction. A blank (or 0.) will leave it unchanged from its
previous setting.
Note: The SWEEPS value for the dispersed phase UVW, T are the same as for the
continuous phase.
ETEMPERATURE, IPHASE(2), STATUS: Sets dispersed PHASE enthalpy
equation options.
IPHASE
STATUS
– OFF. Temperature is not a variable.
– ON. Temperature is solved for using the static enthalpy
equation.
ETURB, IMAT(1), OPTION(1), CTOPTION(1), TDRAG, SCHDG(1.0):
Defines Eulerian multiphase turbulence model options.
Version 3.26
IMAT
OPTION
– 1. Solve for continuous phase turbulence; dispersed phase
turbulence is calculated from the continuous phase using a Ct
model.
19-23
EULERIAN MODULE
Chapter 19
CTOPTION – 1. Ct = 1.
– 2. Ct is calculated from the bubble-eddy interaction model of
Issa.
– 3. User coding for Ct, as given in subroutine UETURB.
TDRAG
– OFF. Turbulence drag is off.
– ON. Turbulence drag is on.
SCHDG
– Turbulence drag Schmidt number (> 0, default 1.0).
HELP
or
19-24
Version 3.26
Chapter 20
AUTOMESH MODULE
Chapter 20
AUTOMESH MODULE
BAMM, FUNCTION: The BAMM command is used to generate a trimmed mesh.
Generally, a volume mesh is generated from a surface definition. The process of
generating a trimmed mesh can be divided into separate processes (subsurface
generation, cutting, adjusting and extrusion layer generation) and each process can
be done separately.
Some general notes about this command. The mesh features such as the surface
definition must be stored in the database before using this command. Refer to “The
DBASE command” in this help file for a complete description.
The ammbatch results are placed in the database which means you must execute
a DBASE,ADD or DBASE,GET before you can plot the results or modify the mesh.
In the BAMM functions, the following parameters are commonly used:
Version 3.26
ID
– The mesh set in the database is identified by an id number.
The mesh id is a positive integer.
EOPTION
– /NEW/OVERWRITE/. The EOPTION tells pro-STAR what
to do if a mesh set or file already exist. If the NEW
EOPTION is chosen and the entry already exists, the
function is aborted and an error condition is generated. Use
OVERWRITE to delete the existing entry and replace it
with the new one.
FUNCTION
– /SURFACE/SUBSURFACE/CUT/CUTADJUST/EXTRUD
E/ /COLOR/PROC/OTHDEL/OTHER/.
20-1
AUTOMESH MODULE
Chapter 20
BAMM,
– ammbatch converts all general shells used to define the
SURFACE,
surface of the object to be meshed into triangular shells. If
SURFACE ID,
the ANGLE parameter is specified, ammbatch generates
NEW SURFACE edges and corners. However, ammbatch will not create any
ID,
isolated edges. An isolated edge is an edge which has no
ANGLE(180.0), adjacent edges linking to it. If the MAX EDGE LENGTH
MAX EDGE
parameter is specified, ammbatch cuts all shell edges longer
LENGTH,
than this parameter to shell edges shorter than this
EOPTION
parameter.
Sometimes it is useful to see the exact surface mesh that
ammbatch is using. This function returns the surface mesh
exactly as ammbatch uses it.
To have ammbatch generate edges and corners, you must
use this function to generate an ammbatch surface and use
this new surface in subsequent functions.
– SURFACE ID. The mesh set ID in the database of the
surface shells to be sent to ammbatch. See ID above.
– NEW SURFACE ID. The mesh set ID where the
ammbatch surface is stored in the database. See ID above.
– ANGLE. When the angle between shells is less than this
angle, an edge is defined along the common shell
boundary. Points are also defined when three generated
edges meet. The default angle is 180 degrees which means
that edges will never be generated since the angle between
them cannot be greater than 180.
– MAX EDGE LENGTH. When a shell edge or a feature
edge is longer than this length, it is cut into pieces shorter
than this length. The default is to do NO cutting.
BAMM,
– Trimmed models always contain an extrusion layer which
SUBSURFACE, allows for a more regular mesh at the surface by generating
SURFACE ID,
grid lines as normal to the surface as possible. The extrusion
SUBSURFACE layer is generated between the surface and the subsurface.
ID, CELL
The subsurface is generated by moving the surface inward a
LENGTH,
fixed distance.
FACTOR(0.5),
EOPTION
surface shells to be sent to ammbatch. To have ammbatch
automatically generate edges and corners, you must use
the SURFACE function. See ID above.
– SUBSURFACE ID. The mesh set ID where the ammbatch
subsurface is stored in the database. See ID above.
– CELL LENGTH and FACTOR. The amount to move the
subsurface inward from the surface is CELL LENGTH
times FACTOR.
20-2
Version 3.26
Chapter 20
AUTOMESH MODULE
BAMM, CUT, – The cutting processes takes a structured mesh, which can
SURFACE ID,
either be generated by the program or supplied by the user,
TRIMMED
and sees if each cell is inside, outside or straddling the
MESH ID,
surface. If the cell is completely inside, it is left as is. If a
CELL
cell is completely outside, it is removed from the mesh.
LENGTH,
Cells which straddle the surface are cut into the simplest
FACTOR(0.5),
shape possible.
LAYERS(0),
– SURFACE ID. the mesh set ID in the database of the
SUBSURFACE
ID(0), NEW
– TRIMMED MESH ID. the mesh set ID where the
SURFACE
trimmed mesh is stored in the database.
ID(0), CUSTOM – CELL LENGTH. The length of a cell edge. ammbatch
MESH ID(0),
uses this value to generate the initial block mesh to be cut.
EOPTION
See CUSTOM MESH ID below.
– FACTOR. Only required if the subsurface is to be
generated (i.e. SUBSURFACE ID is positive and there is
no mesh set with this id in the database). The subsurface is
moved inward from the surface a distance equal to CELL
LENGTH times FACTOR. If FACTOR is zero, no
subsurface is generated.
– LAYERS. The number of cell layers in the extrusion
layer. If this number is not specified or set to zero, the
extrusion cells are not generated.
– SUBSURFACE ID. The mesh set ID in the database of the
subsurface shells to be sent to ammbatch. If this parameter
is positive and there is no mesh set with this id in the
database, the subsurface is generated based on the CELL
LENGTH and FACTOR parameters and stored in the
database. If this parameter is not specified or is zero, no
subsurface is generated or used.
– NEW SURFACE ID. The mesh set ID where the surface
is stored in the database. If this parameter is not specified
or is zero, the surface mesh is not stored. See ID above.
– CUSTOM MESH ID. The mesh set id in the database of
the custom mesh which ammbatch will use to generate the
mesh. If no parameter is specified or if it is zero, the
program generates a block mesh based on CELL
LENGTH and the minimum and maximum coordinates of
the surface.
Version 3.26
20-3
AUTOMESH MODULE
Chapter 20
BAMM,
– Generates the extrusion layer cells.
EXTRUDE,
SURFACE ID,
SUBSURFACE – SUBSURFACE ID. The mesh set ID in the database of the
ID, POLYGON
subsurface shells to be sent to ammbatch. See ID above.
ID,
– POLYGON ID. The mesh set ID in the database of the
EXTRUSION
surface polygons to be sent to ammbatch. See ID above.
ID, LAYERS,
This mesh represents the surface faces of the trimmed
EOPTION
model that you want to extrude from the subsurface to the
surface.
– EXTRUSION ID. The mesh set ID where the extrusion
mesh is stored in the database.
– LAYERS. The number of cell layers in the extrusion
layer.
BAMM,
COLOR.
– Change the colour table to the standard pro-STAR colours.
BAMM, PROC, – RUN. Lists all the currently running ammbatch processes
/RUN/ALL/
started by this particular pro-STAR process. This list is lost
/WAIT/
when you exit pro-STAR.
– ALL. Lists all ammbatch processes started by this particular
pro-STAR process. This includes processes that have
terminated.
– WAIT. If an ammbatch process is running, pause pro-STAR
until it is done.
BAMM,
OTHDEL
– Deletes previously defined ammbatch parameters entered
with the BAMM,OTHER command. This command is used
to reset the list of parameters if you make a mistake.
BAMM,
OTHER,
ammbatch
parameter
– There are times when other parameters need to be passed to
ammbatch when using the BAMM command. This
command allows you to enter those parameters. For
example, to do a classification run using only ammbatch
commands:
bamm,othdel
bamm,other,-classify-sidedness
bamm,cutadjust,2,4,2.25,,,3,,,over
After ammbatch has finished execution, the parameters are
deleted. Note that if ammbatch aborts before it can do
anything useful, the parameters are deleted and must be
re-entered before the next ammbatch run.
Note: This command is available through a PROAM license.
20-4
Version 3.26
Chapter 20
AUTOMESH MODULE
CCUT, TOL, NC1(1), NC2(1), NCINC(1),
/CURS/IDCS/NORM/,,,,,,,OPTION, SPACING: This command cuts a set of
cells in the mesh by using a plane, a cylinder, a sphere, or a cone with specification
of the range concerned. A group of cells are then created to describe the interface
defined by the cutting surface, when the intersection lines define decent surface
regions. Note that these cells are attached with the current active cell type. An easy
way to use this command is to select the shells of interest using the CPLOT and
CSET,NEWS,ZONE commands. The cutting surface is to be specified by using the
cursor on the screen or by providing parameters with an appropriate coordinate id.
Version 3.26
TOL
– Distance within which intersection points are considered to be
coincident and then are merged. If TOL is omitted or set to 0.0
in the command line, then a geometry dependent default value
will be applied automatically.
NC1, NC2,
NCINC
– The set of cells to cut is given by NC1 to NC2 by NCINC.
ALL and CSET may also be used here.
CURS
– This character string in the command line indicates that the
cursor is used to define a cutting plane on the screen. After
entering this command, mouse action is requested to locate
two positions. The cutting operation is applied to cells within
the location range between the two positions located.
20-5
AUTOMESH MODULE
Chapter 20
IDCS,
– This option is to specify a cutting surface by providing
/PLAN/
parameters with an appropriate coordinate id.
/CYLI/SPHE/ – IDCS. The coordinate system ID. Note that IDCS should be
/CONE/X/Y/
given as an integer while CURS and NORM are character
Z/, R, VAL1,
strings.
VAL2, VAL3, – /PLAN/CYLI/SPHE/CONE/X/Y/Z/. The type of the cutting
VAL4
surface (plane, cylinder, sphere, cone, x-plane, y-plane, and
z-plane). Note that PLAN is used only with a Cartesian
coordinate system, CYLI with cylindrical one, and SPHE
with spherical one. The x-plane, y-plane, and z-plane are
related to the local coordinate specified, they are infinite
planes (or cylinders, or spheres) with one value specified.
– R,VAL1,VAL2,VAL3,VAL4. Parameters to define the
surface and cutting range.P
For a plane, R denotes a radius from the origin of
coordinate system IDCS, within which cutting operation is to
be performed. If R is equal to 0.0, then no radius constrain is
applied. The cutting surface is in plane Z=0. Also there are
controls on X and Y ranges in the local coordinate system:
VAL1 and VAL2 are a pair of coordinate limits in X-axis;
VAL3 and VAL4 are that in Y-axis. A general resultant is
subject to the combination of R, VAL1 and VAL2, and VAL3
and VAL4.
For a cylinder, R denotes the characteristic radius which
must be greater than zero. VAL1 and VAL2 are two limits of
angles, and VAL3 and VAL4 are those of local Z coordinates.
For a sphere, R is its radius which must be greater than
zero. VAL1 and VAL2, VAL3 and VAL4 are two pairs of
angle limits.
For a cone, R (phi) is its cone angle with respect to the
Z-axis of the specified local coordinate system. VAL1 and
VAL2 are two limits of angles. If VAL3 and VAL4 are
specified, then the cone is actually a truncated cone, in which
VAL3 and VAL4 are interval limits meaning local Z
coordinates.
Note that the cylinder, sphere and cone are located
according to the pro-STAR’s convention. Valid angle was
defined within [-180, 180], which has been extended to range
[-360, 360].
For x-plane, y-plane, and z-plane, R is the only value to
determine their locations.
NORM, XN, – Character string NORM in the command indicates the cutting
YN, ZN, X,
surface is an infinite plane, which is defined by a normal vector
Y, Z
(XN,YN,ZN) and a point (X,Y,Z).
OPTION
20-6
– This option is to specify whether associated filling is expected
after the cutting procedure is performed. The available choices
are FILL and NOFILL. The default is FILL.
Version 3.26
Chapter 20
AUTOMESH MODULE
SPACING
– Spacing factor used to control the mesh spacing of the new
cells. The default value is 1.0, and the suggested range is [0.5,
2].
Caution: Values other than the default value (1.0) are
associated with a higher risk of being unable to create new
cells or creating a mesh with low quality.
CORIENT, NC1(ALL), NC2, SETOPTION: Re-orients surface shells so that all
the surface normals are outward pointing. This is needed by the CHECK,,,SURF
command so that the overlapping and angle checks work correctly. You MUST
execute this command before using the CHECK,,,SURF command in order the
command to catch all errors.
NC1, NC2
– Operation will be performed only on cells between NC1 and
NC2. Key words ALL or CSET can be used here instead.
SETOPTION – If SETOPTION is set to NEWSET, then the program will form
a new CSET out of all the cells that have problems in the
re-orienting stage.
EZIP, TOL, NC1(1), NC2(NC1), NCINC(1), DELAN, AUTO: When IGES data
is converted into shells using the IGES command, the shells from each surface patch
are topologically disconnected from adjacent patch shells. The EZIP command
makes the mesh topologically continuous, as required by pro-STAR, by finding the
unmatched edges of the selected shells. The mesh is adjusted at these points so that
the shells are topologically continuous. Specify ALL for NC1 if you want to connect
all independent patches. If you want more control over the process, plot the shells
and use the CSET,NEWS,ZONE command to select a set of cells you want to work
on. Then use the CSET option for NC1 to connect the patches. After the command
is executed, the CSET contains all the cells in the modified mesh. A CPLOT will
show you the new mesh. Note that a REPLOT will not work in this case since cells
are added and removed from the CSET in the EZIP process. For a group of shells
with a large number of unmatched edges, repeated use of EZIP command is
suggested.
Version 3.26
20-7
AUTOMESH MODULE
Chapter 20
Sometimes it is desired to fix the locations of some vertices and edges during the
zipping process. For this purpose, point and line cells can be used, which are
included in the cell set under consideration. The zipping process first looks at these
cells, and sets flags to fix their locations. For an edge which is corresponding to a
line cell, the end vertices are fixed, but the edge is possibly to be split.
It should be mentioned that EZIP is a tool attempting to fix gaps, but it is not a
surface checker. Therefore, it will not provide a report on the closeness of the
surface concerned, apart from a progress report on the zipping procedure.
TOL
– Distance within which vertices are considered to be coincident.
If TOL is omitted or set to 0.0 in the command line, then a
geometry dependent default value will be applied
automatically.
NC1, NC2,
NCINC
– The set of cells to zip is given by NC1 to NC2 by NCINC.
ALL and CSET may also be used here.
DELAN
– A minimal angle (in degree) of cells allowed. If a cell is of an
angle less than DELAN, the cell is to be removed. The default
value (about 1 degree) is used when the DELAN value is
omitted in the command line or given as 0.0. If DELAN is
given with a negative value, then this removal procedure is to
be skipped.
Caution: With this option, holes might be left in the resultant
surface mesh due to some vertex collapsing not being
performed. In certain circumstances, vertex collapsing causes
some cells overlapped, that is the reason not to collapse some
vertices, and to leave holes there. If you apply a smaller
DELAN, or run EZIP without specifying DELAN first, the
number of isolated edges is to be smaller, then the next EZIP
run with DELAN has less chance to leave holes there.
AUTO
– If this keyword has been specified, then iteration of EZIP
procedure continues, until no improvement can be made or the
number of iterations reaches to 50.
HELP
or
HFILL, /NVSEED/2VX/VXS/VSET/AUTO/, NC1(1), NC2(1), NCINC(1),
SPACING: This command fills holes in the mesh with shells resulting in a locally
20-8
Version 3.26
Chapter 20
AUTOMESH MODULE
closed continuous surface. It works by finding the unmatched edges of the selected
shells and, starting at the vertex NVSEED, making a loop by following the
unmatched edges until the program gets back to NVSEED. Problems occur when
NVSEED is not on an unmatched edge or when the program either cannot find a
loop back to NVSEED or there are multiple branches. Once the loop is found, a
mesh is constructed which fills the hole thereby making the surface locally closed
and continuous. The newly created vertices are located on a fitting plane. Therefore,
if the vertices of the loop are far from co-planarity, the hole-filling may not be
desirable. Note that the newly created cells are attached with the current active cell
type.
An easy way to use this command is to select the shells of interest using the
CPLOT and CSET,NEWS,ZONE commands and then using “vx” for NVSEED so
you can click the vertex on the screen that you want to be the seed.
More complicated cases occur when more than one regions or multi-connected
regions to be filled are involved. HFILL is designed to enable you to cope with
regions defined by inner and outer loops. In this case, you can pick up two or more
vertices on the loops, by using “2vx” or “vxs”.
NVSEED
– Seed vertex used to find unmatched edge loops.
2VX
– Keyword to allow you to click two vertices on the screen.
VXS
– Keyword to allow you to click a certain number of vertices on
the screen. The edges related to these vertices are treated one
time in terms of the cell creation. Therefore these edges should
be as near as possible to an imaginary plane.
VSET
– Keyword to allow you to use the vertices in the VSET as seeds
to find and close unmatched edge loops.
AUTO
– If this keyword has been specified, then iteration of HFIL
procedure continues, until no hole can be filled or the number
of iterations reaches to 50. In this AUTO mode, the procedure
treats each reasonable closed loop separately for filling.
Therefore, no multi-connected regions (holes) can be dealt
with correctly.
Caution: With this option, the user should specify a whole
complete model. Otherwise, some unexpected filling might be
performed.
NC1, NC2,
NCINC
– The set of cells to fill is given by NC1 to NC2 by NCINC. ALL
and CSET may also be used here.
SPACING
– Spacing factor used to control the mesh spacing of the new
cells. The default value is 1.0, and the suggested range is [0.5,
2].
Caution: Values other than the default value (1.0) are
associated with a higher risk of being unable to create new
cells or creating a mesh with low quality.
Version 3.26
20-9
AUTOMESH MODULE
Chapter 20
SCHECK, NC1(ALL), NC2, OPTION(ALL), ANGLES (15.), ANGLEN (0.5),
QT (0.01), SETOPTION: Checks the selected shells and polygons to detect errors
that ammbatch will find when initially checking the surface and other surface
conditions that can cause problems. The following checks are performed:
OPTION
– FREE. Surface topology check. Finds all surface shell edges
that are defined only once. These edges are said to be free
since they have no matching pair.
– INTERSECT. Second surface integrity check. Checks for
intersection of surface shells.
– MULT. Surface topology check. Finds all surface shell edges
that are defined more than two times. This indicates a branch
in the surface that ammbatch cannot currently handle.
– NEEDLE. Second angle check. Checks if there are shells with
very small internal angles. ANGLEN is the threshold angle
and defaults to 0.5 degrees.
– ORIENT. Surface integrity check. Checks that all the surface
shells' normal are pointed in a consistent direction, namely,
outside the model.
– SHARP. First angle check. Checks for small angles between
adjacent shells against the threshold value ANGLES with
default value 15.0.
– MANI. Checks for non-manifold vertices.
– TWO. Finds all occurrences of cells sharing two or more
edges.
– TRIQ. Triangle quality check. The quality is the area of the
triangle divided by the area of the optimal (equilateral) triangle
that can be built using the same circum-circle (the circle
passing through the three points of the triangle). The quality
range is [0.0, 1.0]. 0.0 means a flat triangle and 1.0 means an
equilateral triangle. QT is the threshold quality and defaults to
0.01.ALL. Does all the above checks in one command.
Many of these tests find the same shells so it would be best to select one test and fix
those problems before going to the next test. This can be done by specifying the
selected test after the SETOPTION. If none is specified, all the tests are performed.
If the NEWSET option is specified, both the CSET and VSET are changed. The
CSET contains the cells found to be incorrect. The VSET contains the vertices of
the edges that were found to be incorrect. Using the CDIS,ON,VERT options allows
you to see both sets of information in one plot.
Note: The shell faces must be oriented correctly for all the surface checks to
work. Make sure that all the surface shells have outward pointing normals or run the
CORIENT command.
20-10
Version 3.26
Chapter 20
AUTOMESH MODULE
SMO3, MAXIT(1), RELAX(0.5), /OPTION,QUALITY(1.0)/
/SMOFAC,VOLFAC,ANGFAC,WPRFAC,CVXFAC,TETFAC/: Smooths the
cells in the current cell set using a minimisation technique. It can be used on any
type of 3D cell in pro-STAR (including trimmed cells). For tetrahedral meshes, the
option TETRA is available which optimise a tetrahedron quality function.
Nodes belonging to couple-matched faces are not optimised and their spatial
position remains unchanged.
MAXIT
– The maximum number of iterations
RELAX(0.5) – The relaxation parameter.
OPTION,QU – If OPTION is TETRA the tetrahedral mesh is optimised
ALITY
according to a tetrahedron quality function. The value of
QUALITY is the target tetrahedron quality for each cell.
SMOFAC
– The weight of smoothness for the mesh. The higher SMOFAC
the smoother the mesh will be.
VOLFAC
– The weight of volume for the mesh. The higher VOLFAC the
more the cells have equal volumes. It also ensures that the
mesh has no negative volume cells.
ANGFAC
– The weight of angles for the cell faces. The higher ANGFAC
the more the cells have equal angles in their faces.
WRPFAC
– The weight of warpage for the cell faces. The higher WRPFAC
the less the cells have warpage in their faces.
CVXFAC
– The weight of convexity for the cells. The higher CVXPFAC
the less the cells have concave spaces.
TETFAC
– The weight of tetrahedral quality for the cells. The higher
TETFAC the better the quality of the tetrahedra in the mesh.
For OPTION=TETRA typical values are:
MAXIT=10
RELAX=0.5
QUALITY=1.0
For general meshes typical values are:
MAXIT=20
RELAX=0.5
SMOFAC=1.0
VOLFAC=2.0
ANGFAC=1.0
WRPFAC=1.0
Version 3.26
20-11
AUTOMESH MODULE
Chapter 20
CVXFAC=10.0#
STATUS: Displays the status of all automatic meshing commands.
20-12
Version 3.26
Chapter 21
RADIATION MODULE
Chapter 21
RADIATION MODULE
HELP
or
STATUS: Displays status of certain variables within this module.
VFCALC, METHODOPT, BATCHOPT, WAITOPT: Calculates view factors
for the new FASTRAC radiation model. Once the user has selected the boundary
regions which participate in the radiation, the command extracts the surfaces from
the model and stores them into a pro*am database.
METHODOPT – VOLUME. Calculates the view factors by creating a surface
using all of the boundary regions applied to the fluid grid
surface.
– SURFACE. Calculates the view factors by using the shell
surfaces currently stored in the model.
BATCHOPT
– INTERACTIVE,DBOUT(50). The view factor command in
run interactively through pro-STAR. ammbatch is run
externally, which will patch the selected domain and store
the results in the database file at index DBOUT. ammbatch
is also used to compute the view factors. During view factor
calculation, check the bamm***.list file for updated
information.
– BATCH. pro-STAR will write the model surfaces and
boundaries into the pro*am database file at fixed index
number (50). ammbatch can then be executed using a shell
script outside of pro-STAR.
WAITOPT
– WAIT. pro-STAR will wait until the patches have been
generated and the view factors have been calculated before
giving control back to the user.
– NO WAIT. pro-STAR will wait only until the patches have
been generated and imported into pro-STAR before giving
control back to the user. The view factor calculation will be
performed while the user has control of pro-STAR.
Version 3.26
21-1
APPENDICES
APPENDICES
STAR-CD VERSION 3.26
CONFIDENTIAL — FOR AUTHORISED USERS ONLY
© 2005 CD-adapco
Appendix A
PRO-STAR CONVENTIONS
Command Input Conventions
Appendix A pro-STAR CONVENTIONS
1. A single command line may not be longer than 320 characters
2. Input is mostly case-insensitive; both capital and small letters are accepted
(arguments such as file names, titles and screen labels are case-sensitive)
3. Command names may be abbreviated by the first four letters (with one
exception: *ENDIF). Argument keywords may also be abbreviated by the
first four letters (with one exception: parameter arguments for the MEMORY
command)
4. Fields in a command string must be separated by a comma or by any number
of spaces.
5. Multiple commands may be stacked on a single line, separated by a dollar
sign ($).
6. Any command string with an exclamation mark (!) in column 1 is interpreted
as a comment (and therefore not executed).
7. Double plus signs (++) at the end of a line indicates that the next line is a
continuation of the current line. Individual arguments are not continued on a
new line; the new line will begin a new argument. Any number of lines may
be continued in this manner to form a single command line; however, the total
number of characters in a command line formed in this manner may still not
exceed 320 characters.
8. Any command may be entered from any module
9. In NOVICE mode (see command EXPERT), the program will prompt for
arguments needed to execute the command. Command ABORT may be used at
this prompt to abort the current command without performing any action.
10. Basic arithmetic is allowed on all command lines. Each operator must be
separated by blanks or a comma from the numbers or parameters on either
side. For example, the following command
VLIST 10 * 10, A + 7 1000 / B
is interpreted as VLIST 100 to (A+7) by (1000/B), where A and B are
numeric parameters defined by the *ASK, *SET or *GET commands. All
terms are evaluated strictly from left to right.
11. The keyword ‘ALL’ may be used in lieu of any vertex, cell, boundary, etc.
range to denote that all items are to be used for the range. (Examples:
CLIST,ALL and CTMOD,ALL,,,FLUID)
12. The appropriate item set keyword may be used in lieu of most item ranges to
denote that all items in the set are to be used for the range. (Examples:
CPDEL,CPSET and VLIS,VSET,,,1)
Version 3.26
A-1
Appendix A
Keyword
Item Set
VSET
Current vertex set
CSET
Current cell set
BSET
Current boundary set
SPLSET
Current spline set
BLKSET
Current block set
CPSET
Current couple set
DSET
Current droplet set
13. The following keywords may be used in lieu of many item ranges to display
the crosshair cursor in the plot window so the user may select a set to be used
as the range. (Example: CLIST,CCRS).
Keyword
Select
VCRS
Vertex set
CCRS
Cell set
BCRS
Boundary set
SCRS
Spline set
BLKCRS
Block set
DCRS
Droplet set
14. The following keywords may be used in lieu of entity numbers. (Example:
V,MXV,1.0,2.0,3.0)
Keyword
Interpreted As
MXV
Highest numbered vertex + 1
MXC
Highest numbered cell + 1
MXB
Highest numbered boundary + 1
MXS
Highest numbered spline + 1
MXK
Highest numbered block + 1
ICUR
Currently active coordinate system
15. Certain keywords (which may also be used in lieu of entity numbers) will
cause pro-STAR to display the crosshair cursor in the plot window and expect
A-2
Version 3.26
Appendix A
Help Text / Prompt Conventions
the user to select an item, as specified by the following description: (Example:
STLIST,SXT)
Keyword
Select
Interpreted As
BLKX
Block
Block number
BX
Boundary
Boundary number
BXP
Boundary
Boundary patch number
BXR
Boundary
Boundary region number
CX
Cell
Cell number
CXC
Cell
Cell colour index
CXG
Cell
Cell group number
CXM
Cell
Cell material number
CXP
Cell
Cell porous number
CXS
Cell
Cell spin index
CXT
Cell
Cell type number
DRX
Droplet
Droplet number
DRXT
Droplet
Droplet type number
SX
Spline
Spline number
SXC
Spline
Spline colour index
SXG
Spline
Spline group number
SXT
Spline
Spline type number
VX
Vertex
Vertex number
Help Text / Prompt Conventions
1. Words between slashes (e.g. /ANY/ALL/) represent legal alternatives for the
field.
2. Numbers in parentheses represent defaults for the immediately preceding
variable.
3. Variables beginning with ‘NV’ refer to vertices
Variables beginning with ‘NC’ refer to cells
Variables beginning with ‘NB’ refer to boundaries
Variables beginning with ‘NSPL’ refer to splines
Variables beginning with ‘NBLK’ refer to blocks
Variables beginning with ‘NCP’ refer to couples
Variables beginning with ‘NDR’ refer to droplets
Version 3.26
A-3
Appendix A
Control and Function Key Conventions
Control and Function Key Conventions
1. The following short-cuts using the Ctrl key are available:
Control Key
Command
Ctrl-a
CSET,ALL
Ctrl-e
ZOOM,OFF $REPLOT
Ctrl-h
Query for help
Ctrl-o
ZOOM,OFF $REPLOT
Ctrl-q
QUIT
Ctrl-r
REPLOT
Ctrl-s
SAVE,,
Ctrl-w
Zoom out (by a factor of 2)
Ctrl-z
Zoom in (by a factor of 2)
2. Function key shortcuts can be defined or changed using the Function Keys
option in the Utility menu. The default function key shortcuts are:
Function Key
Default Command
F5
Repeat last command
F6
REPLOT
F7
CPLOT
F8
ZOOM,OFF $REPLOT
File Name Conventions
The default name for any file read or written by the program is casename.ext,
where casename is defined by the user and ext is the file name extension. If you
enclose the file name in quotes, the extension default will be overridden and the
exact name within the quotes will be used.
A-4
Version 3.26
Appendix B
COMMANDS SUMMARY
Appendix B COMMANDS SUMMARY
Commands preceded by an asterisk are loop or macro commands.
Version 3.26
Command
Description
2D3D
Takes a two-dimensional shell model built in the X-Y
plane and creates a three-dimensional ready model
AAANALYSIS
Turns on/off modelling of the Lilley aeroacoustic
equation sources
*ABBREVIATE
Allows the use of user-defined commands or
abbreviations for a string of one or more pro-STAR
commands
*ABLIST
Lists a user-defined abbreviation
ABSURFACE
Turns the attach boundary surface display off or on
ACCELERATION
Defines components of the gravitational acceleration
on all cells of materials where buoyancy forces are
activated
ACOEFF
Calculates aerodynamic coefficients over the currently
selected set of wall shells
ACROSS
Identifies faces to use for area calculations using the
cursor
ALGORITHM
Sets the numerical solution algorithm
AMODEL
Specifies the atomisation model
ANGLE
Rotates the plot on the screen without changing the
view
ANIMATE
Goes to the ANIMATION module
ANORM
Sets the switch for residual normalisation
ANSYS
Reads or writes nodes and elements using the
ANSYS(1), PREP7, EWRITE and NWRITE command
format into/from pro-STAR data
AOPTION
Sets the animation parameters
AREA
Calculates the surface area within a polygon defined by
vertices or the area of one or more boundaries,
boundary regions or boundary patches
ARROW
Changes the default representation of vector arrows
*ASK
Prompts the user to enter the numerical value and
increment for a numeric parameter
AXISUP
Sets the default up axis direction for plots
B-1
Appendix B
B-2
COMMANDS SUMMARY
AZONE
Automatically identifies every face within a
user-defined zone on the preceding plot to use for area
calculations
BAMM
Generates a trimmed mesh
BARLIST
Lists the different bar types available for graphs
BARTYPE
Defines the bar type to be used for plotting graph
registers in bar graphs
BATCH
Switches pro-STAR between background and
interactive mode
BC
Defines a pair of boundaries or regions that together
form a coupled pair
BCCOMPRESS
Compresses undefined or deleted boundary/region
couple numbers out of the model
BCDELETE
Deletes a set of boundary/region couple definitions
BCGROUP
Groups region couples together
BCHECK
Checks all user-defined boundaries
BCLIST
Lists boundary/region couple definitions and groups if
present
BCMATCH
Matches boundaries on two faces by comparing the
boundary centroids in the global coordinate system and
appends to the boundary couple list
BCOMPRESS
Compresses all deleted boundary definitions out of the
model
BCOPTION
Specifies the boundary coupling option used to join
blocks of cells that exist in different rotating frames of
reference
BCROSS
Uses the cursor device to pick out cell faces on which
the boundary conditions of a given region will be
placed or deleted
BDEFINE
Defines a boundary for a cell face
BDELETE
Deletes a range of boundaries
BDISPLAY
Adds a representation of user-defined boundary
conditions to the plot
BDX
Defines boundaries and patches using the cursor to pick
vertices
BFIND
Defines boundaries on the current plot by finding all
surface cell faces attached to one vertex and proceeding
in waves outwards from this initial start
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
BGENERATE
Generates a new set of boundaries by applying an offset
to the vertices of a previously defined set
BLIST
Lists a range of boundaries
BLK
Defines the corner vertices for a mesh block
BLKCELL
Defines blocks from existing cell definitions
BLKDELETE
Deletes definitions for mesh blocks
BLKEXECUTE
Creates the vertices and cells associated with a range of
mesh blocks
BLKFACTORS
Defines the pertinent fill factors for a given mesh block
BLKGENERATE
Creates a new set of mesh block definitions by applying
an offset to the vertices of a predefined set
BLKLIST
Lists definitions for mesh blocks
BLKMODIFY
Modifies any of the vertex definitions for a predefined
mesh block
BLKPLOT
Makes a plot of mesh blocks in accordance with the
user-defined block set and any other pertinent
parameters
BLKSET
Builds a block set
BLKTRACE
Traces block factors defined along an edge of one block
throughout the current block set
BLKWALL
Assigns shell cell IDs to block faces for mapping
BMERGE
Searches boundary list for duplicate boundary
definitions and deletes the lower-numbered definitions
(saves the most recent)
BMODIFY
Modifies the region number, vertices or patch number
of one or more boundaries
BOUNDARY
Goes to BOUNDARY module
BPATCH
Assigns radiation patches to boundaries based on
region number and/or boundary set
BPCOMPRESS
Compresses patch numbers that do not belong to any
boundary out of the model
BREAD
Reads boundaries from a file
BRMONITOR
Turns on requests for STAR to write out a file
containing specific monitoring information on a
boundary region by region basis
BSET
Builds a boundary set
BSHELL
Creates boundaries by converting all shell cells in the
given range
B-3
Appendix B
B-4
COMMANDS SUMMARY
BUOYANCY
Switches buoyancy forces on/off for the current fluid
material
BWRITE
Writes a group of boundary definitions to file LF
BZONE
Creates boundaries on cell faces, or modifies or deletes
boundaries, within a user-drawn zone
C
Defines a single cell of the same type as the currently
active cell type
CADHIDDEN
Modifies hidden parameters for the IGES/VDA
conversion
CADSET
Sets parameters used by the IGES and VDA commands
to interpret an IGES or VDA data file
CADTRANSLATE
Sets geometrical parameters used by the IGES and
VDA commands to translate an IGES or VDA data file
*CALC
Calculates a numeric parameter as a function of a
variable
CASENAME
Changes the default casename for files
CAVERAGE
Produces a set of vertex data by computing an inverse
distance weighted average of all the centroidal post
data variables of the cells connected to each respective
vertex
CAVITATION
Deactivates/activates the cavitation using different
modelling options
CAVNUCLEI
Defines properties for modelling the formation of
nuclei during cavitation
CAVPROPERTY
Defines properties of the cavitation model
CBEXTRUDE
Extrudes baffles and shells into solid cells
CCOMPRESS
Compresses deleted cells out of a model
CCROSS
Identifies cells using the cursor device to pick out a cell
face
CCUT
This command cuts a set of cells in the mesh by using a
plane, a cylinder, a sphere, or a cone with specification
of the range concerned
CDCHEM
Writes out details of chemical reaction schemes in
coded form
CDELETE
Deletes a set of cells
CDIRECTION
Specifies I,J,K directions to reorder vertices or
subdivide cells
CDISPLAY
Enables the user to overlay other plot types over a cell
plot
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
CDIVIDE
Subdivides all hexahedral cells in the current cell set if
they correspond to a structured mesh and a predefined
I,J,K direction specified by the CDIRECTION
command
CDSAVE
Saves all model data in coded format
CDSCALAR
Writes details of scalars in coded form
CDTRANS
Saves all transient load data in coded format
CDX
Defines cells using the cursor to pick vertices
CENTER
Defines the plot centre
CFIND
Finds cells on the current plot by finding all surface cell
faces attached to one vertex and proceeding in waves
outward from this initial start
CFIX
Fixes or transforms cell definitions for range or set of
cells
CFLIP
Flips the definition of a range or set of cells by
interchanging vertices
CGENERATE
Generates a new set of cells by applying an offset to the
vertices of a predefined set
CGGCELL
Retrieves cell centred post-processing data from files
that are compliant with the CFD General Notation
System (CGNS) specification and stores them in
memory for printing, plotting, and other manipulation
CGGVERTEX
Retrieves vertex centred post-processing data from files
that are compliant with the CFD General Notation
System (CGNS) specification and stores them in
memory for printing, plotting, and other manipulation
CGNS
Reads grid data and writes grid and post data in CGNS
format
CGSTATS
Lists the contents of the specified CGNS file
CHANGE
Changes the values of all currently stored post data
items by the formula NEW VALUE = A * OLD
VALUE + B
CHECK
Provides several different checks on the model
geometry
CHEMICAL
Goes to the CHEMICAL reactions module
CHEREACTION
Turns chemical reaction calculations on or off
CHMSOLVER
Defines the numerical method to be used for solving
the transport equations for a complex chemistry model
B-5
Appendix B
B-6
COMMANDS SUMMARY
CHSCHEME
Applies a chemical reaction scheme to a specified fluid
material
CICDEFINE
Defines up to 20 regions making up a coupling
interface
CICOMPRESS
Compresses coupling interfaces
CIDELETE
Deletes coupling interfaces
CILIST
Lists coupling interfaces
CIMM
Specifies internal vertex displacement in relation to
boundary movement
CINITIALIZE
Provides parameters for the steady state initialisation
procedures of STAR-CD before starting iterative
calculations
CITAG
Optionally tags an existing coupling interface (only
useful for multiple coupling interfaces)
CJOIN
Joins two cells together and propagates this in a
structured mesh
CKBREGION
Turns STAR/KINetics surface chemistry on or off for a
boundary region
CKCTABLE
Turns STAR/KINetics surface chemistry on or off for a
cell table
CKELEMENT
Defines chemical elements for a complex chemistry
model
CKFO
Defines forward reaction species concentration
exponents for a complex chemistry model reaction
CKGOPTION
Sets STAR/KINetics gas-phase chemistry options
CKIN
Activates or deactivates STAR/KINetics modelling
CKLIST
Lists the complex chemistry information for a given
chemical reaction scheme
CKMAT
Turns STAR/KINetics modelling on or off for a
specific material
CKPOST
Sets STAR/KINetics-related items to be output to the
transient post (.pstt) file
CKPREP
Sets STAR/KINetics modelling options and writes
STAR/KINetics files
CKREACTION
Defines chemical reactions for a complex chemistry
model
CKRO
Defines backward reaction species concentration
exponents for a complex chemistry model reaction
Version 3.26
Appendix B
COMMANDS SUMMARY
CKSFRACTION
Sets STAR/KINetics site and bulk species fractions
CKSOPTION
Sets STAR/KINetics surface chemistry options
CKSPECIES
Defines chemical species for a complex chemistry
model
CKTHIRD
Defines third-body reaction enhancement factors for a
complex chemistry model reaction
*CLEAR
Clears all numeric and/or string parameters
CLEAR
Clears the graphics screen
CLIST
Lists a range of cells
CLOCAL
Defines a local coordinate system using coordinates in
the currently active coordinate system
CLOSE
Closes a previously used file
CLRFILL
Fills colour values between two colour indices
CLRLIST
Lists the currently-defined colour map entries
CLRMODE
Reverses the standard background/foreground colour
combination used for successive (colour) terminal plots
CLRPENS
Sets the number of colour pens for plotting
CLRTABLE
Allows users to supply their own table of RGB values
for pre- or post-processing plots
CLRWALL
Removes all the wall shells created upon first use of the
GETWALL command, setting the model back to its
initial state
CMODIFY
Modifies the type or vertices of a cell or cells
CMREFINE
Refines cells of any type in three dimensions or
extruded type cells (prisms, hexahedrons, trimmed cell
type 2 and trimmed cell type 8) in one or two
dimensions using midpoint subdivision, creating new
couples, boundaries and restart data as needed
CMROPTION
Sets refine options for the CMREFINE command
CMUNREFINE
Un-refines a mesh refined via CMREFINE, updating
and/or restoring couples, boundaries and restart data as
needed
COALMODEL
Activates/deactivates coal combustion modelling
CODB
Version 3.26
COEBREAKUP
Defines extended eddy breakup model coal combustion
parameters
COGLOBAL
Defines global coal combustion model
B-7
Appendix B
B-8
COMMANDS SUMMARY
COKE
Defines the constants used in formulating various
turbulence models
COLES
Defines the coefficients used in Large Eddy Simulation
(LES) turbulence models
COMCHECK
Checks the reaction mechanism of a complex chemistry
model for the current reaction scheme
COMISC
Defines miscellaneous parameters for the coal
combustion model
COMSET
Sets up the reaction mechanism of a complex chemistry
model for the current reaction scheme
CONDUCTIVITY
Sets the value of thermal conductivity for the current
material
CONJUGATEHEAT
Turns on or off the capability within STAR to perform
a conjugate heat transfer analysis
CONL
Defines the constants used in the non-linear terms of
various turbulence models.
CONTROL
Goes to CONTROL module
CONVERT
Goes to CONVERT module
COPANALYSIS
Defines the mass fractions for the proximate analysis of
coal
CORIENT
Re-orients surface shells so that all the surface normals
are outward pointing
COSCHAR
Defines the model constants for the char burnout
models
COSTATUS
Displays the coal combustion modelling status
COSUBMODEL
Defines the coal combustion sub-models
COSVOLATILE
Defines the model constants for the various coal
devolatilisation models
COUANALYSIS
Defines the mass fractions for the ultimate analysis of
coal
COUNT
Provides a summary count of the current numbers of
blocks, boundaries, cells, couples, splines and/or
vertices
CP
Defines or adds cells to a couple
CPCELL
Prints a list of all couples attached to each cell in the
given range
CPCHECK
Performs a set of checks on the given range of couples
to help determine their validity
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
CPCOMPRESS
Compresses deleted couples out of the list
CPCREATE
Creates couples by finding matches based upon a
selection option
CPDELETE
Deletes a range of couples
CPDISPLAY
Adds a representation of couples to cell faces on the
plot
CPFACE
Defines a couple using cell numbers and face numbers
CPFLAG
Sets flag that allows/disallows fluid and solid cells in
the same couple
CPFREEZE
Freezes the location of vertices attached to the slave
faces of couples (CP command) with respect to the
vertices of the appropriate master face
CPGENERATE
Generates additional couples by offsetting previously
defined couples
CPLIST
Lists couple definitions
CPLOT
Makes a plot of cells in accordance with the
user-defined cell set and any other pertinent parameters
CPMERGE
Finds and merges couples with identical master cell
faces and removes duplicate couples
CPMODIFY
Modifies a couple definition
CPOST
Defines which cell data items are to be written to the
transient post file
CPRANGE
Defines the range of cells for which data selected with
the CPRINT command will be printed
CPREAD
Reads couples from a file
CPRINT
Defines which cell data items are to be printed
CPSET
Builds a couple set
CPTABLE
Defines a couple table entry
CPTDELETE
Deletes couple table entry definitions
CPTLIST
Lists couple table entry definitions
CPTMODIFY
Modifies couple table entry definitions
CPTNAME
Defines an alphanumeric identifier for a CPTABLE
entry
CPTOLERANCE
Sets global tolerance values used in the creation and
checking of couples
CPTYPE
Changes the currently active couple type ID
B-9
Appendix B
B-10
COMMANDS SUMMARY
CPUTIME
Turns on and off CPU time reporting in STAR at the
end of each iteration
CPWRITE
Writes a range of couples to a file
CRDELETE
Deletes a chemical reaction scheme
CREAD
Reads in a set of cell connectivity data from a file
CREFINE
Refines all cells in the specified range by NDIVI,
NDIVJ, NDIVK in the cell I, J, K directions
respectively
CREORDER
Reorders the cell list in the given range by sorting their
centroidal coordinates in the specified local coordinate
system and direction
CRLIST
Lists the chemical reaction schemes defined
CRMODEL
Defines the chemical reaction scheme
CRPRODUCTS
Defines the products in the current chemical reaction
scheme
CRREACTANT
Defines a reactant to be used in the current chemical
reaction scheme
CRSCALAR
Lists, defines or stoichiometrically checks the
thermo-chemical properties of the scalars that describe
the chemical reaction scheme
CRSE
Generates a coarser mesh from the cells in the CSET
CRTYPE
Changes the currently active chemical reaction scheme
number
CRUNDELETE
Undeletes a previously deleted chemical reaction
scheme
CSAM
Defines a single trimmed cell of the same type as the
currently active cell type
CSCALE
Defines the colour scale used for VECTOR or
CONTOUR post-processing plots
CSDELETE
Deletes user-defined coordinate systems ICSYS1 to
ICSYS2 by ICSINC
CSDIR
Changes the calculation of angles in local
non-Cartesian coordinate systems from –180/+180 to
0/360 degrees or vice versa
CSET
Builds a cell set
CSHELL
Associates shells (and baffles) with adjacent fluid cells
CSLIST
Lists attributes of predefined local coordinate systems
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
CSMONITOR
Turns on requests for STAR to write out a file
containing specific monitoring information on a cell set
by cell set basis
CSPLINE
Defines line cells at splines
CSYS
Sets the currently active coordinate system
CTABLE
Defines a cell table entry
CTCOMPRESS
Compresses undefined/deleted cell table numbers out
of the model
CTDELETE
Deletes cell table entry definitions
CTLIST
Lists cell table entry definitions
CTMODIFY
Modifies cell table properties
CTNAME
Defines an alphanumeric identifier for a CTABLE
entry
CTRIM
Defines a single trimmed cell of the same type as the
currently active cell type
CTYPE
Changes the currently active cell table number
CUNDELETE
Undeletes a set of cells
CURSORMODE
Allows the user to read cursor picks from the input file
instead of displaying the crosshair and using the screen
CVERTEX
Prints a list of all cells attached to each vertex in the
given range
CVREFLECT
Generates a set of cells by reflecting the corresponding
vertices about a local coordinate system
CWRITE
Writes a set of cell connectivity data to a file
CYARBITRARY
Matches cyclic boundaries on two faces by checking
for overlap in the local coordinate system of the region
definitions and creates the appropriate cyclic set list
CYCHECK
Performs a set of checks on the given range of arbitrary
cyclic sets to help determine their validity
CYCLIC
Defines a cyclic set of boundaries
CYCOMPRESS
Compresses deleted cyclic sets out of the list
CYDELETE
Deletes previously defined cyclic sets
CYGENERATE
Generates additional cyclic sets by offsetting a
previously defined starting set
CYLIST
Lists cyclic set definitions
B-11
Appendix B
B-12
COMMANDS SUMMARY
CYMATCH
Matches cyclic boundaries on two faces by comparing
the boundary centroids in the local coordinate system
of the region definitions and creates the appropriate
cyclic set list
CZONE
Modifies, deletes, or places a shell or baffle on cells
within a user-defined zone on the plot
DAGE
Evaluates the age of all currently loaded droplets based
on information from the droplet track file
DBASE
Stores and retrieves mesh sets
DCOLLISION
Activates/deactivates the O'Rourke droplet collision
model for transient cases and applies advanced options
if required
DCONDENSATION
Switches droplet condensation calculations on or off
*DEFINE
Begins the definition of a loop
DELTIME
Defines the time step (DT) calculation method in the
time units specified by command TRELATION
DENSITY
Sets various options for the calculation of density by
STAR for the current material
DGENERATE
Takes the loaded set of cell or vertex post data and
generates a new set for which the cell (or vertex)
numbers are incremented by NOFF, while the actual
values are the same as the original set
DIFCORRECTION
Determines whether the diffusion velocity correction is
activated for the current material
DIFFUSIVITY
Defines the method of calculating mass diffusivity in
the mixture
DILUTANT
Defines dilutant numbers and dilutant names for a
given chemical reaction scheme
DINLIST
Lists the initial conditions for a set of droplet parcels
DINTERPOLATION
Defines an interpolation method used to evaluate the
continuous-phase temperature, velocity and species
mass fraction at droplet locations
DIRECTION
Sets program to either read or write files for the
ANSYS, PATRAN, NASTRAN, IDEAS and CGNS
commands
DISTANCE
Changes the distance (and scale) of the plot
DLIST
Lists information about a range of droplets
DMAX
Sets the maximum number of droplet parcels
DOPTION
Selects the plot options for droplet plots
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
DPLOT
Makes a plot of droplets in accordance with the
user-defined droplet set and any other pertinent
parameters
DRAVERAGE
Sets a flag to calculate and pass droplet average
properties to the user through the user routine
dravrg.f at the end of each sub-cycle
DRBOIL
Activates/deactivates the droplet boiling model
DRBREAKUP
Activates the droplet breakup model and defines the
constants of the bag and stripping breakup models
DRCLIST
Lists droplet component properties for a particular
droplet type
DRCMPONENT
Specifies the number of components for a droplet type
and defines their physical properties
DRCOMPRESS
Compresses out unused or deleted droplet parcels
DRCREATE
Creates and manipulates sets of parcel initial positions
(injection points) using vertices previously defined
with other commands
DRDIAMETER
Specifies the method of calculating droplet diameters
DREAD
Reads droplet parcel data in from a coded file
DRFORCE
Applies body forces (such as gravity) to droplets
DRGENERATE
Generates additional sets of droplets with new initial
conditions from a given starting set
DRGROUP
Selects a parcel injection group IGROUP whose
properties and behaviour can be defined or modified
using appropriate commands
DRHEAT
Activates/deactivates heat transfer between the
dispersed and continuous phase
DRINITIAL
Defines parcel injection conditions
DRMASS
Activates/deactivates mass transfer between the
dispersed and continuous phase
DRMOMENTUM
Activates or deactivates momentum transfer between
the dispersed and continuous phases
DRNPROCEDURE
Defines a numerical procedure for the two-phase
Lagrangian calculation
DROPLETS
Goes to the DROPLETS module
DRPMODE
Determines the method of specifying parcel initial
conditions in Lagrangian two-phase flow calculations
DRPOST
Defines droplet post file characteristics
B-13
Appendix B
B-14
COMMANDS SUMMARY
DRPROPERTIES
Defines droplet physical properties for the active
droplet type and the given PROPOPT
DRSCALE
Scales the initial position for a range of droplet
definitions
DRSDUPLICATE
Copies set definition ISET1 of IGROUP1 to ISET2 of
IGROUP2
DRTDELETE
Deletes a previously defined droplet type
DRTURBULENCE
Activates/deactivates the turbulent dispersion models
DRTYPE
Selects a droplet type IDTY whose properties and
behaviour can be defined or modified using appropriate
commands
DRUSER
Activates user coding for parcel injection
DRWALL
Defines droplet behaviour following a collision with an
obstacle (wall, fluid-solid or fluid-porous medium
interface)
DSCHEME
Sets the differencing scheme used for each field
variable and, for higher order differencing, a blending
factor to use with first order upwind differencing
DSET
Builds a droplet set
DSTATUS
Displays the current droplet plot options in effect
DTIME
Selects the time range for droplet track plots
DTYLIST
Lists a set of droplet type definitions
DWRITE
Writes droplet data to file LF
EACELL
Activates cells for the current event
EACOMPRESS
Compresses deleted attached sets out of the list
EADELETE
Deletes previously defined attached boundary sets
EAGENERATE
Generates additional attached sets by offsetting a
previously defined starting set
EALIST
Lists attached boundary set definitions
EAMATCH
Matches boundaries on two faces by comparing the
boundary centroids in a local coordinate system and
creates the appropriate attached set list
EASI
Includes sliding sets specified in a sliding event to the
current event
EATTACH
Defines an attached pair of boundaries
EBODY
Defines components of a body force for a dispersed
phase and material
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
ECHOINPUT
Forces all input data to be echoed to the current output
file whether that is the screen or a disk file
ECLIST
Lists deactivated, activated, change fluid type,
excluded or included cells
ECNDUCTIVITY
Sets the dispersed PHASE thermal conductivity in
material IMAT
ECONDITIONAL
Adds conditions specified in a conditional event to the
current event
ECOPTION
Defines solution control options for Eulerian
multiphase
ECPOST
Defines the list of dispersed phase cell data to be
written to the transient post file every NPOF time steps
during the load step
ECPRINT
Defines the list of dispersed phase cell data items to be
printed every NPRF time steps during the load step
ECSMONITOR
Turns on requests for STAR to write out dispersed
PHASE data to a file containing specific monitoring
information on a cell-set by cell-set basis
EDATA
Allows input of various undocumented extended data
text
EDCELL
Deactivates cells for the current event in the currently
active direction specified by the EDDIR command
EDCOMPRESS
Compresses deleted detached sets out of the list
EDDELETE
Deletes previously defined detached boundary sets
EDDIR
Specifies the direction for deactivating cells
EDENSITY
Sets the dispersed PHASE density calculation option
for material IMAT
EDETACH
Defines detached boundaries
EDGE
Turns on or off the plotting of edges only
EDGRAPH
Defines a frame of STAR engineering monitoring data
EDISCHEME
Sets the differencing scheme used for PHASE variables
and, for higher order differencing, a blending factor to
use with first order upwind differencing
EDLIST
Lists detached boundary set definitions
EDLOAD
Loads STAR engineering monitoring data into a graph
register
EDSCAN
Scans an engineering cell set or region data file (*.ecd
or *.erd) for information concerning the data
B-15
Appendix B
B-16
COMMANDS SUMMARY
EDRAG
Defines the method of calculating the drag coefficient
or drag force for a PHASE in material IMAT
EECELL
Excludes specified cells for the current event set up
EEDGRAPH
Graphs STAR engineering monitoring data for a
dispersed PHASE in an Eulerian multiphase calculation
EEDLOAD
Loads STAR engineering monitoring data for dispersed
PHASE into a graph register
EFLUID
Changes the fluid stream of an event
EGEBOUNDARY
Defines the Eulerian multiphase boundary data which
the user wishes to store in memory for printing,
plotting, and other manipulation
EGECELL
Defines the Eulerian multiphase cell data which the
user wishes to store in memory for printing, plotting,
and other manipulation
EGEVERTEX
Defines the Eulerian multiphase vertex data which the
user wishes to store in memory for printing, plotting,
and other manipulation
EGRID
Defines grid change pro-STAR commands for moving
mesh problems
EGSTAR
Gets STAR residuals (or rates of change) and
monitored values from a direct access file for a
dispersed Eulerian PHASE in material IMAT
EGTRANS
Gets STAR transient values for an Eulerian dispersed
PHASE
EHTRANSFER
Defines the Nusselt number for calculating the heat
transfer coefficient between a dispersed PHASE and
the continuous phase
EICELL
Includes specified cells for the current event set up
EICOND
Sets up conditions associated with included cells
EINITIAL
Defines dispersed PHASE initial conditions for a
material IMAT
EINTNAL
Defines a dispersed PHASE internal force, such as
solid particle stress, for a given material IMAT
*ELSE
Used in a loop in conjunction with the *IF/*ENDIF
to define logical tests
ELVISCOSITY
Sets the dispersed PHASE molecular viscosity for
material IMAT
EMOLWT
Sets the value of the molecular weight of dispersed
PHASE in material IMAT
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
EMOMENTUM
Defines the interphase momentum transfer processes
other than drag force for a PHASE in material IMAT
EMPHASE
Activates/deactivates a multi-fluid model containing
NPHASE phases for a given material stream IMAT
EMSLIDE
Defines the master list of boundaries for the sliding
interface
*END
Ends a loop definition
*ENDIF
Ends an *IF/*ENDIF block of commands in a loop
ENSIGHT
Reads geometry data or writes out geometry and/or
post data in a form which can be read by the Ensight
post-processing visualization program
EOSLIDE
Supplies the offsets needed to match the two sliding
regions
EPCP
Defines a polynomial function to describe specific heat,
enthalpy and entropy for dispersed PHASE in material
IMAT
EPHASE
Switches between phases
EPLIST
Lists stored data names in the currently loaded post file
for a dispersed PHASE
EPLV
Defines a polynomial function to describe the
molecular viscosity of dispersed PHASE in material
IMAT
EPOK
Defines a polynomial function to describe the dispersed
PHASE thermal conductivity in material IMAT
EPSLIDE
Enables (or disables) the arbitrary sliding interface
partial boundary capability for a sliding event
ERANGE
Sets program to read/write elements within a specified
range
ERDEFINE
Defines the characteristics of a boundary region for a
dispersed PHASE
ERELAX
Sets the value of the relaxation factors used in solving
for each of the respective variables
ERESID
Sets the values of the residual error tolerances used for
judging convergence of the dispersed PHASE volume
fraction
ERLIST
Lists the definition of each boundary region for a
dispersed PHASE
ERMODIFY
Modifies the characteristics of an already defined
boundary region for a dispersed PHASE
B-17
Appendix B
B-18
COMMANDS SUMMARY
ERRESTIMATE
Sets the STAR error estimating flags
ERTPRESSURE
Sets temperature and volume fraction options for
pressure boundary regions in the dispersed phase
ESIZE
Defines the particle diameter of a dispersed PHASE in
material IMAT
ESOLVE
Controls the variables that are solved or calculated for
the dispersed PHASE in Eulerian multiphase
simulation
ESPECIFICHEAT
Sets the dispersed PHASE specific heat for a given
material IMAT
ESSLIDE
Defines the slave list of boundaries for the sliding
interface
ESWEEP
Sets the values of the number of sweeps used in solving
the dispersed phase volume fraction equation
ETEMPERATURE
Sets dispersed PHASE enthalpy equation options
ETURB
Defines Eulerian multiphase turbulence model options
EVCHECK
Sets the option for checking events
EVCND
Defines a conditional event
EVCOMPRESS
Compresses out deleted events
EVDELETE
Deletes event definitions from the events file
EVENTS
Goes to the EVENTS module
EVEXECUTE
Executes events
EVFILE
Initialises an events data file, re-connects to a
previously defined file or closes an events file
EVFLAG
Sets various event checking flags for commands that
involve loading and executing events
EVGET
Gets an event from the events file for modification
EVLIST
Lists characteristics of events
EVLOAD
Loads event information up to the time specified by the
option
EVOFFSET
Applies offsets to the time value definitions in the
events data file
EVPARM
Defines global parameters to be used in determining the
times of occurrence of the events
EVPREP
Checks the events in time sequence and prepares a
valid events data file
EVREAD
Reads coded events data from a file
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
EVSAVE
Saves currently defined event in the events data file
EVSLIDE
Defines a sliding event
EVSTEP
Defines an actual event
EVUNDELETE
Undeletes a previously deleted event definition in the
events file
EVWRITE
Writes coded events data to a file
EXIT
Returns to the PRO module
EXPERT
Turns the interactive expert mode on or off
EZIP
When IGES data is converted into shells using the
IGES command, the shells from each surface patch are
topologically disconnected from adjacent patch shells
FLCO
Defines or modifies the fuel/oxidiser/product
composition and/or chemical valence in a flamelet
calculation
FLCP
Copies file flame'IOR'.inp'ICSC' to file
flame'IDE'.inp'ICSC'
FLDELETE
Deletes a line containing keyword CHAR in the
flamelet input file
FLGENERATE
Generates a flamelet input file with default contents
FLIST
Lists the vertices on a cell face
FLKV
Defines control parameters for flamelet calculations
FLPLOT
Plots the instantaneous values of temperature, density,
specific heat and mass fractions as functions of the
mixture fraction for the current flamelet
FLR1
Performs a flamelet chemistry calculation for a given
FLR2
Generates a laminar flamelet library for a given
chemical reaction scheme and flamelet number
FLUXSUM
Finds the cumulative mass flux crossing a user defined
set of cell faces
FRAME
Defines the characteristics of a frame, one by one
FRDEFINE
Defines all characteristics of a frame
FSDSCHEME
Defines the differencing scheme for solving the VOF
transport equation
FSMASSTR
Activates/deactivates the mass transfer computation in
free surface flows
FSSUBCYCLE
Sets the free surface subcycling
B-19
Appendix B
B-20
COMMANDS SUMMARY
FSTAT
Prints summaries of data sets stored on surface
(SRFWRITE) and set (SETWRITE) files
FSURFACE
Activates/deactivates free surface modelling
FSVOF
Sets values for free surface VOF solution
FUEL
Sets the fuel type present in droplets of the active
droplet type (single-component droplets), or sets the
NOPTth droplet component to the specified fuel type
(multi-component droplets)
FV
Writes geometry and post data in a form which can be
read by the Fieldview post-processing visualisation
program
FWRITE
Writes the cell face definitions to a file
GAMBIT
Reads in geometry data from the Gambit
pre-processing package
GDATA
Reads data values into a graph register from an external
file
GDRAW
Draws the graph
GENERIC
Allows the user to write out any generic command that
will be repeated for every vertex, cell or boundary in
the current set
GEOMWRITE
Writes the geometry file used by the analysis section of
STAR
*GET
Gets the value of a given item and stores it in a numeric
or string parameter
GETBOUNDARY
Defines which post-processing items the user wishes to
store in memory for printing, plotting and/or
manipulation
GETCELL
store in memory for printing, plotting and other
manipulation
GETDROPLET
Loads droplet data for plotting
GETUSERDATA
Reads a file of vertex or cell data into the post registers
GETVERTEX
store in memory for printing, plotting and other
manipulation
GETWALL
Defines which wall data items the user wishes to store
in memory for printing, plotting and/or manipulation
GFILL
Fills a graph register with values
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
GFTB
Generates a look-up table for a given chemical reaction
scheme
GINPUT
Prompts for input of values into a graph register
GLOAD
Loads cell or vertex numbers into a graph register
GMAP
Maps values from graph registers to post registers for
cells or vertices
GMARK
Marks a graph frame with a line, symbol or bar
*GOTO
Used to jump to a given location within a loop
GPAN
Allows the user to change the centre of a graph using
either screen coordinates or the cursor to define the new
centre
GPARAM
Stores the current parameter value in a graph register
GPICK
Gets the value of a picked point on the screen
GPOST
Defines sensors and loads geometry and post data at the
sensors into the graph registers
GPTLOAD
Loads data for a particular particle/droplet from a track
file into graph registers
GPUT
Puts a pair of x-y values into graph registers
GR3D
Reads (only; cannot write in this format) GRID3D
formatted files of vertices and implied cell definitions
GRAPH
Goes to the GRAPH module
GRAY
Plots a greyscale pattern
GRDISPLAY
Allows the user to turn several graph display options
off or on for a particular frame
GREDRAW
Redraws the last graph
GRESET
Clears all graph registers and resets all graphical
variables and logicals to default values
GRLABEL
Allows the user to add up to 20 different labels to a
particular frame of the graph plot using screen
coordinates or the cursor device to define the label
starting locations
GSPLIT
Splits the screen into locations for the multiple frames
GSTAR
Gets STAR residuals (or rates of change) and
monitored values from a direct access file for a
particular fluid or solid type and sets up graph frames
based on these values
GTPOWER
Sets GTPOWER solver status
GTRANS
Gets STAR transient values from a file
B-21
Appendix B
B-22
COMMANDS SUMMARY
GVALUE
Puts geometry data or the currently stored post data
values (contained in POST registers 1-6) into a graph
register
GZOOM
Allows the user to zoom in on a portion of the graph
plot using either screen coordinates or the cursor device
to define the region
HCOEFF
Tells the program whether or not user subroutines are
available to calculate heat or mass transfer (film)
coefficients
HEADING
Changes the heading and units labels on a post plot
HELP
Displays the command set for each module or displays
more detailed information about a specific command
within each module
HFILL
Fills holes in the mesh with shells resulting in a locally
closed continuous surface
HISTORY
Lists previously issued commands
HRCO
Activates or deactivates the heat of reaction option for a
HRSDUMP
Performs a high-resolution screen dump of the
extended mode plotting window
ICEM
Writes geometry and post data out in the ICEM domain
format
IDEAS
IDEAS(4) Universal data file format into/from
pro-STAR data
*IF
Executes all the commands between ‘*IF’ and
‘*ENDIF’ in a loop only if the value of TEST is true
IFILE
Sets the location from where the program input is read
IGES
Reads IGES data from file LF and translates them into
pro-STAR entities
IGN2
Defines the ignition parameters for the second ignition
sequence for the current chemical reaction scheme
IGNITION
Defines the ignition parameters for the current
IGNMODEL
Defines the ignition model characteristics
IGNORE
Allows the user to selectively ignore (not convert) one
or more IGES or VDA entity types
INISCALAR
Defines scalar initial conditions that are used during the
first iteration before any field results are available
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
INITIAL
Defines material initial conditions that are used during
the first iteration before any field results are available
INJECTOR
Specifies the injector parameters
INJLIST
Lists attributes of defined injectors
INTEGRATE
Integrates the currently selected (cell) post data items
on the plane defined by the SPOINT and SNORMAL
commands and prints the results to the screen
ITER
Defines the number of iterations through the STAR
solvers
KNOCK
Activates/deactivates the knock model for a given
LAYER
Takes the objects rendered to the screen in extended
mode pro-glm and stores them to a layer
LESOUT
Provides time-averaged values of velocities, pressure,
and subgrid turbulent viscosity
LFBOIL
Switches the film boiling off or on
LFCMPONENT
Specifies the number of components for a liquid film
type and defines their physical properties
LFCONDENSATION
Switches liquid film condensation calculations on or
off
LFFORCE
Applies gravity forces to liquid films
LFFUEL
Sets the fuel type present in films of the active film type
for single-component films
LFHEAT
Switches the heat transfer between the film and carrier
fluid on or off
LFMASS
Switches the mass transfer between the film and carrier
fluid on or off
LFMMENTUM
Switches the momentum transfer between the film and
carrier fluid on or off
LFMODEL
Sets the type of liquid film model used
LFPROPERTY
Defines initial physical properties for liquid films
LFSOLVE
Switches liquid film modelling off or on
LFSTRIP
Switches the liquid film stripping model off or on
LFTDELETE
Deletes a previously defined liquid film type
LFTYPE
Selects a film type ILTY whose initial properties and
behaviour can be defined by appropriate commands
LIGHT
Turns on or off Phong style surface lighting effect for
hidden-line plots
B-23
Appendix B
B-24
COMMANDS SUMMARY
LINLIST
Lists the different line types
LINTYPE
Defines the line type to be used for plotting graph
registers
*LIST
Lists the values of numeric parameters and/or lists the
current loop definition
LIVE
Creates or writes out surface shells or edge lines for the
currently selected set of cells
LMATERIAL
Sets the options for light shading
LOAD
Opens the STAR post-processing file
LOCAL
Defines a local coordinate system
*LOOP
Executes all commands between *DEFINE and *END
LOWREYNOLDS
Switch to turn on the low Reynolds number model
LREACT
Defines the leading reactants in the current chemical
reaction scheme (for LOCAL SOURCE or
REGVAR-PR schemes only)
LSCOMPRESS
Compresses out all deleted load step definitions from
the transient history file
LSDELETE
Deletes a given load step from the transient history file
LSGET
Restores a set of transient options and boundary
specifications that had previously been saved on the
transient history file
LSLIST
Lists the major parameters stored for each load step
defined on the transient history file
LSOURCE
Defines all the constituents of a local source chemical
reaction scheme
LSRANGE
Defines the range of load steps on the transient history
file that the user wishes to run through in the next
STAR analysis run
LSSAVE
Saves all current transient options and boundary
specifications to the transient history file
LSTEP
Defines basic load step parameters
LSWITCH
Turns light shading on and off without disturbing the
lighting parameters
LVISCOSITY
Sets the value of molecular viscosity for the current
material
*MACRO
Lists or executes commands from a macro file
MAGNUSSEN
Defines timescale of eddy break-up for combustion
scheme
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
MEMORY
Sets the size of various pro-STAR parameters
MENU
Switches pro-STAR to the Graphical User Interface
mode
MESH
Goes to the MESH module
MFRAME
Sets control parameters used in multiple rotating frame
of reference problems
MIXASI
Automatically generates a complete events data file for
mixing vessels with arbitrary sliding interface
MIXFRACTION
Defines the mixture fraction of leading reactants
MIXVESSEL
Automatically generates a complete events data file for
mixing vessels
MLIST
Lists material properties
MOLWT
Sets the value of molecular weight for the current
material
MONITOR
Defines the cell at which the solution variables are
printed out at each iteration
MORTHO
Runs an elliptic orthogonaliser on a predefined
(structured) meshed surface or volume in order to
improve the quality of cells with poor internal angles
and/or warpages
MPCCI
Sets coupling interface on or off
MULTISWEEP
Sweeps through the model in numerous ways
MVGRID
Turns on/off flags within STAR which allow/disallow
various types of grid movements/operations within a
transient analysis
NASTRAN
NASTRAN(3) bulk data file format into/from
pro-STAR data
NFILE
Specifies the file to be used for the neutral plot file
NGEOM
Converts and outputs the model for use in STAR CCM,
STAR CCM+ or CEDRE
NMODEL
Specifies the nozzle model
NOX
Turns NOx modelling on or off
NOXC
Specifies 14 additional constants for the NOX command
NPLOT
Plots the specified frame from the neutral plot file
NRANGE
Sets program to read/write nodes within a specified
range
NUMBER
Turns on or off numbering of items on plots
B-25
Appendix B
B-26
COMMANDS SUMMARY
NUMREG
Defines the storage space required for the data to be
read
NWALL
Selects a wall treatment for the following turbulence
models
OFFSET
Sets program to offset nodes and/or elements before
input or output
OFILE
Sets the location to where the program output is written
OPANEL
Allows the user to open user defined panels or Motif
tools from the command line
OPERATE
Allows the user to load any cell or vertex variable on
one or more post data files (which are connected using
the LOAD command) and/or perform vector arithmetic
on one or more variables
OVERLAY
Allows user to overlay two or more plots without
erasing the screen in between
PAGE
Sets the number of lines per page for several of the list
commands
PAN
Centres a plot using either screen coordinates or the
cursor
PANALYSIS
Prints additional information about those patches that
contribute most of the incident radiative heat flux on a
specified patch
PARTICLE
Manages the particle list
PATCH
Creates a (structured) surface bounded by up to four
splines
PATRAN
PATRAN(2) neutral data file format into/from
pro-STAR data
PCROSS
Enables the cursor to be used for selecting a precise
location on the plot when used on a surface contour plot
PDELETE
Deletes the definitions of a range of fluid material
property sets
PEMISSIVITY
Defines particle or droplet emissivity
PGENERATE
Generates additional property sets by copying an initial
range of property values to new locations offset by
MOFF
PL3D
Takes the current extended mode plot window and
records it into a platform independent 3-D Neutral Plot
file (extension .pl3d)
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
PLARROW
Allows the user to add up to 100 different arrows to the
plot using screen coordinates or the cursor device to
define the locations
PLATTACH
Turns the plotting of the attached faces off/on
PLAYBACK
Plots and then animates the requested frames from the
neutral plot file
PLDISPLAY
Sets which legend items to plot
PLFACE
Plots cell faces with colours keyed to the face numbers
PLFIX
Fixes the plot distance and centre at the location
defined by the previous plot (sets user-defined distance
and centre) until overridden with DISTANCE,
CENTRE, ZOOM or PAN
PLIST
Lists the contents of the currently loaded post file
PLLABEL
Allows the user to add up to 20 different labels to the
plot, using screen coordinates or the cursor device to
define label starting locations
PLLOCALCOOR
Adds or removes coordinate axis triads to subsequent
plots
PLMESH
Sets whether or not the cell mesh lines are to be plotted
PLOT
Goes to PLOT module
PLRECALL
Recalls the plot attributes saved in a plot table
PLSAVE
Saves current plot attributes into a plot table or lists
available plot tables
PLTBACK
Controls how the current plot is displayed on the screen
PLTYPE
Defines the type of plot
PMAP
Maps the currently stored post data onto another model
PMATERIAL
Sets the current material property number
POLENTHALPY
Defines a polynomial function to describe the enthalpy
source terms
POLSCALAR
Defines a polynomial function to describe the scalar
source terms
POLYNOMIAL
Defines a polynomial function to describe various
parameters in the current chemical reaction scheme
(which must be a PPDF scheme)
POPCP
Defines a polynomial function to describe specific heat,
enthalpy and entropy for a material
B-27
Appendix B
B-28
COMMANDS SUMMARY
POPD
Defines a polynomial function to describe the mass
diffusivity of the current (background) material in
scalar NSCJ
POPK
Defines a polynomial function to describe the thermal
conductivity of the current material
POPLV
Defines a polynomial function to describe the
molecular viscosity of the current material
POPTION
Defines what type of plot will be rendered next
PORDELETE
Deletes the porosity definitions for the indicated range
of porosity reference IDs
POREFF
Adds values for effective conductivity and turbulent
Prandtl number to a given porosity definition
PORLIST
Lists the porosity definitions for the indicated range of
porosity reference IDs
POROSITY
Defines a porosity model for the given porosity ID
PORTURBULENCE
Adds values for turbulence intensity and length scale to
a given porosity definition
POSCP
Polynomial function to describe specific heat, enthalpy
and entropy for a scalar variable
POSD
Defines a polynomial function to describe mass
diffusivity for scalar pair NSCI and NSCJ
POSK
Polynomial function to describe the thermal
conductivity of a scalar variable
POSLV
Polynomial function to describe the molecular viscosity
for a scalar variable
POST
Goes to the POST module
POWALL
Specifies or lists what wall data to store in the post data
file (case.pst)
PPDF
Defines or lists the Presumed Probability Density
Function reaction scheme parameters for the current
chemical reaction scheme (which must be a PPDF
scheme)
PRCHECK
Determines whether or not several items useful in
checking the analysis are or are not printed to the
case.info file
PRESSURE
Sets a reference pressure and cell location for the
current material
PRFIELD
Sets the values of the cells at which field data will be
printed in the solution phase
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
PRINT
Prints the post register data to the screen
PROBLEMWRITE
Writes the problem data file (STAR file case.prob)
containing all control, print, property and boundary
condition information
PROMPT
Allows the user to place up to three lines of character
strings in the message area underneath the plotting
window
PROPERTIES
Goes to the PROPERTIES module
PRPOST
Specifies or lists what cell and wall post data to print
and how often
PRTEMP
Sets the printed values of temperature either as absolute
values or relative to the datum temperature TDATUM
PRWALL
Specifies or lists what wall data to print at the end of a
run
PSCREATE
Creates shells for both section and isosurfaces to be
stored as a named collection of shells and vertices
PSDELETE
Deletes a range of section/isosurface shells
PSTAR
Reads a STAR post data file in either coded or binary
format and converts to binary or coded format (as
appropriate)
PSYS
Resolves incoming vector components into a
predefined local coordinate system (IPSYS)
PTCONVERT
Reads a STAR droplet track or particle track data file in
either coded or binary format and converts to binary or
coded format (as appropriate)
PTOPTION
Sets the colour and line width used to draw particle
tracks
PTPLOT
Plots or clears particle tracks
PTPRINT
Prints values for particles/droplets from the track file
PTRACK
Calculates particle tracks
PTREAD
Reads particle tracks from a file and interpolates their
position based on TIME
PTSYMM
Takes the particle track file and creates a second file
with all the original tracks and a new set of tracks in
which the originals have all been reflected about a
global symmetry plane
PTVERTS
Reads particle track number IPART from particle track
file LFP and creates vertices NV1 to NV2 by NVINC at
equally spaced locations along the particle path
B-29
Appendix B
B-30
COMMANDS SUMMARY
QDRAW
Turns on/off ‘quick draw’ mode
QUIT
Exits from program
RADIATION
Turns on/off the calculation of wall-to-wall heat
transfer due to radiation effects and selects the radiation
model
RADC
Goes to the RADCALC module
RADPROPERTIES
Defines radiation properties for the current material
RANGE
Finds the geometric range of a given set of cells,
vertices, boundaries or splines
RCALCULATE
Calculates various series or summations based upon the
option selected and stores the result in a graph register
RCHECK
Checks all defined regions
RCLEAR
Clears graph registers of values
RCLIP
Clips values from one graph register into another graph
register
RCOMPRESS
Compresses undefined/deleted boundary regions out of
the model
RCONSTANT
Allows input of various undocumented constants
RDATA
Controls the reading and use of a restart file
RDEFINE
Defines the characteristics of a boundary region
RDELETE
Deletes the characteristic values for a set of regions
RDPR
Reads in a table of cell number versus processor
number
REACTION
Defines a reaction to be used in the current chemical
reaction scheme (for LOCAL SOURCE or
REGVAR-PR schemes only)
RECALL
Recalls previously issued commands and re-executes
them
RECOVER
Goes back to last SAVE or RESUME or beginning of
echo file, resumes and plays back all commands since
that point
RECRD
Runs the animation sequence according to the
parameters set by the AOPTION command
REEXTRUDE
Moves a set of vertices and cells by extruding all the
vertices attached to the back faces of the given vertices
REFLUX
Sets the under-relaxation value of fluxes for velocity
initialisation
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
REFRAME
Translates velocity vectors from one rotating frame of
reference into the global system or into another rotating
frame of reference
REGLIST
Lists the values stored in the specified graph registers
REHT
Defines heat of reaction data for a given reaction in a
RELAX
Sets the value of the relaxation factors used in the
solution of each of the respective variables
RENDEROPT
Sets advanced rendering options for extended mode
plotting
REPLOT
Plots the last plot over again as long as current set of
selected cells (CSET) or vertices (VSET) has not
changed
REPROJECT
Projects vertices onto a shell surface
RESDATA
Controls both printing and post data file writing of
residuals
RESET
Sets all plot specifications to their initial values
RESIDUAL
Sets the values of the residual error tolerances used for
judging convergence of each of the respective variables
RESTRUCTURE
Reorders vertices attached to the current cell set (on the
basis of connectivity) into a structured order and
optionally renumbers the redefined vertices in other
cells, splines and blocks
RESUME
Restores a previously created model
REWIND
Rewinds a previously used file
RGENERATE
Generates additional boundary regions with properties
identical to the original starting set
RINLET
Defines parameters for compressible subsonic inflows
for an inlet boundary region
RLABEL
Allows the user to define a text label for a graph
register
RLIST
Lists the definition of each boundary region
RMODIFY
Modifies the characteristics of an already defined
boundary region
RNAME
Defines an alphanumeric identifier for a boundary
region entry
ROPERATE
Stores the result of various operations on up to two
graph registers in a separate (output) graph register
ROTATE
Rotates the plot about the screen axis
B-31
Appendix B
B-32
COMMANDS SUMMARY
RPnnnn
Repeats the previous command nnnn (2 < nnnn) times
incrementing each field of that command by INC1 to
INC10, respectively
RRATE
Defines the reaction rate for a current local source
chemical reaction process
RSGENERATE
Generates scalar boundary values for a range of
boundary regions based on scalar boundary values of a
single boundary region
RSLIST
Lists scalar boundary values
RSMODIFY
Modifies a scalar boundary value
RSORT
Sorts data values based on a graph register
RSOURCE
Specifies enthalpy, mass, momentum, or turbulence
source terms
RSTATUS
Lists a chemical reaction, copies a chemical reaction
from an existing chemical reaction scheme or turns a
chemical reaction off or on
RTABLE
Defines the graph register type
RTLIST
Lists the graph register types
RTPRESSURE
Sets temperature and scalar mass fraction options for
pressure boundary regions
RTURBULENCE
Sets turbulence options and parameter values for
boundary regions
RUNTIME
Specifies the run time length (in the current time units
defined by command TRELATION)
SAFETY
Allows the user to turn on or off several safety features
*SASK
Prompts the user to enter a string value for string
parameter PARA
SAVE
Saves all data from the current model
*SAVE
Saves the currently defined loop to an output file
SAVUSERDATA
Writes the currently stored cell, vertex or wall post data
to a file
SBRE
Defines sub-reaction models for a given chemical
reaction scheme
SC
Defines all basic information for each additional scalar
variable that the user wishes to solve for in STAR
SCALAR
Goes to the SCALAR module
SCCGENERATE
Generates (replicates) a set of scalar control parameters
over a range of scalars
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
SCCLIST
Lists the control parameters defined for a range of
added scalar equations for the currently active material
number
SCCMODIFY
Modifies control parameters of scalars
SCCONTROL
Defines control parameters for scalars
SCDELETE
Deletes scalar attributes from the data base and
compresses the maximum number of scalars to the
highest-numbered scalar left ON
SCDUMP
Turns the screen dump facility off/on
SCGENERATE
Generates additional scalar attribute tables copied from
an initial starting set
SCHECK
Checks the selected shells and polygons to detect errors
that ammbatch will find when initially checking the
surface and other surface conditions that can cause
problems
SCLIST
Lists the attributes/properties defined for a range of
added scalar equations
SCLOCATE
Turns on the plot cursor and gives a continuous readout
of the cursor position in screen coordinates, global
coordinates and local coordinates
SCMODIFY
Allows the user to modify a single item of information
used by a scalar definition without the need to respecify
all items
SCMP
Performs mapping between complex chemistry species
and the global scalars for a given chemical reaction
scheme
*SCOPY
Copies the current value of a numeric parameter into a
string parameter
SCPLIST
Lists the attributes/properties defined for a range of
scalar concentrations for a given material number
SCPOROUS
Allows the user to define a value for porous diffusivity
and turbulent Schmidt number for any scalar
SCPROPERTIES
Defines material-dependent properties for scalars
SCRDELETE
Deletes the currently stored image in the area identified
by INDEX and de-allocates the memory used to store it
SCRIN
Displays an image stored using the SCROUT command
SCROUT
Copies the current image to a storage area identified by
INDEX
SCSOURCE
Specifies scalar source terms
B-33
Appendix B
B-34
COMMANDS SUMMARY
SCTRANS
Tells STAR which additional scalar data to print and/or
write on the transient post file (which was connected
using the TRLOAD command)
SDATA
Saves graph register data values into a file
SECMOVE
Moves the section definition and performs a replot
SECSCALE
Turns on or off automatic scaling of section or clipped
plots
SENSOR
The SENSOR command manages a list of vertices used
as ‘sensor’ points within the solution domain
*SET
Sets the value of a numeric parameter
SETADD
Sets whether or not newly created items (boundaries,
cells, couples, and splines) are to be added to the
current item set
SETDELETE
Deletes a set definition previously stored using the
SETWRITE command
SETENV
Sets a user defined environment variable for a display
element
SETFEATURE
Sets various pro-STAR features on or off for the
duration of the run
SETREAD
Reads a set definition previously stored using the
SETWRITE command back into the program
SETWRITE
Writes the current set (CSET, VSET, BSET, SPLSET,
BLKSET, CPSET) definitions to file LF for future
recall and use
SHREFINE
Refines a surface or portion of a surface defined by
shell cells
SHRINK
Shrinks the size of each cell by the specified factor so
that each cell boundary may be seen separately from its
adjoining neighbours
SHTRA
Turns off or on the Suga turbulent heat flux for any
Suga turbulence model
SIZE
Prints a list of some current maximum quantities
(maximum cell number, maximum vertex number, etc.)
allowed in pro-STAR
*SLIST
Lists the values of string parameters and/or lists the
current loop definition
SMAP
Maps all cell post data items stored on the currently
loaded post file to a new data file (SMAP file), on the
basis of a different mesh geometry stored on another
pro-STAR model file
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
SMCONVERT
Reads a STAR solution monitoring file in either coded
or binary format and converts to binary or coded format
(as appropriate)
SMO3
Smooths the cells in the current cell set using a
minimisation technique
SNORMAL
Defines the direction of the normal to the section plane
(used for SECTION and CHIDDEN plots)
SOLAR
Sets solar radiation parameters
SOLUFORM
Determines which matrix solution algorithm is to be
used in STAR
SOLVE
Controls the variables that are solved for
SOOT
Specifies parameters used for modelling soot formation
for a given chemical reaction scheme
SORT
Sorts stored post-processing data according to the value
of the currently stored scalar item
SPCHECK
Checks for splines which cross over themselves and for
identical splines
SPCOMPRESS
Compresses deleted splines out of a model
SPECIFICHEAT
Sets the value of specific heat for the current material
SPIN
Defines a spinning velocity and axis of revolution in
order to calculate body forces on the fluid
SPL
Defines a cubic spline by specifying either the vertices
which make up the spline, a range of vertices which
make up the spline or several vertices along the spline
path and having the computer fill in vertices by
following a surface
SPLCROSS
Defines or adds to a spline definition by using the
cursor to point to a series of predefined vertices
SPLDELETE
Deletes a range of splines
SPLGENERATE
Generates additional splines from a predefined series of
splines
SPLLIST
Lists spline definitions for a range of splines
SPLMODIFY
Modifies a spline by changing the set of vertices that it
references and/or by changing its type number
SPLOT
Makes a plot of splines in accordance with the user
defined spline set and any other pertinent parameters
SPLREAD
Reads a set of spline definition (connectivity) data from
a file
SPLSET
Builds a spline set
B-35
Appendix B
B-36
COMMANDS SUMMARY
SPLUNDELETE
Undeletes a set of splines
SPLWRITE
Writes a set of spline connectivity data to a file
SPOINT
Defines the point through which the section plane
passes, perpendicularly to the SNORMAL specification
or a surface of constant value in any predefined local
coordinate system
SPRINT
Prints the currently selected post data items on the
plane defined by the SPOINT and SNORM commands
SPVCOMPRESS
Compresses the spline vertex storage array to its
minimum size
SRCLIST
Lists source terms defined in the RSOURCE and
SCSOURCE commands
SRFDELETE
Deletes a surface definition previously stored using the
SRFWRITE command
SRFREAD
Reads a surface definition previously stored using the
SRFWRITE command back into the program, allowing
the user to skip the CPLOT command and go directly to
REPLOT
SRFWRITE
Writes the current plot surface to file LF in a very
compressed manner for future recall and use
*SSET
Sets the value of a string parameter
STABLE
Defines a spline table entry
STATUS
Displays the status of certain variables within each
module
STDELETE
Deletes spline table entry definitions
STENSION
Defines the surface tension properties of heavy fluid for
use in free surface and cavitation modelling
STL
Reads in a stereolithography (.stl) file as a series of
triangular shells
STLIST
Lists spline table entry definitions
STORE
Stores a time step location from a transient data file for
loading post data
STPA
Defines the iteration number when averaging is to
begin and the particle under-relaxation factor for coal
combustion problems
STYPE
Changes the currently active spline type ID
SUBTITLE
Allows the user to place up to two subtitles on each plot
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
SUMMARISE
Provides the sum, average, area-weighted average,
minimum value/location and maximum value/location
for each of the four post data items stored
SURFACE
Turns on or off the drawing of the exterior surface only,
while plotting the selected cells
SWEEP
Sets the values of the number of sweeps used in the
solution of each of the respective variables
SWIRLBLEND
Enters a blending factor for swirl terms in models with
an axis of symmetry located on a single wedge shaped
cell
SWITCHES
Turns on/off or lists various undocumented switches
within STAR
SYMLIST
Lists the different symbol types
SYMTYPE
Defines the symbol type to be used for plotting graph
registers
SYSTEM
Prompts for a command line which will be passed to
the operating system and executed as an operating
system command
TABLE
Creates, adds to or plots a table
TBCLEAR
Clears all table data
TBDEFINE
Defines a table
TBGRAPH
Graphs selected variables of the currently loaded table
TBIN
Creates the PDF integration input file
TBLIST
Lists the currently loaded table
TBMODIFY
Modifies table data
TBREAD
Reads a table from a file
TBSCAN
Scans a table file for information concerning the table
TBWRITE
Writes a table to a file
TDATUM
Sets a temperature datum and is needed only if the
enthalpy equation is being solved
TDSCHEME
Sets the temporal discretisation scheme on all
transported variables
TECPLOT
Writes grid and post data in Tecplot format
TEMPERATURE
Sets various options for the calculation of temperature
by STAR
TERMINAL
Defines terminal type and characteristics
B-37
Appendix B
B-38
COMMANDS SUMMARY
TETALIGN
Reorders the vertex definitions of tetrahedral cells in a
way which cuts the memory and time requirements for
the STAR solver for meshes which are all or
predominantly tetrahedral
TETGENERATE
Generates a tetrahedral or hybrid mesh, or smooths the
vertices in the current cell set, depending on the option
chosen
TETREFINE
Refines all tetrahedral cells in the specified range by a
factor of 2 along each edge
TEXT
Changes display from graphics screen to text screen
TFILL
Fills a table with data using a function of X
TFIND
Finds the interpolated Y-value for a given X-value and
table number
TGENERATE
Creates a new set of tables from existing tables
TGRID
Reads nodes and cells from a TGRID format file
THERMDIF
Determines whether thermal diffusion is included in the
species transport equation for the current material
THIN
‘Thins out’ the number of vectors plotted for vector
plots or the frequency of contour line labels for contour
plots
TICMARK
Causes a grid referenced to the global Cartesian system
to be plotted over the current plot
TIME
Sets time step and steady-state/transient/pseudotransient/single-transient analysis key
TITLE
Sets the title for the model
TLIST
Lists the values in tables NTAB1 to NTAB2,
incrementing by NTABINC
TLMODEL
Selects a one-equation turbulence model for use by the
two-layer method
TLSWITCH
Changes the default parameters used in calculating the
match point between the one- and two-equation models
TMAP
Maps X-data or Y-data from one table to another
TMODIFY
Modifies one or more entries in a table
TMSTAMP
Puts a time stamp on the plot
TNORM
Provides an estimated temperature change over the
domain to be used in normalising the residuals of the
enthalpy equation
TPHL
Turns two-phase Lagrangian calculations on or off and
specifies whether the process is coupled or uncoupled
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
TPLOT
Calls the ‘NEWXYZ’ user subroutine to update and
redisplay mesh geometry
TPRINT
Toggles a switch which reports the CPU time required
to complete each pro-STAR function
TRANSIENT
Goes to TRANSIENT module
TREAD
Reads table data from a file
TRELATION
Defines a time-dependent variable, such as angular
position in turbomachinery or crank angle in
reciprocating engine applications, and its relationship
to time (in seconds)
TRFILE
Initialises a transient history data file or reconnects to a
previously defined file
TRINTERPOLATE
Turns on or off linear interpolation of post data values
for times specified with the STORE command
TRLOAD
Opens one or more STAR transient data files and lists
their time step information
TRUNCATE
Places an (irremovable) end of file mark on a STAR
transient post data file at the indicated time step
TSCALE
Allows resizing of text fonts used in pro-STAR
TSMAP
Maps (rezones) all cell post data items stored on the
currently loaded post file to a new data file (SMAP
file), on the basis of a different mesh geometry stored
on another pro-STAR model file
TSMULT
Scalar multiplication of values in a table
TSTAR
Reads a STAR transient post data file in either coded or
binary format and converts to binary or coded format
(as appropriate)
TUGL
Defines the coefficients used if the Gibson-Launder
Reynolds stress turbulence model is turned on
TURBULENCE
Sets the turbulence model and required values for
calculating turbulence for the current material
TUSSG
Defines the constants used if the Speziale, Sarkar and
Gatski Reynolds stress turbulence model is turned on
TVMULT
Multiplies values in table NTAB1 by the corresponding
values in table NTAB2 and puts the result in table
NTAB3
TWOIGNITION
Activates or deactivates the second ignition sequence
for a given chemical reaction scheme
TWOLAYER
Activates/deactivates the two-layer turbulence model
for the current material
B-39
Appendix B
B-40
COMMANDS SUMMARY
TWRITE
Writes table data to a file
UGRID
Allows the user to map a uniformly spaced grid over a
section for purposes of vector solution display
ULOAD
Loads user data from previously defined user files that
have been connected using the GETUSERDATA
command
UNITS
Allows the program to automatically convert the units
of post data items from SI to English system units
UNSKEW
Decreases the internal angles of surface cells
UNWARP
Reduces cell face warpages within the current cell set
UPDATE
After a set of post data has been altered using the
CHANGE command, this command rewrites the
post-processing file to make the change permanent
USER
Allows access to user written pro-STAR subroutines
USUBROUTINE
Lists or writes the user defined subroutines available in
the STAR solver
UTILITIES
Goes to the UTILITIES module
V
Defines a vertex in the currently active local coordinate
system
VADJANGLE
Reduces the warpage and the internal angles of cells in
the current CSET
VAPORIZATION
Activates/deactivates the evaporation/boiling/
condensation computation in free surface flows
VARIABLE
Controls the allowable length for numeric and string
parameter names
VAVERAGE
Produces a set of cell data by averaging all vertex post
data variables connected to each respective cell
VBOUNDARY
Defines vertices at the centroids of boundaries
VC2DGEN
Creates a plane of vertices and shells at the same time
VC3DGEN
Creates a block of vertices and cells at the same time
VCELL
Defines vertices at the centroids of cells
VCENTER
Given two vertices on a circle and a radius or three
vertices on a circle, this command calculates the centre
of the circle and puts vertex NV at that location
VCEXTRUDE
Creates a set of vertices and/or cells by extruding all the
vertices attached to a given pattern of shell, baffle, line
or point cells
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
VCOMPRESS
Compresses out all unused vertex numbers in the given
range
VCROSS
Allows the user to define/modify vertex positions using
the terminal cursor to mark new locations
VDA
Reads VDA data from file LF and translates them into
pro-STAR entities
VDELETE
Deletes a range of vertices
VDISTANCE
Calculates the distance between two vertices
VELLIPTIC
Provides smoothing for all vertices connected to the
current CSET
VEQUAL
Takes one or more coordinates of vertex NVMOVE
and equates them to the coordinates of vertex NVFIX
in the current local coordinate system
VESCALE
Changes the size of all vectors by multiplying by a
constant factor or fixes all vectors to a constant length
VFCALC
Calculates view factors using the FASTRAC method
VFILL
Fills in vertices between two predefined vertices in the
currently active local coordinate system
VGAP
Finds gaps (unused vertices) in a given vertex range
VGENERATE
Generates sets of vertices from a predefined pattern by
incrementing in the currently active local coordinate
system
VIEW
Defines the viewing direction
VINTERSECT
Defines vertices at the intersection of the current cell
set with a shell type
VLIST
Lists the locations of predefined vertices
VLOCAL
Defines a local coordinate system using three
predefined vertices
VMAP
VMERGE
Merges groups of coincident vertices together
VMODIFY
Modifies one or more coordinates of a vertex in the
currently active coordinate system
VMOVE
Moves a vertex to the intersection of two local
coordinate systems
VOLUME
Calculates the volume within the specified cell range
VPCREATE
Creates vertices based on specified patterns
B-41
Appendix B
B-42
COMMANDS SUMMARY
VPLOT
Makes a plot of vertices in accordance with the user
defined vertex set and any other pertinent parameters
VPROJECT
Projects vertices onto a shell surface
VREAD
Reads in a set of vertex position data from a file
VREFLECT
Generates a set of vertices by reflection about a local
coordinate system axis
VRENUMBER
Renumbers all cell, boundary, spline and mesh block
definitions
VREPLACE
Replaces one group of vertices with a different set and
then searches all cell, boundary and mesh block
definitions to make an appropriate adjustment
VRML
Writes shells to a VRML style file
VSCALE
Scales (multiplies) a range of vertices by a different
factor in each direction of a given coordinate system
VSECTION
Defines vertices at the section of the current cell set
VSET
Builds a vertex set
VSMOOTH
Provides algebraic smoothing for all vertices connected
to the current CSET
VSPCROSS
VSPDEFINE
Defines a single vertex on a given spline with reference
to the arc length of the spline
VSPFILL
Fills in along a predefined spline between two vertices
already located on the spline
VSPGENERATE
Generates a group of vertices using a spline as a
referenced local coordinate system
VSPLIST
Lists the spline coordinates of a range of vertices
VSPMOVE
Moves a vertex to the intersection of a spline and a
local coordinate system
VSPPROJECT
Projects vertices onto splines
VSTYLE
Defines symbols that mark vertex locations
VTRANS
Transfers vertices from the currently active coordinate
system into another system by reinterpreting the
coordinates directly in the new system
VUNDO
Undoes the results of the last command used to
add/delete/modify any vertex
VVERTEX
Defines a vertex at the centroids of other vertices
VWRITE
Writes a set of vertex position data to a file
Version 3.26
Appendix B
Version 3.26
COMMANDS SUMMARY
WALLFUNCTION
Selects either the standard wall function,
non-equilibrium wall function or meshless two-layer
for high Reynolds number k-ε models
WDATA
Controls the writing of a restart/post-processing file
(case.pst)
WHEATTR
Activates/deactivates wall heat transfer modelling due
to boiling
WHOLE
Sets the plot window size and turns on/off the plot
window GUI
WINDOW
Enables the user to resize the portion of the screen used
for displaying the plot
WIPEOUT
Clears all model parameters
WPLOT
Makes a plot of the wall shells in accordance with the
user-defined cell set and any other pertinent parameters
WPOST
Defines the list of wall data items to be written to the
transient history post file every NPOF time steps during
this load step
WPRINT
Defines the list of wall data items to be printed every
NPRF time steps during this load step
WRPOST
Specifies or lists what cell and wall post data to write to
the transient post file and how often
ZOOM
Allows the user to zoom in on a portion of the plot
using either screen coordinates or the cursor device to
define the region
B-43
COMMANDS INDEX
COMMANDS INDEX
Numerics
AAANALYSIS 10-1
ABSURFACE 5-23
ACCELERATION 7-22
ACOEFF 16-30
ACROSS 6-1
ALGORITHM 10-1
AMODEL 12-10
ANGLE 5-23
ANIMATE 2-7
ANORM 10-14
ANSYS 4-1
AOPTION 18-1
AREA 6-1
ARROW 5-42
AXISUP 5-23
AZONE 6-2
BARLIST 17-12
BARTYPE 17-12
BATCH 2-1
BC 9-25
BCCOMPRESS 9-25
BCDELETE 9-25
BCGROUP 9-25
BCHECK 9-1
BCLIST 9-26
BCMATCH 9-26
BCOMPRESS 9-1
BCOPTION 9-26
BCROSS 9-1
BDEFINE 9-1
BDELETE 9-2
BDISPLAY 5-24
BDX 9-2
BFIND 9-3
BGENERATE 9-4
BLIST 9-4
BLK 3-10
BLKCELL 3-11
BLKDELETE 3-11
BLKEXECUTE 3-12
BLKFACTORS 3-12
BLKGENERATE 3-13
BLKLIST 3-13
BLKMODIFY 3-14
BLKPLOT 5-7
BLKSET 5-11
BLKTRACE 3-14
BLKWALL 3-14
BMERGE 9-4
BMODIFY 9-5
BOUNDARY 2-8
BPATCH 9-5
BPCOMPRESS 9-6
BREAD 9-6
BRMONITOR 10-15
BSET 5-12
BSHELL 9-7
BUOYANCY 7-22
BWRITE 9-7
BZONE 9-8
B
C
BAMM 20-1
C 3-52
2D3D 3-10
Symbols
*ABBREVIATE 2-13
*ABLIST 2-14
*ASK 2-14
*CALC 2-14
*CLEAR 2-15
*DEFINE 2-15
*ELSE 2-16
*END 2-16
*ENDIF 2-16
*GET 2-16
*GOTO 2-26
*IF 2-26
*LIST 2-27
*LOOP 2-27
*MACRO 2-27
*SASK 2-28
*SAVE 2-28
*SCOPY 2-28
*SET 2-29
*SLIST 2-29
*SSET 2-29
A
Version 3.26
1
Index
CADHIDDEN 4-8
CADSET 4-8
CADTRANSLATE 4-9
CASENAME 2-1
CAVERAGE 16-16
CAVITATION 10-20
CAVNUCLEI 10-21
CAVPROPERTY 10-22
CBEXTRUDE 3-5
CCOMPRESS 3-53
CCROSS 3-53
CCUT 20-5
CDCHEM 15-1
CDELETE 3-54
CDIRECTION 3-1
CDISPLAY 5-25
CDIVIDE 3-54
CDSAVE 2-10
CDSCALAR 8-1
CDTRANS 11-1
CDX 3-55
CENTER 5-25
CFIND 3-56
CFIX 3-58
CFLIP 3-58
CGENERATE 3-59
CGGCELL 16-1
CGGVERTEX 16-3
CGNS 4-1
CGSTATS 4-2
CHANGE 16-17
CHECK 3-1
CHEMICAL 2-8
CHEREACTION 15-23
CHMSOLVER 15-23
CHSCHEME 7-1
CICDEFINE 9-27
CICOMPRESS 9-27
CIDELETE 9-27
CILIST 9-28
CIMM 9-28
CINITIALIZE 7-23
CITAG 9-28
CJOIN 3-60
CKBREGION 15-28
CKCTABLE 15-28
CKELEMENT 15-23
CKFO 15-23
CKGOPTION 15-29
2
CKIN 15-29
CKLIST 15-24
CKMAT 15-29
CKPOST 15-30
CKPREP 15-30
CKREACTION 15-24
CKRO 15-25
CKSFRACTION 15-30
CKSOPTION 15-30
CKSPECIES 15-26
CKTHIRD 15-26
CLEAR 5-7
CLIST 3-61
CLOCAL 3-17
CLOSE 2-10
CLRFILL 5-4
CLRLIST 5-4
CLRMODE 5-5
CLRPENS 5-5
CLRTABLE 5-6
CLRWALL 16-1
CMODIFY 3-61
CMREFINE 3-61
CMROPTION 3-62
CMUNREFINE 3-63
COALMODEL 15-17
CODB 15-18
COEBREAKUP 15-18
COGLOBAL 15-18
COKE 7-24
COLES 7-26
COMCHECK 15-27
COMISC 15-19
COMSET 15-27
CONDUCTIVITY 7-4
CONJUGATEHEAT 10-2
CONL 7-26
CONTROL 2-8
CONVERT 2-8
COPANALYSIS 15-19
CORIENT 20-7
COSCHAR 15-19
COSTATUS 15-20
COSUBMODEL 15-20
COSVOLATILE 15-20
COUANALYSIS 15-21
COUNT 6-2
CP 3-78
CPCELL 6-2
Version 3.26
Index
CPCHECK 3-79
CPCOMPRESS 3-80
CPCREATE 3-80
CPDELETE 3-81
CPDISPLAY 5-26
CPFACE 3-81
CPFLAG 3-82
CPFREEZE 3-82
CPGENERATE 3-83
CPLIST 3-83
CPLOT 5-7
CPMERGE 3-83
CPMODIFY 3-84
CPOST 11-1
CPRANGE 11-1
CPREAD 3-85
CPRINT 11-1
CPSET 3-86
CPTABLE 3-87
CPTDELETE 3-88
CPTLIST 3-88
CPTMODIFY 3-88
CPTNAME 3-88
CPTOLERANCE 3-89
CPTYPE 3-89
CPUTIME 10-15
CPWRITE 3-89
CRDELETE 15-1
CREAD 3-64
CREFINE 3-65
CREORDER 3-67
CRLIST 15-1
CRMODEL 15-2
CRPRODUCTS 15-5
CRREACTANT 15-5
CRSCALAR 15-16
CRSE 3-67
CRTYPE 15-3
CRUNDELETE 15-4
CSCALE 5-43
CSDELETE 3-17
CSDIR 3-17
CSET 5-14
CSHELL 3-67
CSLIST 3-18
CSMONITOR 10-16
CSPLINE 3-68
CSYS 3-18
CTABLE 3-68
Version 3.26
CTCOMPRESS 3-69
CTDELETE 3-69
CTLIST 3-70
CTMODIFY 3-70
CTNAME 3-71
CTRIM 3-71
CTYPE 3-71
CUNDELETE 3-72
CURSORMODE 2-1
CVERTEX 6-3
CVREFLECT 3-72
CWRITE 3-72
CYARBITRARY 9-8
CYCHECK 9-9
CYCLIC 9-9
CYCOMPRESS 9-10
CYDELETE 9-10
CYGENERATE 9-10
CYLIST 9-10
CYMATCH 9-11
CZONE 3-73
D
DAGE 12-1
DBASE 6-3
DCOLLISION 12-16
DCONDENSATION 12-16
DELTIME 11-2
DENSITY 7-4
DGENERATE 16-17
DIFCORRECTION 7-27
DIFFUSIVITY 7-5
DILUTANT 15-9
DINLIST 12-5
DINTERPOLATION 12-1
DIRECTION 4-2
DISTANCE 5-26
DLIST 12-1
DMAX 12-5
DOPTION 5-45
DPLOT 5-47
DRAVERAGE 12-2
DRBOIL 12-12
DRBREAKUP 12-12
DRCLIST 12-13
DRCMPONENT 12-13
DRCOMPRESS 12-5
DRCREATE 12-5
3
Index
DRDIAMETER 12-7
DREAD 12-2
DRFORCE 12-17
DRGENERATE 12-7
DRGROUP 12-8
DRHEAT 12-13
DRINITIAL 12-8
DRMASS 12-13
DRMOMENTUM 12-14
DRNPROCEDURE 12-2
DROPLETS 2-8
DRPMODE 12-2
DRPOST 12-3
DRPROPERTIES 12-14
DRSCALE 12-9
DRSDUPLICATE 12-9
DRTDELETE 12-14
DRTURBULENCE 12-17
DRTYPE 12-15
DRUSER 12-3
DRWALL 12-15
DSCHEME 10-2
DSET 5-18
DSTATUS 5-47
DTIME 12-3
DTYLIST 12-15
DWRITE 12-4
E
EACELL 14-10
EACOMPRESS 14-12
EADELETE 14-12
EAGENERATE 14-12
EALIST 14-13
EAMATCH 14-13
EASI 14-20
EATTACH 14-14
EBODY 19-1
EBRMONITOR 19-1
ECHOINPUT 2-1
ECLIST 14-10
ECNDUCTIVITY 19-2
ECONDITIONAL 14-8
ECOPTION 19-2
ECSMONITOR 19-2
EDATA 10-3
EDCELL 14-10
EDCOMPRESS 14-14
4
EDDELETE 14-14
EDDIR 14-11
EDENSITY 19-3
EDETACH 14-14
EDGE 5-26
EDGRAPH 17-22
EDLIST 14-15
EDLOAD 17-3
EDRAG 19-3
EDSCAN 6-24
EECELL 14-11
EEDGRAPH 19-4
EEDLOAD 19-5
EFLUID 14-8
EGEBOUNDARY 19-6
EGECELL 19-7
EGEVERTEX 19-7
EGRID 14-8
EGSTAR 19-8
EGTRANS 19-9
EHTRANSFER 19-10
EICELL 14-11
EICOND 14-12
EINITIAL 19-10
EINTERNAL 19-10
ELVISCOSITY 19-11
EMOLWT 19-11
EMOMENTUM 19-12
EMPHASE 19-12
EMSLIDE 14-20
ENSIGHT 4-2
EOSLIDE 14-20
EPCP 19-12
EPHASE 19-15
EPLIST 19-15
EPLV 19-15
EPOK 19-17
EPSLIDE 14-21
ERANGE 4-4
ERDEFINE 19-18
ERELAX 19-19
ERESIDUAL 19-20
ERLIST 19-20
ERMODIFY 19-20
ERRESTIMATE 10-4
ERTPRESSURE 19-21
ESIZE 19-21
ESOLVE 19-21
ESPECIFICHEAT 19-22
Version 3.26
Index
ESSLIDE 14-21
ESWEEP 19-23
ETEMPERATURE 19-23
ETURB 19-23
EVCHECK 14-16
EVCND 14-1
EVCOMPRESS 14-2
EVDELETE 14-2
EVENTS 2-8
EVEXECUTE 14-16
EVFILE 14-2
EVFLAG 14-17
EVGET 14-2
EVLIST 14-3
EVLOAD 14-18
EVOFFSET 14-4
EVPARM 14-4
EVPREP 14-19
EVREAD 14-5
EVSAVE 14-5
EVSLIDE 14-22
EVSTEP 14-6
EVUNDELETE 14-7
EVWRITE 14-7
EXIT 2-2, 3-4, 4-1, 5-1, 6-3, 7-1, 9-12, 10-13,
11-4, 12-4, 13-1, 14-1, 15-1, 16-1, 17-1,
18-2, 19-24, 20-7, 21-1
EXPERT 2-2
EZIP 20-7
F
FLCO 15-9
FLCP 15-9
FLDELETE 15-10
FLGENERATE 15-10
FLIST 3-73
FLKV 15-10
FLPLOT 15-10
FLR1 15-11
FLR2 15-11
FLUXSUM 6-5
FRAME 17-17
FRDEFINE 17-19
FSDSCHEME 10-22
FSMASSTR 10-23
FSSUBCYCLE 10-23
FSTAT 6-6
FSURFACE 10-23
Version 3.26
FSVOF 10-24
FUEL 12-10
FV 4-4
FWRITE 3-74
G
GAMBIT 4-4
GDATA 17-3
GDRAW 17-25
GENERIC 4-11
GEOMWRITE 2-11
GETBOUNDARY 16-4
GETCELL 16-5
GETDROPLET 16-7
GETUSERDATA 16-7
GETVERTEX 16-8
GETWALL 16-10
GFILL 17-4
GFTB 15-11
GINPUT 17-5
GLOAD 17-5
GMAP 16-13
GMARK 17-19
GPAN 17-25
GPARAM 17-6
GPICK 17-25
GPOST 17-6
GPTLOAD 17-7
GPUT 17-7
GR3D 4-4
GRAPH 2-9
GRAY 18-3
GRDISPLAY 17-20
GREDRAW 17-26
GRESET 17-1
GRLABEL 17-21
GSPLIT 17-22
GSTAR 17-7
GTPOWER 10-4
GTRANS 17-8
GVALUE 17-9
GZOOM 17-26
H
HCOEFF 7-6
HEADING 5-44
HELP 2-2, 3-4, 4-1, 5-1, 6-6, 7-1, 8-1, 11-4,
12-4, 13-1, 14-1, 15-1, 16-1, 17-1, 18-3,
5
Index
19-24, 20-8, 21-1
HFILL 20-8
HISTORY 2-2
HRCO 15-4
HRSDUMP 5-27
I
ICEM 4-5
IDEAS 4-5
IFILE 2-11
IGES 4-10
IGN2 15-14
IGNITION 15-14
IGNMODEL 15-15
IGNORE 4-10
INISCALAR 7-27
INITIAL 7-28
INJDELETE 12-10
INJECTOR 12-10
INJLIST 12-11
INTEGRATE 16-30
ITERATION 10-4
K
KNOCK 15-15
L
LAYER 5-27
LESOUT 10-16
LFBOIL 13-1
LFCMPONENT 13-1
LFCONDENSATION 13-1
LFFORCE 13-2
LFFUEL 13-2
LFHEAT 13-2
LFMASS 13-2
LFMMENTUM 13-2
LFMODEL 13-3
LFPROPERTY 13-3
LFSOLVE 13-4
LFSTRIP 13-4
LFTDELETE 13-4
LFTYPE 13-4
LIGHT 5-28
LINLIST 17-12
LINTYPE 17-13
LIVE 6-6
6
LMATERIAL 5-29
LOAD 16-14
LOCAL 3-18
LOWREYNOLDS 7-29
LREACT 15-6
LSCOMPRESS 11-4
LSDELETE 11-4
LSGET 11-4
LSLIST 11-4
LSOURCE 15-6
LSRANGE 11-4
LSSAVE 11-5
LSTEP 11-5
LSWITCH 5-29
LVISCOSITY 7-6
M
MAGNUSSEN 15-6
MEMORY 2-3
MENU 2-4
MESH 2-9
MFRAME 10-4
MIXASI 14-15
MIXFRACTION 15-28
MIXVESSEL 14-15
MLIST 7-1
MOLWT 7-7
MONITOR 10-17
MORTHO 3-15
MPCCI 9-28
MULTISWEEP 5-29
MVGRID 11-5
N
NASTRAN 4-6
NFILE 5-1
NGEOM 2-11
NMODEL 12-11
NOX 15-21
NOXC 15-22
NPLOT 18-3
NRANGE 4-6
NUMBER 5-30
NUMREG 17-2
NWALL 7-29
Version 3.26
Index
O
OFFSET 4-7
OFILE 2-12
OPANEL 2-4
OPERATE 16-18
OVERLAY 5-30
P
PAGE 2-4
PAN 5-7
PANALYSIS 10-17
PARTICLE 16-33
PATCH 3-6
PATRAN 4-7
PCROSS 16-31
PDELETE 7-2
PEMISSIVITY 12-16
PGENERATE 7-2
PLARROW 5-30
PLATTACH 14-20
PLAYBACK 18-3
PLDISPLAY 5-31
PLFACE 5-32
PLFIX 5-32
PLIST 16-1
PLLABEL 5-32
PLLOCALCOOR 5-33
PLMESH 5-33
PLOT 2-9
PLRECALL 5-34
PLSAVE 5-34
PLTBACK 5-7
PLTYPE 5-34
PMAP 16-28
PMATERIAL 7-3
POLENTHALPY 7-10
POLSCALAR 7-20
POLYNOMIAL 15-11
POPCP 7-10
POPD 7-12
POPK 7-14
POPLV 7-15
POPTION 5-44
PORDELETE 7-16
POREFF 7-17
PORLIST 7-17
POROSITY 7-17
PORTURBULENCE 7-19
Version 3.26
POSCP 8-4
POSD 8-5
POSK 8-7
POSLV 8-8
POST 2-9
POWALL 10-17
PPDF 15-12
PRCHECK 10-18
PRESSURE 7-29
PRFIELD 10-19
PRINT 16-31
PROBLEMWRITE 2-12
PROMPT 5-35
PROPERTIES 2-9
PRPOST 11-6
PRTEMP 10-19
PRWALL 10-19
PSCREATE 5-35
PSDELETE 5-36
PSTAR 4-12
PSYS 16-28
PTCONVERT 4-12
PTOPTION 16-35
PTPLOT 16-35
PTPRINT 16-37
PTRACK 16-37
PTREAD 16-38
PTSYMM 16-39
PTVERTS 16-39
Q
QDRAW 5-36
QUIT 2-4
R
RADC 2-9
RADIATION 10-5
RADPROPERTIES 7-7
RANGE 6-7
RCALCULATE 17-14
RCHECK 9-12
RCLEAR 17-15
RCLIP 17-15
RCOMPRESS 9-12
RCONSTANT 10-6
RDATA 10-6
RDEFINE 9-13
RDELETE 9-21
7
Index
RDPR 4-13
REACTION 15-6
RECALL 2-5
RECOVER 2-12
RECRD 18-4
REEXTRUDE 3-8
REFLUX 10-7
REFRAME 16-31
REGLIST 17-10
REHT 15-4
RELAX 10-7
RENDEROPT 5-36
REPLOT 5-8
REPROJECT 3-22
RESDATA 10-20
RESET 5-1
RESIDUAL 10-8
RESTRUCTURE 3-5
RESUME 2-13
REWIND 2-13
RGENERATE 9-21
RINLET 9-21
RLABEL 17-11
RLIST 9-22
RMODIFY 9-22
RNAME 9-22
ROPERATE 17-16
ROTATE 5-37
RPnnnn 2-28
RRATE 15-7
RSGENERATE 9-24
RSLIST 9-24
RSMODIFY 9-24
RSORT 17-17
RSOURCE 7-7
RSTATUS 15-8
RTABLE 17-11
RTLIST 17-11
RTPRESSURE 9-23
RTURBULENCE 9-23
RUNTIME 11-7
S
SAFETY 2-5
SAVE 2-13
SAVUSERDATA 16-14
SBREACTION 15-4
SC 8-1
8
SCALAR 2-10
SCCGENERATE 10-13
SCCLIST 10-13
SCCMODIFY 10-14
SCCONTROL 10-14
SCDELETE 8-2
SCDUMP 5-2
SCENE 5-44
SCGENERATE 8-3
SCHECK 20-10
SCLIST 8-3
SCLOCATE 6-8
SCMODIFY 8-3
SCPLIST 7-20
SCPOROUS 7-19
SCPROPERTIES 7-21
SCRDELETE 5-8
SCRIN 5-8
SCROUT 5-9
SCSOURCE 7-21
SCTRANS 11-8
SDATA 17-10
SECMOVE 5-37
SECSCALE 5-38
SENSOR 6-8
SETADD 5-20
SETDELETE 6-9
SETENV 2-5
SETFEATURE 2-6
SETREAD 6-10
SETWRITE 6-10
SHREFINE 3-74
SHRINK 5-38
SHTRA 7-30
SIZE 2-6
SMAP 6-10
SMCONVERT 4-13
SMO3 20-11
SNORMAL 5-39
SOLAR 10-8
SOLUFORM 10-9
SOLVE 10-9
SOOT 15-22
SORT 16-29
SPCHECK 3-42
SPCOMPRESS 3-42
SPECIFICHEAT 7-8
SPIN 7-30
SPL 3-42
Version 3.26
Index
SPLCROSS 3-43
SPLDELETE 3-44
SPLGENERATE 3-44
SPLLIST 3-45
SPLMODIFY 3-45
SPLOT 5-9
SPLREAD 3-46
SPLSET 5-20
SPLUNDELETE 3-46
SPLWRITE 3-47
SPOINT 5-39
SPRINT 16-32
SPVCOMPRESS 3-47
SRCLIST 7-9
SRFDELETE 6-11
SRFREAD 6-11
SRFWRITE 6-11
STABLE 3-47
STATUS 2-6, 3-5, 4-1, 5-2, 6-12, 7-3, 8-1,
11-8, 12-4, 13-4, 14-1, 15-1, 16-1, 17-2,
18-4, 19-24, 20-12, 21-1
STDELETE 3-48
STENSION 10-24
STL 4-10
STLIST 3-48
STORE 16-14
STPA 12-4
STYPE 3-48
SUBTITLE 16-1
SUMMARISE 16-32
SURFACE 5-40
SWEEP 10-11
SWIRLBLEND 10-11
SWITCHES 10-11
SYMLIST 17-13
SYMTYPE 17-13
SYSTEM 2-6
T
TABLE 6-12
TBCLEAR 6-18
TBDEFINE 6-18
TBGRAPH 17-26
TBIN 15-13
TBLIST 6-19
TBMODIFY 6-19
TBREAD 6-19
TBSCAN 6-23
Version 3.26
TBWRITE 6-23
TDATUM 7-31
TDSCHEME 11-8
TECPLOT 4-7
TEMPERATURE 7-31
TERMINAL 5-2
TETALIGN 3-75
TETGENERATE 3-75
TETREFINE 3-77
TEXT 2-6
TFILL 6-12
TFIND 6-14
TGENERATE 6-14
TGRID 4-8
THERMDIF 7-31
THIN 5-44
TICMARK 5-40
TIME 10-12
TITLE 2-6
TLIST 6-14
TLMODEL 7-32
TLSWITCH 7-32
TMAP 6-14
TMODIFY 6-15
TMSTAMP 18-4
TNORM 10-12
TPHL 12-4
TPLOT 5-9
TPRINT 2-7
TRANSIENT 2-10
TREAD 6-15
TRELATION 11-8
TRFILE 11-9
TRINTERPOLATE 16-32
TRLOAD 16-15
TRUNCATE 16-15
TSCALE 5-3
TSMAP 6-16
TSMULT 6-16
TSTAR 4-13
TUGL 7-32
TURBULENCE 7-33
TUSSG 7-35
TVMULT 6-17
TWOIGNITION 15-16
TWOLAYER 7-36
TWRITE 6-17
9
Index
U
UGRID 5-45
ULOAD 16-16
UNITS 16-29
UNSKEW 3-23
UNWARP 3-24
UPDATE 16-29
USER 2-7
USUBROUTINE 6-17
UTILITIES 2-10
V
V 3-24
VADJANGLE 3-25
VAPORIZATION 10-25
VARIABLE 2-7
VAVERAGE 16-29
VBOUNDARY 3-25
VC2DGEN 3-15
VC3DGEN 3-16
VCELL 3-26
VCENTER 3-26
VCEXTRUDE 3-9
VCOMPRESS 3-27
VCROSS 3-27
VDA 4-11
VDELETE 3-27
VDISTANCE 6-18
VELLIPTIC 3-28
VEQUAL 3-28
VESCALE 5-45
VFCALC 21-1
VFILL 3-29
VGAP 3-30
VGENERATE 3-30
VIEW 5-40
VINTERSECT 3-31
VLIST 3-32
VLOCAL 3-21
VMAP 3-32
VMERGE 3-33
VMODIFY 3-33
VMOVE 3-34
VOLUME 6-18
VPCREATE 3-34
VPLOT 5-9
VPROJECT 3-35
VREAD 3-36
10
VREFLECT 3-37
VRENUMBER 3-37
VREPLACE 3-38
VRML 4-8
VSCALE 3-38
VSECTION 3-39
VSET 5-21
VSMOOTH 3-40
VSPCROSS 3-48
VSPDEFINE 3-49
VSPFILL 3-49
VSPGENERATE 3-50
VSPLIST 3-51
VSPMOVE 3-51
VSPPROJECT 3-52
VSTYLE 5-41
VTRANS 3-40
VUNDO 3-41
VVERTEX 3-41
VWRITE 3-41
W
WALLFUNCTION 7-36
WDATA 10-12
WHEATTR 10-25
WHOLE 5-9
WINDOW 5-41
WIPEOUT 2-7
WPLOT 5-10
WPOST 11-9
WPRINT 11-9
WRPOST 11-10
Z
ZOOM 5-10
Version 3.26

pro-STAR COMMANDS

Transcription

Similar documents

Learn how to make your own .svg files and cut

iCEcube2 Tutorial - Lattice Semiconductor

EurekaWeb - Eureka Support

Billet Tech Catch Can 3.6L Pentastar Installation

Wrist corsage tutorial

DIJKSTRA`S ALGORITHM

Chapter 29 Model and Paper Space Layouts

Open GL part 1