Encyclopaedia Index

PHOENICS Scripts (i.e. Batch Files)

Contents

• Scripts for running executables
  • The PHOENICS Commander
  • The PHOENICS Environment modules
  • The SATELLITE module, including VR
  • The EARTH (solver) and PHOTON (display) modules
  • Modules run in sequence
  • The utility modules
• Scripts for compiling source code
• Scripts for building executables

The scripts listed in the tables below are supplied with the PHOENICS installation.

They can be used from:

• a Command Prompt under MS Windows 2000/XP/Vista (Visual Fortran only),

provided that the path has been set by issue of the command: /phoenics/d_utils/phoepath.bat, or an equivalent setting.

The command names for UNIX and LINUX installations are the same as those for windows.

The scripts are classified as PHOENICS Utilities, and are to be found in \phoenics\d_utils\d_windf.

Scripts for running executables

SATELLITE

The satellite executable can be run in several modes, namely:

• silent, i.e. non-interactive, which implies that the Q1 file is read, and the EARDAT and other SATELLITE-generated files are written, without interaction with the user;
• text-interaction, of the kind familiar to users of pre-menu and pre-VR versions of PHOENICS, with PIL as the communication language;
• old-menu, which is still useful for accessing the early grid-generation and other facilities;
• new-menu, which is convenient to those users who do not wish to learn or use PIL;
• VR-Editor, for those who wish to visualise the flow-simulation problem which they are setting up; and
• VR-Viewer, for those who wish to proceed directly to the visual inspection of the results of an already-conducted simulation.

It is possible to proceed from the text and menu modes to the VR modes, but only with certain limitations from the latter to text mode.

The command sat followed by the appropriate one of the following parameters:
f, t, m1, m2, vre or vrv

suffices to launch the executable in the selected mode.

For the convenience of users, however, mode-specific commands are also provided.

The commands beginning run have been retained because users of earlier versions of PHOENICS may have become used to them.

Command	What executable is or  does
sat	SATELLITE input module I
sil	SATELLITE: silent I
txt	SATELLITE: text-interactive I
sm1	SATELLITE:pre-VR menu I
sm2	SATELLITE: latest menu I
vre	VR Editor
vrv	VR Viewer
runpvr	same as vre
runsat	same as sat
runvre	same as vre
runvrv	same as vrv

Table 3 : The EARTH (solver) and PHOTON (display) modules

aut	AUTOPLOT display module
ear	public EARTH solver module
earpri	private (local) EARTH solver module
pho	PHOTON display module
runaut	same as aut
runear	same as ear
runpho	same as pho
runpri	same as earpri

Table 4: Actions in sequence

WINDF command	What executable is or  does
dem	"active demonstrations" I
lib #	SATELLITE, EARTH & PHOTON for library case #
rundem	same as dem
runlib #	same as lib

Table 5: The utility modules

WINDF command	What executable is or  does
frust	Fortran program creates cone-frustrum segments for VR
plntmen	Menu program for PLANT
runcmpr	executable to compress or decompress a phi file
runfil	executable to "fillet" a phi file
runpin	PINTO, the interpolation program
runshap	Interactive ShapeMaker module

Table 6: Scripts to build executables

WINDF command	What it does
bldear	builds EARTH executable
bldfrust	compiles frustrum.htm and builds frustrum executable
bldsat	builds SATELLITE executable
bldsatx	builds text-only SATELLITE

Table 8: Scripts valid for all

command	What it does
modq1	saves Q1 as Q1.SAV and creates a model (empty, talk=t) Q1

Table 7: Compilation scripts

WINDF command	What it does
compile	compiles a Fortran file

Information items

bldear

builds a solver-module executable, earexe.exe, in the local directory (also called a "private earth").

It uses whatever main.for and ground.for (or main.htm or ground.htm) files exist in the local directory.

If one of these files does not exist, the "public" version of it is copied from /phoenics/d_earth.

bldsat

builds a SATELLITE executable, satexe.exe, in the local directory (also called a "private SATELLITE").

It uses whatever satlit.for (or satlit.htm) file exists in the local directory.

If no such file exists, the "public" version of it is copied from /phoenics/d_satell.

The WinDF cmprs executable resides in \phoenics\d_utils\d_windf\d_exes.

The WinDF fillet executable resides in \phoenics\d_utils\d_windf\d_exes

Frustrum is a Fortran program, provided as an example of how VR-objects can be created.

The PLANT menu program is a stand-alone executable, residing in \phoenics\d_satell

It makes use of three ASCII files, residing in the same directory, namely: plntsttm, plntlist and plnthelp

The "active-demo" scripts SATELLITE, EARTH and PHOTON in sequence. They make use of the batch file waitakey.bat in \phoenics\d_utils.

RUNSAT

is a command which may be followed by arguments, with various consequences, as follows:

argument

consequence

none

whatever is implied by the top line of Q1, i.e.TALK = F or T, and whatever PIL commands then follow

F

reads Q1 (and Q2 if present), writes EARDAT (and XYZ and FACETDAT when required by commands in PIL); then quits, leaving the Q1 file unchanged.

T

reads Q1 (& Q2), then opens a text-mode interactive session.

M2

reads Q1 (& Q2), then opens new-style menu session.

TM

reads Q1 (& Q2), then opens old-style menu session.

VRE

reads Q1 (& Q2), then opens VR-Editor session.

VRV

reads Q1 (& Q2), then opens VR-Viewer session.

PC

(for Digital version only) opens PC Commander session

runvre

has the same effect as runsat vre

runvrv

has the same effect as runsat vrv