Manual for Scripts

Steven M. Nash, Stuart E. Rogers, Darby J. Vicker, Alan Schwing, Henry Lee

Contents

• Introduction
• Philosophy
• Structure
• Description of the Tools
• Method of Operation
• To Customize for Your Problem
• Input Variables
  • Grid Generation
  • PEGASUS Inputs
  • OVERFLOW Inputs
    • XRINFO
    • Config.xml
    • Scenario.xml
  • MIXSUR Inputs
• Misc. Info

Introduction

Philosophy

• The user can enter the script system from two starting points.

  (1) For surface grids with complex topologies, most grids need to be custom made and are difficult to automate their creation. In such cases, the user provides a script or program that will generate the surface grid and OVERFLOW input file for each grid. Work is being conducted to try and automate this step, but in the meantime there are tools available to assist the user with this step (e.g. see the scripts example).

  (2) A complex configuration may also be decomposed into a larger number of surface grids with simple topologies (e.g. free floating or constant plane at the boundaries). Such systems may be created from a user interface such as OVERGRID or from a single run of a hyperbolic/TFI grid generator such as SURGRD. In these cases, the user enters the script system with a surface grid file in PLOT3D multiple grid format. The PreVol script is run which automatically determines the surface topology (assuming all solid walls are located at L=1) and generates the OVERFLOW input files, config.tcl and inputs.tcl files. The user has the option to further edit these files if special inputs are needed beyond the defaults.

• All grids, and inputs provided by the user conform to the naming convention adopted by this system. See the Naming Convention

• The user must have Chimera Grid Tools compiled and installed. You will not need OVERGRID (except if you want to use it to create the scripts for surface grid generation), but you will need to have the Tcl/Tk shells installed (which are also necessary for installing OVERGRID).

• Set the environment variable SCRIPTLIB to point at the chimera/scriptlib directory in order to have seamless access to the library of Tcl routines included with CGT. The easiest way to do this is to add the following to your .cshrc file if you are using C-Shell:

  setenv SCRIPTLIB $HOME/chimera/scriptlib

  where the above path matches the location of your chimera directory. Use "echo $SCRIPTLIB" to test for the correct assignment. This is necessary for seamless access to the library of routines in this directory.

• Set your path to include the chimera/bin directory. Again, using C-Shell, this might look like:

  set path = ( $path $HOME/chimera/bin )

  in your .cshrc file. Use "which BuildSurf" to verify your path is correct. This allows access to the executable scripts in this directory.

Structure

For starting option (1), a number of subdirectories can exist where each subdirectory should contain a Makefile that defines the process for creating one or more surface grid files, and an accompanying boundary condition file. This process maybe nothing more than reformatting an input grid, or it might be a complex script system which generates the surface grids using the tools found in the Chimera Grid Tools package. For each grid, a rootname is used to identify the grid, and filenames for that grid consist of the rootname followed by a suffix that defines the contents of the file. See the Naming Convention for definitions of the file suffixes. More than one component or grid can reside in any subdirectory, as long as there is a rule in the Makefile for creating all the necessary surface grids and boundary condition files.

Optionally, a file called localinputs.tcl may be created in one or more of the subdirectories containing the individual components. These files should contain volume-grid inputs for the grids that are local to that the subdirectory.

For starting option (2), just one subdirectory is needed which should contain the surface grid file. Since this option usually involves a larger number of grids that are similar in topology, the root names are automatically generated by the PreVol script. Note that PreVol assumes that all solid walls are located at L=1.

The boundary condition file is merely the set of NAMELISTS for an OVERFLOW input file that are associated with one grid. Each grid must have its own boundary condition input file; these input files are identified with the file suffix of .ovfi. In addition to the standard OVERFLOW NAMELISTs for a grid, the .ovfi file should contain a comment line which defines the family name for each boundary surface that covers a wall, if the particular grid contains a wall. For starting option (1), the user-provided surface grid creation scripts should generate the .ovfi files. For starting option (2), these files are automatically created by PreVol.

Naming Convention

The following suffix convention is then used for each grid:

          .fmt    initial surface grid in a formatted file type
          .def    surface grid definition from CAD or other data
          .srf    surface grid in final form
          .vol    volume grid
          .hypi   HYPGEN input file
          .ovfi   OVERFLOW input file
          .legi   LEGRID input file
          .pwk    surface grid with a wake cut added on
          .com    PLOT3D command file
          .tcl    Tcl language scripts or input files
          .mvlog  Log file from makevol (for diagnostics)
          .bvinp  history file to record parameter settings.  Used
                  when re-running BuildVol to see if a grid needs updating.

The scripts in chimera/bin are named such that all scripts beginning with a capital letter are meant for use in this configuraton building procedure, whereas there are other miscellaneous scripts (e.g. makevol, intersect, etc.) that will probably not be accessed directly by the user at this level.

Description of the Tools

• BuildMixsuri creates the MIXSUR/OVERINT input file for the composite system defined by config.tcl. Reads the OVERFLOW input files for each grid, using their Family definitions for segregating surfaces. It accepts some command-line inputs to specify reference information.
• BuildOveri creates the OVERFLOW input file by concatenating all the component OVERFLOW input files.
• BuildPegi creates the PEGSUS version 4.1 input template for the composite system defined by config.tcl. This file contains the $MESH definitions with a guess at the link lists by using bounding box information, and also includes the outer-boundary definitions by reading the OVERFLOW input files. The user still is required to provide the hole cutting definitions.
• BuildPeg5i creates the PEGASUS version 5 input file for the composite system defined by config.tcl. This file should be complete for the PEGASUS 5 program. Modifications by the user may be required for fine-tuning the inputs for the automated hole-cutting procedures in PEGASUS 5.
• BuildProgrdi creates the PROGRD input file using the OVERFLOW input files, and uses their Family definitions for segregating surfaces. This program projects grids that overlap on a solid wall, and eliminates ORPHANS encountered with PEGSUS 4.1 hole cuts in these regions.
• BuildIngrid creates the PEGSUS/PEGASUS INGRID input file from the volume grids defined in config.tcl. Used by RunPeg
• BuildPlot creates a PLOT3D command file to visualize the composite grid system defined by config.tcl to show various things like Family groupings, boundary condition assignments, etc.
• BuildSurf executes the Makefile for all component grids to update the surface grid and OVERFLOW input file for each grid defined in config.tcl.
• BuildVol creates the volume grid for all component grids defined in config.tcl by either: running makevol with the parameters defined in inputs.tcl and/or localinputs.tcl, or running BOXGR to create a cartesian box grid around the grids defined in inputs.tcl and/or localinputs.tcl.
• makevol creates a single volume grid given the surface grid and OVERFLOW input file. Accepts various command-line flags to control the grid generator used (HYPGEN or LEGRID); the inputs controlling how the volume grid generator runs; and if and how smoothing is performed by SMOGRD.
• PreVol creates OVERFLOW input files, config.tcl and inputs.tcl automatically from a given PLOT3D multiple surface grid file.
• RunPeg runs PEGSUS 4.1 using input file(s) provided by the user (see BuildPegi). See the output from RunPeg -help for the options available. This script will automatically call BuildIngrid,progrd, and pegsus41.
• ScriptClean will clean up all the directories defined in config.tcl by removing output files for each rootname in config.tcl, using the suffix convention defined above (see Naming Convention).

Method of Operation

1. BuildSurf or PreVol

2. BuildVol

3. BuildProgrdi

4. BuildMixsuri

5. BuildOveri

6. BuildPegi and RunPeg (for PEGSUS 4.1)

7. BuildPeg5i (for PEGASUS 5.1)

Once these steps are completed, the user can run the PEGASUS 5 software, and its utilitiy PEG_PLOT to generate the final grid system. If, instead, PEGSUS 4.1 is being used, the user can start PEGSUS/PEGASUS via RunPeg. See the output from 'RunPeg -help' for the options available for using this script. PEGSUS 4.1 requires that significantly more input is added to its input file in order to perform the hole cutting operations. After successful completion, there will exist a grid.in, XINTOUT, and OVERFLOW input files. The user may want to first run MIXSUR (using the above-mentioned mixsur.i), and then can start the OVERFLOW run. This is meant as just a brief overview of how these tools can be run, and how a user might best go about utilizing some of the tools in CGT.

To Customize for Your Problem

For starting option (1):
1. Set up a directory structure that best represents your configuration. There is no limitation regarding how many grids per directory.
2. Provide a script or program that can be executed in batch to create the surface grid and OVERFLOW input file for each grid. Create a Makefile in each directory that will update define the rules for creating the surface grids.
3. Create a config.tcl that defines the rootnames for each grid. The order of the rootnames will be used throughout the process whenever grids are combined into a multiple grid file (e.g. grid.in).
4. Create an inputs.tcl that defines the rules for volume grid generation via HYPGEN/LEGRID/BOXGR, and any phantom grid specifications. You can just use default rules, or if you need to override the default for specific grids, that can also be specified in the inputs.tcl file.
5. Optionally create localinputs.tcl files in one or more subdirectories, these can contain the same volume-grid inputs specefied in the main inputs.tcl.
6. Run BuildSurf.
7. Use BuildVol, BuildProgrdi, BuildOveri, BuildPeg5i (or BuildPegi and RunPeg if using PEGSUS 4.1) to proceed through the analysis.

For starting option (2):
1. Put the multiple surface grid file in a directory.
2. Run PreVol.
3. Use BuildVol, BuildProgrdi, BuildOveri, BuildPeg5i (or BuildPegi and RunPeg if using PEGSUS 4.1) to proceed through the analysis.

Input Variables in inputs.tcl

Grid Generation Inputs

set default(xxxx) "value1 [value2 ... valueN]"

set MESH(xxxx) "value1 [value2 ... valueN]"

The first form changes the default value of the parameter which will be used by all grids. The second form is used by substituting the word MESH with the root name of the individual grid for which the parameter is to be changed.

Parameter	Description	Default Value
set MESH(zreg) z	Wall-spacing used in volume grid generation.	0.5
set MESH(izstrt) i	HYPGEN input variable izstr: selects stretching, 1 for exponential, 2 for hyperbolic	2
set MESH(npzreg) n	HYPGEN input variable npzreg: number of points in l-direction	49
set MESH(dz0) z	HYPGEN input variable dz0: initial spacing	0.001
set MESH(dz1) z	HYPGEN input variable dz1: final spacing	0.1
set MESH(geomuni) 1	Option causing BuildVol to create HYPGEN input with 2 layers of normal-spacing control. The first layer uses geometric spacing control using stretching ratio of MESH(srmax), wall spacing of MESH(dz0), and final spacing of MESH(dz1). The second layer uses constant spacing of MESH(dz1) to grow the mesh to the total marching distance of MESH(zreg).	none
set MESH(ibcja) i	HYPGEN input variable ibcja: boundary condition for j=1	-1
set MESH(ibcjb) i	HYPGEN input variable ibcjb: boundary condition for j=jmax	-1
set MESH(ibcka) i	HYPGEN input variable ibcka: boundary condition for k=1	-1
set MESH(ibckb) i	HYPGEN input variable ibckb: boundary condition for k=kmax	-1
set MESH(imeth) i	HYPGEN input variable imeth: selects dissipation method	2
set MESH(smu2) s	HYPGEN input variable smu2: second-order dissipation coefficient	1.0
set MESH(itsvol) i	HYPGEN input variable itsvol: number of times volumes are averaged	100
set MESH(timj) tj	HYPGEN input variable timj: Barth implicitness factor for j	0.0
set MESH(timk) tk	HYPGEN input variable timk: Barth implicitness factor for k	0.0
set MESH(iaxis) i	HYPGEN input variable iaxis: controls treatment of singular axis BC	1
set MESH(exaxis) e	HYPGEN input variable exaxis: controls treatment of singular axis BC	0.1
set MESH(volres) v	HYPGEN input variable volres: controls treatment of singular axis BC	0.4
set MESH(nsub) n	HYPGEN input variable nsub: controls number of sub-steps used to march one step	1
set MESH(srmax) s	uses srmax as a maximum stretching ratio to determine the number of points required for NPZREG	none
set MESH(legrid) 1	Causes BuildVol to use LEGRID instead of HYPGEN to generate volume grid	0
set MESH(rey) r	LEGRID input variable rey: used to determine initial spacing	none
set MESH(chord) c	LEGRID input variable chord: used to determine initial spacing	1.0
set MESH(xref) x	LEGRID input variable xref: used to determine initial spacing	0.1
set MESH(yplus) y	LEGRID input variable yplus: used to determine initial spacing	1.0
set MESH(kblayer) k	LEGRID input variable kblayer: used to control initial spacing	3
set MESH(nsweep) n	LEGRID input variable nsweep	2
set MESH(npci) n	LEGRID input variable npci	10
set MESH(naver) n	LEGRID input variable naver	5
set MESH(omega) x	LEGRID input variable omega	1.6
set MESH(legridbc) n	LEGRID input variable legridbc	0
set MESH(kfreez) n	LEGRID input variable kfreez	0
set MESH(iglob) n	LEGRID input variable iglob	2
set MESH(smogrdargs) ARGS	Used to pass ARGS as command-line parameters to the program SMOGRD
set MESH(adddummy) "iadja iadjb iadka iadkb iadla iadlb"	Specifies number of dummy grid planes to add to j=1, j=jmax, k=1, k=kmax, l=1, l=lmax faces before performing smoothing with SMOGRD; dummy planes are removed after smoothing	0 0 0 0 0 0
set MESH(hypinargs) ARGS	ARGS is a string composed of flags to be passed to the HYPIN program. The following parameters are allowed: -zmax ZMAX (this is the only one that's required); -wallsp WALLSP; -z1 Z1; -z2 Z2; -dz2 DZ2; -srmax SRMAX;	-zmax 0.5
set MESH(nosmogrd) 1	Overrides the default behavior of running SMOGRD for regions which do not have wall boundary conditions at L=1	0
set MESH(smogrd) 1	Runs SMOGRD to smooth and enlarge wall-spacing cells in regions which are detected to have no wall-type boundary conditions at the L=1 surface; this is the default behavior	1
set MESH(nobccheck) 1	Overrides the default of checking the OVERFLOW input file for info about running HYPGEN and/or SMOGRD.	0
set MESH(phantom) 1	Setting this to 1 designates this mesh as a phantom mesh, which is to be used only for hole-cutting in PEGSUS, and it will not appear in the final grid system	0
set MESH(box) "file1 file2 ..."	Designates MESH as a box mesh, to be generated by the program BOXGR, and to be sized to surround the grids contained in the files file1, file2, etc	none
set MESH(imode) m set MESH(mlevel) m set MESH(npmax) npmax set MESH(nfringe) nfringe set MESH(spdir) spdir set MESH(xmin) xmin set MESH(xmax) xmax set MESH(ymin) ymin set MESH(ymax) ymax set MESH(zmin) zmin set MESH(zmax) zmax set MESH(boxdx) dx set MESH(boxdy) dy set MESH(boxdz) dz set MESH(iopt) i set MESH(istr) i set MESH(dolja) j set MESH(dolka) k set MESH(dolla) l set MESH(doljb) j set MESH(dolkb) k set MESH(dollb) l set MESH(smaxja) smax set MESH(smaxjb) smax set MESH(smaxka) smax set MESH(smaxkb) smax set MESH(smaxla) smax set MESH(smaxlb) smax set MESH(srmax) smax	For box meshes, these are inputs to be passed to the program BOXGR.
set MESH(auto_space)	For box meshes, this causes BOXGR to compute the boxdx, boxdy, and boxdz input spacings automatically. Must specify MESH(jch,kch,lch).
set MESH(jch) set MESH(kch) set MESH(lch)	For box meshes, when set MESH(auto_space) is used, these are the inputs passed to BOXGR to compute the boxdx, boxdy, and boxdz input spacings automatically.
set MESH(xray) n	For box meshes, this will command BuildVol to generate an xray for the mesh. The xray will be created as a box 'n' grid points in from the I, J, and K min/max sides. Increasing the value of 'n' will reduce the size of the xray and allow for more overlap in neigboring grids.	unset
set MESH(xray,ds) ds	For box meshes when MESH(xray) is set, this overrides the default value of ds used in xray generation. The default ds is determined at run time in order to put a minumum of 50 points across the xray in the X and Y directions.	see text
set MESH(xray,delta) delta	For box meshes when MESH(xray) is set, this overrides the default value of delta used in xray generation.	0.0
set MESH(command) "exec command1; exec command2; ... "	The user-defined shell commands command1, command2... will be executed by BuildVol to generate the volume grid for zone MESH, instead of using the built-in makevol script. If you define the entries for Ovr(MESH,ibtyp), Ovr(MESH,ibdir), Ovr(MESH,jbcs), Ovr(MESH,jbce), Ovr(MESH,kbcs), Ovr(MESH,kbce), Ovr(MESH,lbcs), and Ovr(MESH,lbce) in inputs.tcl, then this forces BuildVol to write the MESH.ovfi file.	none
set MESH(post) "exec command1; exec command2; ... "	The user-defined shell commands command1, command2... will be executed by BuildVol after the volume grid for zone MESH is created. Volume grid generation for zone MESH will use the built-in makevol script prior to running the command(s). Its original utility was to allow for generation of xray files based on volumes.	none
set MESH(nomakevol) 1	Designates that BuildVol does not need to build the volume grid for MESH	none

PEGASUS Inputs

Parameter	Description	Default Value
set GLOBAL(angle) num	Used by BuildPeg5i to specify the ANGLE input variable in the GLOBAL namelist. Specify an angle in degrees.	0
set GLOBAL(cartx) "xmin xmax" set GLOBAL(carty) "ymin ymax" set GLOBAL(cartz) "zmin zmax"	Used by BuildPeg5i to specify min and max x-values for CARTX, CARTY, and CARTZ variables in the GLOBAL namelist. Specify two real numbers surrounded by double quotes.	None
set GLOBAL(cnx) num set GLOBAL(cny) num set GLOBAL(cnz) num	Used by BuildPeg5i to specify the CNX, CNY, and CNZ variables in the GLOBAL namelist. Specify one integer.	512
set GLOBAL(center) logical	Used by BuildPeg5i to specify the CENTER variable in the GLOBAL namelist. Specify true or false.	.F.
set GLOBAL(distance) "int"	Used by BuildPeg5i to specify DISTANCE variable in the GLOBAL namelist. Specify one integer.	20
set GLOBAL(eps) "real"	Used by BuildPeg5i to specify EPS variable in the GLOBAL namelist. Specify one real number.	0.001
set GLOBAL(fixxsym) num	Used by BuildPeg5i to specify the FIXXSYM input variable in the GLOBAL namelist.	.FALSE.
set GLOBAL(fixysym) num	Used by BuildPeg5i to specify the FIXYSYM input variable in the GLOBAL namelist.	.FALSE.
set GLOBAL(fixzsym) num	Used by BuildPeg5i to specify the FIXZSYM input variable in the GLOBAL namelist.	.FALSE.
set GLOBAL(fringe) num	Used by BuildPeg5i to specify the FRINGE input variable in the GLOBAL namelist. Should be 1 or 2.	2
set GLOBAL(hbfrng) num	Used by BuildPeg5i to specify the HBFRNG input variable in the GLOBAL namelist. Should be 1 or 2.	Value of FRINGE
set GLOBAL(hcut) num	Used by BuildPeg5i to specify the HCUT input variable in the GLOBAL namelist.	.TRUE.
set GLOBAL(level2) num	Used by BuildPeg5i to specify the LEVEL2 input variable in the GLOBAL namelist.	.TRUE.
set GLOBAL(l2x) num	Used by BuildPeg5i to specify the L2X input variable in the GLOBAL namelist. Specify an integer.	0
set GLOBAL(obfrng) num	Used by BuildPeg5i to specify the OBFRNG input variable in the GLOBAL namelist. Should be 1 or 2.	Value of FRINGE
set GLOBAL(offset) num	Used by BuildPeg5i to specify the OFFSET input variable in the GLOBAL namelist. Typically num should be 0 or 1.	0
set GLOBAL(orphfix) num	Used by BuildPeg5i to specify the ORPHFIX input variable in the GLOBAL namelist.	.TRUE.
set GLOBAL(outtype) num	Used by BuildPeg5i to specify the OUTTYPE input variable in the GLOBAL namelist.	1
set GLOBAL(project) num	Used by BuildPeg5i to specify the PROJECT input variable in the GLOBAL namelist.	.TRUE.
set GLOBAL(qcutoff) num	Used by BuildPeg5i to specify the QCUTOFF input variable in the GLOBAL namelist.	0.1
set GLOBAL(qtol) num	Used by BuildPeg5i to specify the QTOL input variable in the GLOBAL namelist.	0.01
set GLOBAL(shift) num	Used by BuildPeg5i to specify the SHIFT input variable in the GLOBAL namelist. Should be 1, 2, or 3.	3
set GLOBAL(xinclude) num set GLOBAL(yinclude) num set GLOBAL(zinclude) num	Used by BuildPeg5i to specify the XINCLUDE, YINCLUDE, and ZINCLUDE input variables in the GLOBAL namelist.	none
set CUTTER_CONTROL(autohct) num	Used by BuildPeg5i to specify the AUTOHCT input variable in the CUTTER_CONTROL namelist. Specify a positive integer.	1
set CUTTER_CONTROL(cartx) "xmin xmax" set CUTTER_CONTROL(carty) "ymin ymax" set CUTTER_CONTROL(cartz) "zmin zmax"	Used by BuildPeg5i to specify min and max values for CARTX, CARTY, and CARTZ variables in the CUTTER_CONTROL namelist. Specify two real numbers surrounded by double quotes.	None
set CUTTER_CONTROL(hcut) num	Used by BuildPeg5i to specify the HCUT input variable in the CUTTER_CONTROL namelist.	.TRUE.
set CUTTER_CONTROL(autohct) num	Used by BuildPeg5i to specify the AUTOHCT input variable in the CUTTER_CONTROL namelist.	1
set CUTTER_CONTROL(advcut) num	Used by BuildPeg5i to specify the ADVCUT input variable in the CUTTER_CONTROL namelist.	0
set CUTTER_CONTROL(exclude) num	Used by BuildPeg5i to specify the EXCLUDE input variable in the CUTTER_CONTROL namelist.	None
set CUTTER_CONTROL(cartx) num set CUTTER_CONTROL(carty) num set CUTTER_CONTROL(cartz) num	Used by BuildPeg5i to specify the CARTX, CARTY, and CARTZ variables in the CUTTER_CONTROL namelist.	.TRUE.
set CUTTER_CONTROL(cnx) num set CUTTER_CONTROL(cny) num set CUTTER_CONTROL(cnz) num	Used by BuildPeg5i to specify the CNX, CNY, and CNZ variables in the CUTTER_CONTROL namelist. Specify one integer.	512
set CUTTER_CONTROL(cutplval) num	Used by BuildPeg5i to specify the CUTPLVAL input array in the CUTTER_CONTROL namelist. Specify one or more real numbers surrounded by double quotes.	None
set CUTTER_CONTROL(cutpldir) num	Used by BuildPeg5i to specify the CUTPLDIR input array in the CUTTER_CONTROL namelist. Specify one or more integers surrounded by double quotes.	None
set CUTTER_CONTROL(xcuts) num set CUTTER_CONTROL(ycuts) num set CUTTER_CONTROL(zcuts) num	Used by BuildPeg5i to specify the XCUTS, YCUTS, and ZCUTS input variable in the CUTTER_CONTROL namelist.	None None None
set CUTTER_CONTROL(internal) num	Used by BuildPeg5i to specify the INTERNAL input variable in the CUTTER_CONTROL namelist.	.FALSE
set MESH(angle) num	Used by BuildPeg5i to specify the ANGLE input variable for MESH. Should be a real number.	30.0
set MESH(alpha) num set MESH(beta) num set MESH(gamma) num	Used by BuildPeg5i to specify the ALPHA, BETA, and GAMMA input variables for MESH. Specify angles in degrees.	0.0
set MESH(datasurf) .T.	Used by BuildPeg5i to specify the DATASURF input variable for MESH.	.F.
set MESH(distance) num	Used by BuildPeg5i to specify the DISTANCE input variable for MESH. Should be an integer.	20
set MESH(eps) num	Used by BuildPeg5i to specify the EPS input variable for MESH. Should be an integer.	0.001
set MESH(jinclude) "jbeg jend" set MESH(kinclude) "kbeg kend" set MESH(linclude) "lbeg lend"	Used by BuildPeg5i to specify the JINCLUDE, KINCLUDE, and LINCLUDE input variables for MESH. Specify two integers surrounded by double quotes.	None
set MESH(fringe) num	Used by BuildPeg5i to specify the FRINGE input variable for MESH. Should be 1 or 2.	2
set MESH(hbfrng) num	Used by BuildPeg5i to specify the HBFRNG input variable for MESH. Should be 1 or 2.	Value of FRINGE
set MESH(l2x) num	Used by BuildPeg5i to specify the L2X input variable for MESH.	Global namelist Value of L2X
set MESH(obfrng) num	Used by BuildPeg5i to specify the OBFRNG input variable for MESH. Should be 1 or 2.	Value of FRINGE
set MESH(offset) num	Used by BuildPeg5i to specify the OFFSET input variable for MESH.	0
set MESH(qcutoff) num	Used by BuildPeg5i to specify the QCUTOFF input variable for MESH.	0.1
set MESH(qtol) num	Used by BuildPeg5i to specify the QTOL input variable for MESH.	0.01
set MESH(project) num	Used by BuildPeg5i to specify the PROJECT input variable for MESH.	.TRUE.
set MESH(shift) num	Used by BuildPeg5i to specify the SHIFT input variable for MESH.	3
set MESH(xr) num set MESH(yr) num set MESH(zr) num	Used by BuildPeg5i to specify the XR, YR, and ZR input variables for the MESH namelist.	0.0, 0.0, 0.0
set MESH(xo) num set MESH(yo) num set MESH(zo) num	Used by BuildPeg5i to specify the XO, YO, and ZO input variables for the MESH namelist.	0.0, 0.0, 0.0
set MESH(xinclude) "xmin xmax" set MESH(yinclude) "ymin ymax" set MESH(zinclude) "zmin zmax"	Used by BuildPeg5i to specify the XINCLUDE, YINCLUDE, and ZINCLUDE input variables in the MESH namelist. Specify two real numbers surrounded by double quotes.	none
set MESH(link_list) "string1 [string2 ...]"	A space-separated list of strings used to limit the LINK lists created by BuildPegi; the LINK list for MESH contains only other grids whose name contains one of the strings	none
set MESH(XXX,fringe) num	Used by BuildPegi to specify fringe levels for a mesh. Typically num should be 1 or 2. XXX can be hole, ob, jmin, jmax, kmin, kmax, lmin, lmax. This changes the fringe level specified in the PEGSUS input files for hole boundaries, outer boundaries, or for the outer boundaries at the six different faces of the mesh, respectively.	2
set GROUP(name) "mygroup1 mygroup2 mygroup2..."	Used by BuildPeg5i to specify GROUP namelists input in the pegasus5 input file. Specify a list of one or more names, one for each GROUP namelist, surrounded by double quotes.	None
set GROUP(mygroup1,member) "mesh1 mesh2 ... "	Used by BuildPeg5i to specify MEMBER variable in GROUP namelist with NAME=mygroup1. Specify list of MESH names.	None
set AHCUT(name) "myahcut1 myahcut2 myahcut2..."	Used by BuildPeg5i to specify AHCUT namelists input in the pegasus5 input file. Specify a list of one or more names, one for each AHCUT namelist, surrounded by double quotes.	None
set AHCUT(myahcut1,nahcut) "num"	Used by BuildPeg5i to specify NAHCUT variable in AHCUT namelist with NAME=myahcut1. Specify an integer greater than 0.	None
set AHCUT(myahcut1,include) "mesh1 mesh2 ... "	Used by BuildPeg5i to specify INCLUDE variable in AHCUT namelist with NAME=myahcut1. Specify list of MESH names.	None
set AHCUT(myahcut1,exclude) "mesh1 mesh2 ... "	Used by BuildPeg5i to specify EXCLUDE variable in AHCUT namelist with NAME=myahcut1. Specify list of MESH names.	None
set AHCUT(myahcut1,member) "mesh1 mesh2 ... "	Used by BuildPeg5i to specify MEMBER variable in AHCUT namelist with NAME=myahcut1. Specify list of MESH names.	None
set AHCUT(myahcut1,member2) "mesh1 mesh2 ... "	Used by BuildPeg5i to specify MEMBER2 variable in AHCUT namelist with NAME=myahcut1. Specify list of MESH names.	None
set AHCUT(myahcut1,cartx) "xmin xmax"	Used by BuildPeg5i to specify min and max x-values for CARTX variable in AHCUT namelist with NAME=myahcut1. Specify two real numbers surrounded by double quotes.	None
set AHCUT(myahcut1,carty) "ymin ymax"	Used by BuildPeg5i to specify min and max y-values for CARTY variable in AHCUT namelist with NAME=myahcut1. Specify two real numbers surrounded by double quotes.	None
set AHCUT(myahcut1,cartz) "zmin zmax"	Used by BuildPeg5i to specify min and max z-values for CARTZ variable in AHCUT namelist with NAME=myahcut1. Specify two real numbers surrounded by double quotes.	None
set AHCUT(myahcut1,cnx) num	Used by BuildPeg5i to specify CNX variable in AHCUT namelist with NAME=myahcut1. Specify one integer.	None
set AHCUT(myahcut1,cny) num	Used by BuildPeg5i to specify CNY variable in AHCUT namelist with NAME=myahcut1. Specify one integer.	None
set AHCUT(myahcut1,cnz) num	Used by BuildPeg5i to specify CNZ variable in AHCUT namelist with NAME=myahcut1. Specify one integer.	None
set AHCUT(myahcut1,cornero) num	Used by BuildPeg5i to specify CORNERO variable in AHCUT namelist with NAME=myahcut1. Specify one integer.	None
set AHCUT(myahcut1,hoffset) num	Used by BuildPeg5i to specify HOFFSET variable in AHCUT namelist with NAME=myahcut1. Specify one integer.	None
set AHCUT(myahcut1,hoffstj) num	Used by BuildPeg5i to specify HOFFSTJ variable in AHCUT namelist with NAME=myahcut1. Specify one integer.	None
set AHCUT(myahcut1,hoffstk) num	Used by BuildPeg5i to specify HOFFSTK variable in AHCUT namelist with NAME=myahcut1. Specify one integer.	None
set AHCUT(myahcut1,hoffstl) num	Used by BuildPeg5i to specify HOFFSTL variable in AHCUT namelist with NAME=myahcut1. Specify one integer.	None
set AHCUT(myahcut1,internal) ".T. or .F."	Used by BuildPeg5i to specify an internal AHCUT. Specify .T. for true, .F. for false.	None
set AHCUT(myahcut1,advcut) num	Used by BuildPeg5i to specify ADVCUT variable in AHCUT namelist with NAME=myahcut1. Specify an integer.	None
set AHCUT(myahcut1,cutplval) num	Used by BuildPeg5i to specify the CUTPLVAL input array in the AHCUT namelist with NAME=myahcut1. Specify one or more real numbers surrounded by double quotes.	None
set AHCUT(myahcut1,cutpldir) num	Used by BuildPeg5i to specify the CUTPLDIR input array in the AHCUT namelist with NAME=myahcut1. Specify one or more integers surrounded by double quotes.	None
set AHCUT(myahcut1,xcuts) num set AHCUT(myahcut1,ycuts) num set AHCUT(myahcut1,zcuts) num	Used by BuildPeg5i to specify the XCUTS, YCUTS, and ZCUTS input variable in the AHCUT namelist with NAME=myahcut1.	None None None
set HCUT(name) "myhcut1 myhcut2 mhycut2..."	Used by BuildPeg5i to specify custom HCUT namelists input in the pegasus5 input file. Specify a list of names, one for each HCUT namelist, surrounded by double quotes.	None
set HCUT(myhcut1,include) "mesh1 mesh2 ... "	Used by BuildPeg5i to specify INCLUDE variable in HCUT namelist with NAME=myhcut1. Specify list of MESH names.	None
set HCUT(myhcut1,exclude) "mesh1 mesh2 ... "	Used by BuildPeg5i to specify EXCLUDE variable in HCUT namelist with NAME=myhcut1. Specify list of MESH names.	None
set HCUT(myhcut1,member) "mesh1 mesh2 ... "	Used by BuildPeg5i to specify MEMBER variable in HCUT namelist with NAME=myhcut1. Specify list of MESH names.	None
set HCUT(myhcut1,cartx) "xmin xmax"	Used by BuildPeg5i to specify min and max x-values for CARTX variable in HCUT namelist with NAME=myhcut1. Specify two real numbers surrounded by double quotes.	None
set HCUT(myhcut1,carty) "ymin ymax"	Used by BuildPeg5i to specify min and max y-values for CARTY variable in HCUT namelist with NAME=myhcut1. Specify two real numbers surrounded by double quotes.	None
set HCUT(myhcut1,cartz) "zmin zmax"	Used by BuildPeg5i to specify min and max z-values for CARTZ variable in HCUT namelist with NAME=myhcut1. Specify two real numbers surrounded by double quotes.	None
set HCUT(myhcut1,cnx) num	Used by BuildPeg5i to specify CNX variable in HCUT namelist with NAME=myhcut1. Specify one integer.	None
set HCUT(myhcut1,cny) num	Used by BuildPeg5i to specify CNY variable in HCUT namelist with NAME=myhcut1. Specify one integer.	None
set HCUT(myhcut1,cnz) num	Used by BuildPeg5i to specify CNZ variable in HCUT namelist with NAME=myhcut1. Specify one integer.	None
set HCUT(myhcut1,cornero) num	Used by BuildPeg5i to specify CORNERO variable in HCUT namelist with NAME=myhcut1. Specify one integer.	None
set HCUT(myhcut1,hoffset) num	Used by BuildPeg5i to specify HOFFSET variable in HCUT namelist with NAME=myhcut1. Specify one integer.	None
set HCUT(myhcut1,hoffstj) num	Used by BuildPeg5i to specify HOFFSTJ variable in HCUT namelist with NAME=myhcut1. Specify one integer.	None
set HCUT(myhcut1,hoffstk) num	Used by BuildPeg5i to specify HOFFSTK variable in HCUT namelist with NAME=myhcut1. Specify one integer.	None
set HCUT(myhcut1,hoffstl) num	Used by BuildPeg5i to specify HOFFSTL variable in HCUT namelist with NAME=myhcut1. Specify one integer.	None
set HCUT(myhcut1,internal) ".T. or .F."	Used by BuildPeg5i to specify an internal HCUT. Specify .T. for true, .F. for false.	None
set BOUNDARY(name) "myboundary1 myboundary2 ..."	Used by BuildPeg5i to specify custom BOUNDARY namelists input in the pegasus5 input file. Specify a list of names, one for each BOUNDARY namelist, surrounded by double quotes.	None
set BOUNDARY(myboundary1,ispartof) "meshname"	Used by BuildPeg5i to specify the mesh name associated with the boundary with NAME=myboundary1.	None
set BOUNDARY(myboundary1,closed) ".T. or .F."	Used by BuildPeg5i to specify value for closed for the for the boundary with NAME=myboundary1.	None
set BOUNDARY(myboundary1,fast) ".T. or .F."	Used by BuildPeg5i to specify value for fast for the for the boundary with NAME=myboundary1.	None
set BOUNDARY(myboundary1,mholein) "mesh1 mesh2 ...."	Used by BuildPeg5i to specify the list of meshes which will be cut by the boundary with NAME=myboundary1.	None
set SURFACE(name) "mysurface1 mysurface2 ..."	Used by BuildPeg5i to specify custom SURFACE namelists input in the pegasus5 input file. Specify a list of names, one for each SURFACE namelist, surrounded by double quotes.	None
set SURFACE(mysurface1,ispartof) "boundary-name"	Used by BuildPeg5i to specify the name of the boundary associated with the surface with NAME=mysurface1.	None
set SURFACE(mysurface1,meshname) "mesh-name"	Used by BuildPeg5i to specify meshname associated with the surface with NAME=mysurface1.	None
set SURFACE(mysurface1,jrange) "jbeg jend"	Used by BuildPeg5i to specify the begin and end j-indices for the surface with NAME=mysurface1. Specify two integers.	None
set SURFACE(mysurface1,krange) "kbeg kend"	Used by BuildPeg5i to specify the begin and end k-indices for the surface with NAME=mysurface1. Specify two integers.	None
set SURFACE(mysurface1,lrange) "lbeg lend"	Used by BuildPeg5i to specify the begin and end l-indices for the surface with NAME=mysurface1. Specify two integers.	None
set SURFACE(mysurface1,nvout) "direction"	Used by BuildPeg5i to specify the outward-pointing surface normal for the surface with NAME=mysurface1. Specify one of '-J', '+J', '-K', '+K', '-L', '+L'.	None
set BOX(name) "mybox1 mybox2 mybox3 ..."	Used by BuildPeg5i to specify custom BOX namelists input in the pegasus5 input file. Specify a list of names, one for each BOX namelist, surrounded by double quotes.	None
set BOX(mybox1,ispartof) "boundary-name"	Used by BuildPeg5i to specify the name of the boundary associated with the box with NAME=mybox1.	None
set BOX(mybox1,xrange) "xmin xmax"	Used by BuildPeg5i to specify the min and max x coordinates for the box with NAME=mybox1. Specify two real numbers.	None
set BOX(mybox1,yrange) "ymin ymax"	Used by BuildPeg5i to specify the min and max y coordinates for the box with NAME=mybox1. Specify two real numbers.	None
set BOX(mybox1,zrange) "zmin zmax"	Used by BuildPeg5i to specify the min and max z coordinates for the box with NAME=mybox1. Specify two real numbers.	None
set REGION(name) "myregion1 myregion2 myregion3 ..."	Used by BuildPeg5i to specify custom REGION namelists input in the pegasus5 input file. Specify a list of names, one for each REGION namelist, surrounded by double quotes.	None
set REGION(myregion1,ispartof) "mesh-name"	Used by BuildPeg5i to specify the name of the mesh associated with the region with NAME=myregion1.	None
set REGION(myregion1,type) "mytype"	Used by BuildPeg5i to specify the type input for the region with NAME=myregion1. Specify one of 'HOLE', 'UNBL', 'INTR'.	None
set VOLUME(name) "myvolume1 myvolume2 myvolume3 ..."	Used by BuildPeg5i to specify custom VOLUME namelists input in the pegasus5 input file. Specify a list of names, one for each VOLUME namelist, surrounded by double quotes.	None
set VOLUME(myvolume1,ispartof) "region-name"	Used by BuildPeg5i to specify the region associated with the volume with NAME=myvolume1. Specify the name of a REGION.	None
set VOLUME(myvolume1,jrange) "jbeg jend"	Used by BuildPeg5i to specify the begin and end jindices for the volume with NAME=myvolume1. Specify 2 integers.	None
set VOLUME(myvolume1,krange) "kbeg kend"	Used by BuildPeg5i to specify the begin and end kindices for the volume with NAME=myvolume1. Specify 2 integers.	None
set VOLUME(myvolume1,lrange) "lbeg lend"	Used by BuildPeg5i to specify the begin and end lindices for the volume with NAME=myvolume1. Specify 2 integers.	None

Example of Pegasus5 Inputs

set BOUNDARY(name) "myboundary1 myboundary2"
set BOUNDARY(myboundary1,ispartof) "ball1"
set BOUNDARY(myboundary1,closed) .T.
set BOUNDARY(myboundary1,mholein) "box box2"
set BOUNDARY(myboundary2,ispartof) "ball2"
set BOUNDARY(myboundary2,closed) .T.
set BOUNDARY(myboundary2,mholein) "box box2"

set SURFACE(name) "mysurface1 mysurface2"
set SURFACE(mysurface1,ispartof) "myboundary1"
set SURFACE(mysurface1,meshname) "ball1"
set SURFACE(mysurface1,jrange) "1 -1"
set SURFACE(mysurface1,krange) "1 -1"
set SURFACE(mysurface1,lrange) "1  1"
set SURFACE(mysurface1,nvout) "+L"
set SURFACE(mysurface2,ispartof) "myboundary1"
set SURFACE(mysurface2,meshname) "ball2"
set SURFACE(mysurface2,jrange) "1 -1"
set SURFACE(mysurface2,krange) "1 -1"
set SURFACE(mysurface2,lrange) "1  1"
set SURFACE(mysurface2,nvout) "+L"

set BOX(name) "mybox1 mybox2"
set BOX(mybox1,ispartof) "myboundary2"
set BOX(mybox1,xrange) "0.0 100.0"
set BOX(mybox1,yrange) "100.0 200.0"
set BOX(mybox1,zrange) "2000.0 300.0"
set BOX(mybox2,ispartof) "myboundary2"
set BOX(mybox2,xrange) "1000.0  10000.0"
set BOX(mybox2,yrange) "10000.0 20000.0"
set BOX(mybox2,zrange) "20000.0 30000.0"

set REGION(name) "myregion1 myregion2"
set REGION(myregion1,ispartof) "ball1"
set REGION(myregion1,type) "HOLE"
set REGION(myregion2,ispartof) "ball2"
set REGION(myregion2,type) "HOLE"

set VOLUME(name) "myvol1 myvol2"
set VOLUME(myvol1,ispartof) "myregion1"
set VOLUME(myvol1,jrange) "1 -1"
set VOLUME(myvol1,krange) "2 -2"
set VOLUME(myvol1,lrange) "3 -3"
set VOLUME(myvol2,ispartof) "myregion2"
set VOLUME(myvol2,jrange) "4 -4"
set VOLUME(myvol2,krange) "5 -5"
set VOLUME(myvol2,lrange) "6 -6"

These above entries result in the following lines in the peg.i file created by the BuildPeg5i script:

 $BOUNDARY NAME = 'myboundary1',
    ISPARTOF = 'ball1',
    CLOSED = .T.,
    MHOLEIN =  'box', 'box2',
 $END

 $BOUNDARY NAME = 'myboundary2',
    ISPARTOF = 'ball2',
    CLOSED = .T.,
    MHOLEIN =  'box', 'box2',
 $END

 $SURFACE
    ISPARTOF = 'myboundary1',
    MESHNAME = 'ball1',
    JRANGE = 1, -1, 
    KRANGE = 1, -1, 
    LRANGE = 1, 1, 
    NVOUT = '+L',
 $END

 $SURFACE
    ISPARTOF = 'myboundary1',
    MESHNAME = 'ball2',
    JRANGE = 1, -1, 
    KRANGE = 1, -1, 
    LRANGE = 1, 1, 
    NVOUT = '+L',
 $END

 $BOX
    ISPARTOF = 'myboundary2',
    XRANGE = 0.0, 100.0, 
    YRANGE = 100.0, 200.0, 
    ZRANGE = 2000.0, 300.0, 
 $END

 $BOX
    ISPARTOF = 'myboundary2',
    XRANGE = 1000.0, 10000.0, 
    YRANGE = 10000.0, 20000.0, 
    ZRANGE = 20000.0, 30000.0, 
 $END

 $REGION NAME = 'myregion1',
    ISPARTOF = 'ball1',
    TYPE = 'HOLE',
 $END

 $REGION NAME = 'myregion2',
    ISPARTOF = 'ball2',
    TYPE = 'HOLE',
 $END

 $VOLUME
    ISPARTOF = 'myregion1',
    JRANGE = 1, -1, 
    KRANGE = 2, -2, 
    LRANGE = 3, -3, 
 $END

 $VOLUME
    ISPARTOF = 'myregion2',
    JRANGE = 4, -4, 
    KRANGE = 5, -5, 
    LRANGE = 6, -6, 
 $END

OVERFLOW Inputs

Parameter	Description	Default Value
set Ovr(parcbc) parcbc set Ovr(max_groups) max_groups set Ovr(cpus_per_group) cpus_per_group set Ovr(nprina) nprina	Used by BuildOveri to specify variables within the MLP namelist.	None
set Ovr(chimra) chimra set Ovr(incore) incore set Ovr(nsteps) nsteps set Ovr(restrt) restrt set Ovr(nsave) nsave set Ovr(nfomo) nfomo set Ovr(nqt) nqt set Ovr(nqc) nqc set Ovr(multig) multig set Ovr(fmg) fmg set Ovr(nglvl) nglvl set Ovr(fmgcyc) fmgcyc set Ovr(nitnwt) nitnwt set Ovr(fsonwt) fsonwt set Ovr(dtphys) dtphys set Ovr(ordnwt) ordnwt set Ovr(save_hiorder) save_hiorder set Ovr(istart_qavg) istart_qavg set Ovr(nobomb) nobomb set Ovr(debug) debug set Ovr(tphys) tphys set Ovr(rf) rf set Ovr(rfaxis) rfaxis set Ovr(cdisc) cdisc set Ovr(grdwts) grdwts set Ovr(max_grid_size) max_grid_size set Ovr(conserve_mem) conserve_mem set Ovr(read_wall_dist read_wall_dist set Ovr(walldist) walldist set Ovr(nwall) nwall set Ovr(stoptime_stepx stoptime_stepx set Ovr(stoptime_sec) stoptime_sec	Used by BuildOveri to specify variables within the GLOBAL namelist.	.T. .F. 0 .F. 100 10 0 0 .T. .T. 3 "200, 200" 0 2 0 2 None .F. 0 None None None None None None None None None None None None None
set Ovr(irun) "irun" set Ovr(i6dof) "i6dof" set Ovr(dynmcs) "dynmcs" set Ovr(nadapt) "nadapt" set Ovr(nrefine) "nrefine" set Ovr(etype) "etype" set Ovr(sigerr) "sigerr" set Ovr(erefine) "erefine" set Ovr(ecoarsen) "ecoarsen" set Ovr(r_coef) "r_coef" set Ovr(lfringe) "lfringe" set Ovr(ibxmin) "ibxmin" set Ovr(ibxmax) "ibxmax" set Ovr(ibymin) "ibymin" set Ovr(ibymax) "ibymax" set Ovr(ibzmin) "ibzmin" set Ovr(ibzmax) "ibzmax" set Ovr(laminar_ob) "laminar_ob"	Used by BuildOveri to specify variables within the OMIGLB namelist.	None
set Ovr(obgrids) "obgrids" set Ovr(max_brick_size) "max_brick_size" set Ovr(ds) "ds" set Ovr(dfar) "dfar" set Ovr(xncen) "xncen" set Ovr(yncen) "yncen" set Ovr(zncen) "zncen" set Ovr(chrlen) "chrlen" set Ovr(i_xmin) "i_xmin" set Ovr(i_xmax) "i_xmax" set Ovr(i_ymin) "i_ymin" set Ovr(i_ymax) "i_ymax" set Ovr(i_zmin) "i_zmin" set Ovr(i_zmax) "i_zmax" set Ovr(p_xmin) "p_xmin" set Ovr(p_xmax) "p_xmax" set Ovr(p_ymin) "p_ymin" set Ovr(p_ymax) "p_ymax" set Ovr(p_zmin) "p_zmin" set Ovr(p_zmax) "p_zmax" set Ovr(minbuf) "minbuf" set Ovr(ofringe) "ofringe"	Used by BuildOveri to specify variables within the GBRICK namelist. Unless the parameter 'obgrids' is explicitly set to false (e.g. ".F.", ".FALSE.", etc.), BuildOveri will automatically add the mesh name 'OFFBODY' to the end of the rootnames list.	None
set NBBRK(name) " name1 name2 ..." set NBBRK(name,grid) "meshname" set NBBRK(name,brklvl) "brklvl" set NBBRK(name,jbrkmin) "jbrkmin" set NBBRK(name,jbrkmin) "jbrkmin" set NBBRK(name,jbrkmax) "jbrkmax" set NBBRK(name,kbrkmin) "kbrkmin" set NBBRK(name,kbrkmax) "kbrkmax" set NBBRK(name,lbrkmin) "lbrkmin" set NBBRK(name,lbrkmax) "lbrkmax" set NBREF(name) " name1 name2 ..." set NBREF(name,grid) "meshname" set NBREF(name,jbrkmin) "jbrkmin" set NBREF(name,jbrkmin) "jbrkmin" set NBREF(name,jbrkmax) "jbrkmax" set NBREF(name,kbrkmin) "kbrkmin" set NBREF(name,kbrkmax) "kbrkmax" set NBREF(name,lbrkmin) "lbrkmin" set NBREF(name,lbrkmax) "lbrkmax" set NBREF(name,reflvl) "reflvl" set NBREF(name,refinout) "refinout"	Used by BuildOveri to specify variables within the NBINP namelist. Use $NBBRK(name) and $NBREF(name) to specify names for each of the NBINP regions you want to define (these do not need to correspond to mesh names). Thest are white-space delineated lists. For each 'name' in $NBBRK(name) and $NBREF(name), define a near-body grid that the region is associated with (NBBRK(name,grid) and NBREF(name,grid)). This will be expanded by the scripts to the appropriate grid number. Also for each 'name' in $NBBRK(name) and $NBREF(name), complete specification for all other parameters of interest that differ from the OVERFLOW defaults.	None
set Ovr(nbrick) "nbrick" set Ovr(xbrkmin,ib) "xbrkmin" set Ovr(xbrkmax,ib) "xbrkmax" set Ovr(ybrkmin,ib) "ybrkmin" set Ovr(ybrkmax,ib) "ybrkmax" set Ovr(zbrkmin,ib) "zbrkmin" set Ovr(zbrkmax,ib) "zbrkmax" set Ovr(brklvl,ib) "brklvl" set Ovr(ibdytag,ib) "ibdytag" set Ovr(deltas,ib) "deltas" set Ovr(nrefreg) "nrefreg" set Ovr(xrefmin,ir) "xrefmin" set Ovr(xrefmax,ir) "xrefmax" set Ovr(yrefmin,ir) "yrefmin" set Ovr(yrefmax,ir) "yrefmax" set Ovr(zrefmin,ir) "zrefmin" set Ovr(zrefmax,ir) "zrefmax" set Ovr(reflvl,ir) "reflvl" set Ovr(ibdyref,ir) "ibdyref" set Ovr(refinout,ir) "refinout"	Used by BuildOveri to specify variables within the BRKINP namelist.	None
set Ovr(usefle) "usefle" set Ovr(maxnb) "maxnb" set Ovr(maxgrd) "maxgrd" set Ovr(wghtnb) "wghtnb" set Ovr(igsize) "igsize"	Used by BuildOveri to specify variables within the GROUPS namelist.	None
set Ovr(dqual) "dqual" set Ovr(morfan) "morfan" set Ovr(norfan) "norfan"	Used by BuildOveri to specify variables within the DCFGLB namelist.	None
set SPLITM(nsplitm) "nsplitm" set SPLITM(xfile,i) "xfile" set SPLITM(qfile,i) "qfile" set SPLITM(qavgfile,i) "qavgfile" set SPLITM(nstart,i) "nstart" set SPLITM(nstop,i) "nstop" set SPLITM(nsave,i) "nsave" set SPLITM(name,i) "meshname" set SPLITM(ig,i) "ig list" set SPLITM(js,i) "js list" set SPLITM(je,i) "je list" set SPLITM(ji,i) "ji list" set SPLITM(ks,i) "ks list" set SPLITM(ke,i) "ke list" set SPLITM(ki,i) "ki list" set SPLITM(ls,i) "ls list" set SPLITM(le,i) "le list" set SPLITM(li,i) "li list" set SPLITM(cut,i) "cut" set SPLITM(value,i) "value"	Used by BuildOveri to specify variables within the SPLITM namelists. Use $SPLITM(nsplitm) to specifiy the number of SPLITM namelists desired. Then for each SPLITM namelist specify the namelist variable followed by a comma and the namelist number (e.g. set SPLITM(xfile,3)). Either SPLITM(ig,i) must be set to the zone number, or SPLITM(name,i) must be set to the zone name. For the index variables (i.e. js,je,je,ks,...) specify a space delimited list of the indicies for each subset, surrounded by double quotes.	None
set Ovr(alpha) alpha set Ovr(beta) beta set Ovr(fsmach) fsmach set Ovr(refmach) refmach set Ovr(gaminf) gaminf set Ovr(rey) rey set Ovr(pr) pr set Ovr(prt) prt set Ovr(tinf) tinf set Ovr(retinf) retinf set Ovr(xkinf) xkinf set Ovr(froude) froude set Ovr(gvec) gvec set Ovr(targcl) targcl set Ovr(cltarg) cltarg set Ovr(clalph) clalph set Ovr(ntarg) ntarg set Ovr(ctp) ctp set Ovr(aspctr) aspctr	Used by BuildOveri to specify variables within the FLOINP namelist.	0.0 0.0 0.0 1.4 None 0.0 0.7 0.92 518.7 0.1 0.0001 0.0 "0, 0, 1" None None None None None None
set Ovr(igam) "igam" set Ovr(ht1) "ht1" set Ovr(ht2) "ht2" set Ovr(scinf) "scinf" set Ovr(smw) "smw" set Ovr(alt0) "alt0" set Ovr(alt1) "alt1" set Ovr(alt2) "alt2" set Ovr(alt3) "alt3" set Ovr(alt4) "alt4" set Ovr(aut0) "aut0" set Ovr(aut1) "aut1" set Ovr(aut2) "aut2" set Ovr(aut3) "aut3" set Ovr(aut4) "aut4" set Ovr(sigl) "sigl" set Ovr(sigt) "sigt"	Used by BuildOveri to specify variables within the VARGAM namelist.	None
set Ovr(MESH,iter) "iter"	Used by BuildOveri to specify variables within the NITERS namelist for the mesh named MESH. Substitute the word "default" for "MESH" to specify a value for all meshes.	None
set Ovr(MESH,irhs) "irhs" set Ovr(MESH,ilhs) "ilhs" set Ovr(MESH,idiss) "idiss" set Ovr(MESH,bimin) "bimin" set Ovr(MESH,multig) "multig" set Ovr(MESH,rlhsit) "rlhsit" set Ovr(MESH,idiss) "idiss" set Ovr(MESH,ilimit) "ilimit" set Ovr(MESH,ssor_relax) "ssor_relax" set Ovr(MESH,q_limit) "q_limit" set Ovr(MESH,smoop) "smoop" set Ovr(MESH,smooc) "smooc" set Ovr(MESH,smoor) "smoor" set Ovr(MESH,corsvi) "corsvi" set Ovr(MESH,recmut) "recmut"	Used by BuildOveri to specify variables within the METPRM namelist for the mesh named MESH. Substitute the word "default" for "MESH" to specify a value for all meshes.	None
set Ovr(MESH,itime) "itime" set Ovr(MESH,dt) "dt" set Ovr(MESH,tfoso) "tfoso" set Ovr(MESH,cflmin) "cflmin" set Ovr(MESH,cflmax) "cflmax"	Used by BuildOveri to specify variables within the TIMACU namelist for the mesh named MESH. Substitute the word "default" for "MESH" to specify a value for all meshes.	None
set Ovr(MESH,smoo) "smoo" set Ovr(MESH,dis2) "dis2" set Ovr(MESH,dis4) "dis4" set Ovr(MESH,fso) "fso" set Ovr(MESH,delta) "delta" set Ovr(MESH,ispec) "ispec" set Ovr(MESH,vepsn) "vepsn" set Ovr(MESH,vepsl) "vepsl" set Ovr(MESH,filter) "filter" set Ovr(MESH,epssgs) "epssgs" set Ovr(MESH,roeavg) "roeavg"	Used by BuildOveri to specify variables within the SMOACU namelist for the mesh named MESH. Substitute the word "default" for "MESH" to specify a value for all meshes.	None
set Ovr(MESH,visc) "visc" set Ovr(MESH,viscj) "viscj" set Ovr(MESH,visck) "visck" set Ovr(MESH,viscl) "viscl" set Ovr(MESH,viscx) "viscx" set Ovr(MESH,itert) "itert" set Ovr(MESH,cflt) "cflt" set Ovr(MESH,wallfun) "wallfun" set Ovr(MESH,itlhit) "itlhit" set Ovr(MESH,fsot) "fsot" set Ovr(MESH,mut_limit) "mut_limit" set Ovr(MESH,ides) "ides" set Ovr(MESH,irc) "irc" set Ovr(MESH,icc) "icc" set Ovr(MESH,istrain) "istrain" set Ovr(MESH,itc) "itc"	Used by BuildOveri to specify variables within the VISINP namelist for the mesh named MESH. Substitute the word "default" for "MESH" to specify a value for all meshes.	None
set Ovr(MESH,ibtyp) "ibtyp" set Ovr(MESH,ibdir) "ibdir" set Ovr(MESH,jbcs) "jbcs" set Ovr(MESH,jbce) "jbce" set Ovr(MESH,kbcs) "kbcs" set Ovr(MESH,kbce) "kbce" set Ovr(MESH,lbcs) "lbcs" set Ovr(MESH,lbce) "lbce"	Used by BuildOveri to specify variables within the BCINP namelist for the mesh named MESH.	None
set Ovr(MESH,ibtyp) "ibtyp" set Ovr(MESH,iblink) "iblink" set Ovr(MESH,igmove) "igmove" set Ovr(MESH,idform) "idform" set Ovr(MESH,nmap) "nmap" set Ovr(MESH,nxray) "nxray" set Ovr(MESH,bmass) "bmass" set Ovr(MESH,tjj) "tjj" set Ovr(MESH,tkk) "tkk" set Ovr(MESH,tll) "tll" set Ovr(MESH,weight) "weight" set Ovr(MESH,gravx) "gravx" set Ovr(MESH,gravy) "gravy" set Ovr(MESH,gravz) "gravz" set Ovr(MESH,ishift) "ishift" set Ovr(MESH,fx) "fx" set Ovr(MESH,fy) "fy" set Ovr(MESH,fz) "fz" set Ovr(MESH,fmx) "fmx" set Ovr(MESH,fmy) "fmy" set Ovr(MESH,fmz) "fmz" set Ovr(MESH,strokx) "strokx" set Ovr(MESH,stroky) "stroky" set Ovr(MESH,strokz) "strokz" set Ovr(MESH,strokt) "strokt" set Ovr(MESH,freex) "freex" set Ovr(MESH,freey) "freey" set Ovr(MESH,freez) "freez" set Ovr(MESH,freer) "freer" set Ovr(MESH,free) "free" set Ovr(MESH,x00) "x00" set Ovr(MESH,y00) "y00" set Ovr(MESH,z00) "z00" set Ovr(MESH,x0) "x0" set Ovr(MESH,y0) "y0" set Ovr(MESH,z0) "z0" set Ovr(MESH,e1) "e1" set Ovr(MESH,e2) "e2" set Ovr(MESH,e3) "e3" set Ovr(MESH,e4) "e4" set Ovr(MESH,ur) "ur" set Ovr(MESH,vr) "vr" set Ovr(MESH,wr) "wr" set Ovr(MESH,wx) "wx" set Ovr(MESH,wy) "wy" set Ovr(MESH,wz) "wz" set Ovr(MESH,wj) "wj" set Ovr(MESH,wk) "wk" set Ovr(MESH,wl) "wl"	Used by BuildOveri to specify variables within the SIXINP namelist for the mesh named MESH. Substitute the word "default" for "MESH" to specify a value for all meshes. This namelist is only written if $Ovr(i6dof) is specified and is not equal to 2 or if any of the variables listed to the left are actually specified.	None
set Ovr(MESH,family) "family names"	Used by BuildMixsuri to specify family names for grouping together wall subsets to form separate parts. family names is a list of names, one for each wall boundary condition specified in the BCINP namelist for the mesh named MESH.	None
set Ovr(MESH,xmlcomp) "component_name"	Used by BuildOveri to specify the Config.xml component name to which the mesh named MESH belongs to. Only one name should be specified.	None

Inputs for XRAYS

The following parameters are used by BuildOveri to create an xrays.in file and to add XRINFO namelists to the overflow.inp file. In order for the BuildOveri script to process XRAYS and create the xrays.in file one must either define the $xraynames list in your config.tcl file, or define the $XRAY(name) array in your inputs.tcl file.

Parameter	Description	Default Value
set xraynames [list dir1/xray_name1 ... dirN/xray_nameM]	Set this variable to a list of all of the individual .xry xray files to be used in the configuration. Typically this variable is set in the config.tcl file. BuildOveri will assemble the individual xrays in this list and to create the composite xray file 'xrays.in'. One must set either $xraynames OR $XRINFO(name) to use xrays. If both are defined, only $XRINFO(name) will be used.	None
set XRINFO(name) "xrinfo_name1 xrinfo_name2 ..." --or-- set XRINFO(name) [list xrinfo_name1 xrinfo_name2 ...]	A list of XRINFO namelists to include in the overflow input file. Each entry in the list should have an xray file that exists with a '.xry' extension and each file should have only one xray. If an xray file is missing, any XRINFO(xrinfoname,idxray) that refers to this xray will not be included in the overflow input file. One must set either $xraynames OR $XRINFO(name) to use xrays. If both are defined, only $XRINFO(name) will be used.	None
set XRINFO(xrinfo_name,idxray) "xray_name"	The xray name to make the cut in for the "xrinfo_name" XRINFO namelist. The "xray_name" specified should exist in XRINFO(name). If it doesn't, the XRINFO namelist for "xrinfo_name" is removed and won't be included in the overflow input file. This parameter is required for a given "xrinfo_name".	None
set XRINFO(xrinfo_name,igxbeg) "zonename"	The beginning grid name to cut for the "xrinfo_name" XRINFO namelist. The zonename specified should exist in rootnames. If it doesn't, the XRINFO namelist "xrinfo_name" is removed and won't be included in the overflow input file. This parameter is required for a given "xrinfo_name" if XRINFO(xrinfo_name,igxend) is also specified. This parameter should not be specified if XRINFO(xrinfo_name,igxlist) is also specified.	None
set XRINFO(xrinfo_name,igxend) "zonename"	The ending grid name to cut for the "xrinfo_name" XRINFO namelist. The zonename specified should exist in rootnames. If it doesn't, the XRINFO namelist "xrinfo_name" is removed and won't be included in the overflow input file. This parameter is required for a given "xrinfo_name" if XRINFO(xrinfo_name,igxbeg) is also specified. This parameter should not be specified if XRINFO(xrinfo_name,igxlist) is also specified.	None
set XRINFO(xrinfo_name,igxlist) "zonename1 zonename2 ..."	A list grid names to cut for the "xrinfo_name" XRINFO namelist. The zonenames specified should exist in rootnames. Zonenames that don't exist in rootnames are automatically removed from the list. If the list is emptied, the XRINFO namelist "xrinfo_name" is removed and won't be included in the overflow input file. This parameter should not be specified if XRINFO(xrinfo_name,igxbeg) or XRINFO(xrinfo_name,igxend) are also specified.	None
set XRINFO(xrinfo_name,xdelta) "xdelta"	The XDELTA to use for the "xrinfo_name" XRINFO namelist. This parameter is required for a given xrinfo_name.	None
set XRINFO(verbose) n	Set this value to 1 to turn on verbose XRINFO processing information to be written to stdout by BuildOveri.	None
set XRAY(name) "dir1/xray_name1 dir1/xray_name2 dir2/xray_name3 ..." --or-- set XRAY(name) [list dir1/xray_name1 dir1/xray_name2 dir2/xray_name3 ...]	A list of xray files to use for hole cuts. Each member of the list should have a file that exists with an '.xry' extension. If an xray file is missing, any XRINFO(xrinfoname,idxray) that refers to this xray will not be included in the overflow input file. BuildOveri will assemble the individual xray files in this list and to create the composite xray file 'xrays.in'.	None
set XRAY(xray_name,compid) "component_name"	The XML component this xray is associated with. The name specified must be a valid XML component name. If unspecified, the component name is taken to be the xray name (e.g. "xray_name1" from above) if that is a valid XML component name. Otherwise, the value defaults to the first component in the XML file. In the latter case, a warning is issued if grid motion is detected. The intent of the warning is that the xray may have been assigned to the wrong component for a dynamic case. Grid motion is considered true if any of the following are true: Ovr(dynmcs) is set to true Config(COMP,transforms) is set for any component COMP Scenario(COMP,prescribed,transforms) is set for any component COMP Scenario(COMP,aero6dof,start) is set for any component COMP	"xray_name" --or-- the first XML component

Example of Inputs for XRAYS

For the following set of rootnames in config.tcl:

set rootnames "grids/tower
               grids/nacelle
               grids/nacelle_front
               grids/nacelle_back
               grids/blade1a
               grids/blade1b
               grids/blade1c
               grids/blade1d
               grids/blade3a
               grids/blade3b
               grids/blade3c
               grids/blade3d"

set XRAY(name) "grids/tower grids/blade1 grids/nacelle grids/blade3"

set name "blade1_cut_in_bricks"
lappend XRINFO(name) $name
set XRINFO($name,idxray)  "blade1"
set XRINFO($name,igxlist) "OFFBODY"
set XRINFO($name,xdelta)  0.25

set name "blade3_cut_in_bricks"
lappend XRINFO(name) $name
set XRINFO($name,idxray)  "blade3"
set XRINFO($name,igxlist) "OFFBODY"
set XRINFO($name,xdelta)  0.25

set name "tower_cut_in_bricks"
lappend XRINFO(name) $name
set XRINFO($name,idxray)  "tower"
set XRINFO($name,igxlist) "OFFBODY"
set XRINFO($name,xdelta)  0.5

set name "nacelle_cut_in_bricks"
lappend XRINFO(name) $name
set XRINFO($name,idxray)  "nacelle"
set XRINFO($name,igxlist) "OFFBODY"
set XRINFO($name,xdelta)  0.5

set name "tower_cut_in_nacelle_and_blades"
lappend XRINFO(name) $name
set XRINFO($name,idxray)  "tower"
set XRINFO($name,igxlist) "nacelle blade1c blade3c"
set XRINFO($name,xdelta)  0.1

These above entries result in the following lines in the overflow.inp file created by the BuildOveri script:

! blade1_cut_in_bricks
 $XRINFO
     IDXRAY  = 2,
     IGXLIST = -1,
     XDELTA  = 0.25,
     $END

! blade3_cut_in_bricks
 $XRINFO
     IDXRAY  = 4,
     IGXLIST = -1,
     XDELTA  = 0.25,
     $END

! tower_cut_in_bricks
 $XRINFO
     IDXRAY  = 1,
     IGXLIST = -1,
     XDELTA  = 0.5,
     $END

! nacelle_cut_in_bricks
 $XRINFO
     IDXRAY  = 3,
     IGXLIST = -1,
     XDELTA  = 0.5,
     $END

! nacelle_cut_in_bricks
 $XRINFO
     IDXRAY  = 3,
     IGXLIST = -1,
     XDELTA  = 0.5,
     $END

! tower_cut_in_nacelle_and_blades
 $XRINFO
     IDXRAY  = 1,
     IGXLIST = 2,7,11,
     XDELTA  = 0.1,
     $END

Inputs For The Config.xml File

The following parameters are used by BuildOveri to write Config.xml.

Parameter	Description	Default Value
set Config(angleunit) "angleunit"	Used to specify the angle unit used. Valid values are 'degree' and 'radian'.	degree
set Config(comp1,type) "type"	Used to specify the type for the component named 'comp1'. Valid values are 'struc' and 'container'.	struc
set Config(comp1,parent) "component_name"	Used to specify the parent for the component named 'comp1'. The value has to be a valid XML component name.	None
set Config(comp1,transforms) "rotate translate1 mirror ..."	Used to specify transforms for the component named 'comp1'. The value is a list of transform names that will be applied to the component in the order provided. The transform names must begin with 'rotate', 'translate', or 'mirror' and can end with an arbitrary string to make it unique. Note that the mirror transform is not currently implemented in OVERFLOW so it shouldn't be used.	None
set Config(comp1,rotate1,center) "x,y,z"	Used to specify the center point for the rotation 'rotate1' of the component named 'comp1'. The value is a comma delimited list of the coordinates. This is a required parameter for a given rotation.	None
set Config(comp1,rotate1,axis) "x,y,z"	Used to specify the axis for the rotation 'rotate1' of the component named 'comp1'. The value is a comma delimited list of the vector components. This is a required parameter for a given rotation.	None
set Config(comp1,rotate1,angle) "angle"	Used to specify the angle for the rotation 'rotate1' of the component named 'comp1'. This is a required parameter for a given rotation.	None
set Config(comp1,translate1,displacement) "x,y,z"	Used to specify the displacement values for the translation 'translate1' of the component named 'comp1'. The value is a comma delimited list of the displacement components. This is a required parameter for a given translation.	None
set Config(comp1,mirror1,plane) "plane"	Used to specify the plane for the mirror 'mirror1' of the component named 'comp1'. The value is should be 'X', 'Y', or 'Z'. This is a required parameter for a given mirror.	None
set Config(comp1) "1" set Config(comp2) "2" set Config(comp3) "3" set Config(compn) "n"	Used to specify the order that the components will appear on the Config.xml file. This order can be important as it corresponds to the BodyID number in the xrays.in file, which tells Overflow which xrays are to undergo the transforms in the Config.xml.	None

Notes on Config.xml

For problems with grid movement using the Config.xml file, each grid in the system needs to be associated to a specific XML component as defined in the Config.xml file. This is typically done with a line such as the following in the inputs.tcl file:

set Ovr(MESH,xmlcomp) "component-name"

set Ovr(MESH,xmlcomp) "component-name"
WriteOvfi MESH.ovfi MESH

Also note that another way to add a specific component to the Config.xml file is to include two lines like the following in your inputs.tcl:

set mixsurcomp(component-name) [list comp1 comp2 comp3]
set Config(component-name) N

Example of Inputs used for Config.xml

The following are example entries in an inputs.tcl file that are used to in the generation of Config.xml:

set Config(angleunit) "degree"

set Config(blade1,parent) rotor
set Config(blade3,parent) rotor

set Config(rotor,type) "container"

set Config(test,type) "clone"
set Config(test,source) "blade3"

set angle 1.775

set Config(blade1,transforms) "rotate1 rotate2 rotate3"

set Config(blade1,rotate1,center) "0,0,0"
set Config(blade1,rotate1,axis) "0,1,0"
set Config(blade1,rotate1,angle) -90

set Config(blade1,rotate2,center) "0,0,0"
set Config(blade1,rotate2,axis) "0,0,1"
set Config(blade1,rotate2,angle) $angle

set Config(blade1,rotate3,center) "0,0,0"
set Config(blade1,rotate3,axis) "1,0,0"
set Config(blade1,rotate3,angle) -45

set Config(blade3,transforms) "rotate1 rotate2 rotate3"

set Config(blade3,rotate1,center) "0,0,0"
set Config(blade3,rotate1,axis) "0,1,0"
set Config(blade3,rotate1,angle) -90

set Config(blade3,rotate2,center) "0,0,0"
set Config(blade3,rotate2,axis) "0,0,-1"
set Config(blade3,rotate2,angle) $angle

set Config(blade3,rotate3,center) "0,0,0"
set Config(blade3,rotate3,axis) "1,0,0"
set Config(blade3,rotate3,angle) -45

These above entries result in the following lines in the Config.xml file created by the BuildOveri script:

<?xml version='1.0' encoding='utf-8'?>
<Configuration AngleUnit='degree'>

   <Component Name='tower' Type='struc'> 
      <Data> Grid List=1 </Data> 
   </Component>

   <Component Name='nacelle' Type='struc'> 
      <Data> Grid List=2-4 </Data> 
   </Component>

   <Component Name='blade1' Type='struc' Parent='rotor'> 
      <Data> Grid List=5-8 </Data> 
      <Transform>
         <Rotate Center='0,0,0' Axis='0,1,0' Angle='-90' />
         <Rotate Center='0,0,0' Axis='0,0,1' Angle='1.775' />
         <Rotate Center='0,0,0' Axis='1,0,0' Angle='-45' />
      </Transform>
   </Component>

   <Component Name='blade3' Type='struc' Parent='rotor'> 
      <Data> Grid List=9-12 </Data> 
      <Transform>
         <Rotate Center='0,0,0' Axis='0,1,0' Angle='-90' />
         <Rotate Center='0,0,0' Axis='0,0,-1' Angle='1.775' />
         <Rotate Center='0,0,0' Axis='1,0,0' Angle='-45' />
      </Transform>
   </Component>

   <Component Name='rotor' Type='container'> 
   </Component>

</Configuration>

Inputs For The Scenario.xml File

The following parameters are used by BuildOveri to write Scenario.xml. This is a required parameter for prescribed motion on a given component.

Parameter	Description	Default Value
set Scenario(angleunit) "angleunit"	Used to specify the angle unit used. Valid values are 'degree' and 'radian'.	degree
set Scenario(comp1,prescribed,start) "start"	Used to specify the start time for the prescribed motion of the component named 'comp1'.	None
set Scenario(comp1,prescribed,duration) "duration"	Used to specify the duration for the prescribed motion of the component named 'comp1'. This is an optional parameter for prescribed motion on a given component.	None
set Scenario(comp1,prescribed,transforms) "rotate translate1 ..."	Used to specify transforms for the prescribed motion of the component named 'comp1'. The value is a list of transform names that will be applied to the component in the order provided. The transform names must begin with 'rotate' or 'translate' and can end with an arbitrary string to make it unique. This is a required parameter for prescribed motion on a given component.	None
set Scenario(comp1,rotate1,center) "x,y,z"	Used to specify the prescribed rotation center point for the transform named 'rotate1' of the component named 'comp1'. The value is a comma delimited list of the coordinates. This is a required parameter for prescribed rotation on a given component.	None
set Scenario(comp1,rotate1,axis) "x,y,z"	Used to specify prescribed rotation axis for the transform named 'rotate1' of the component named 'comp1'. The value is a comma delimited list of the vector components. This is a required parameter for prescribed rotation on a given component.	None
set Scenario(comp1,rotate1,speed) "speed"	Used to specify the prescribed non-dimensional speed for the transform named 'rotate1' of the component named 'comp1'. This is a required parameter for prescribed rotation on a given component.	None
set Scenario(comp1,rotate1,frame) "frame"	Used to specify the frame for the prescribed rotation 'rotate1' of the component named 'comp1'. Valid values are 'body' and 'parent'. This is an optional parameter for prescribed rotation on a given component.	parent
set Scenario(comp1,translate1,velocity) "vx,vy,vz"	Used to specify the prescribed velocity components for the tranform named 'translate1' of the component named 'comp1'. The value is a comma delimited list of the velocity components. This is a required parameter for a given translation.	None
set Scenario(comp1,aero6dof,start) "start"	Used to specify the start time for the aero6dof motion of the component named 'comp1'. This is a required parameter for aero6dof motion on a given component.	None
set Scenario(comp1,aero6dof,duration) "duration"	Used to specify the duration for the aero6dof motion of the component named 'comp1'. This is an optional parameter for aero6dof motion on a given component.	None
set Scenario(comp1,aero6dof,iprop,mass) "mass"	Used to specify the inertial property of mass for the aero6dof motion of the component named 'comp1'. This is a required parameter for aero6dof motion on a given component.	None
set Scenario(comp1,aero6dof,iprop,com) "x,y,z"	Used to specify the inertial property of the center of mass for the aero6dof motion of the component named 'comp1'. This is a required parameter for aero6dof motion on a given component.	None
set Scenario(comp1,aero6dof,iprop,pmi) "px,py,pz"	Used to specify the inertial property of the principal moments of inertia for the aero6dof motion of the component named 'comp1'. This is a required parameter for aero6dof motion on a given component.	None
set Scenario(comp1,aero6dof,iprop,axis) "vx,vy,vz"	Used to specify the inertial property of the principal axes components for the aero6dof motion of the component named 'comp1'. This is a required parameter for aero6dof motion on a given component.	None
set Scenario(comp1,aero6dof,iprop,angle) "angle"	Used to specify the inertial property of the principal axes angle for the aero6dof motion of the component named 'comp1'. This is a required parameter for aero6dof motion on a given component.	None
set Scenario(comp1,appliedload,start) "start"	Used to specify the start time for the applied load on the component named 'comp1'. This is a required parameter for an applied load on a given component.	None
set Scenario(comp1,appliedload,duration) "duration"	Used to specify the duration for the applied load on the component named 'comp1'. This is an optional parameter for an applied load on a given component.	None
set Scenario(comp1,appliedload,frame) "frame"	Used to specify the frame for the applied load on the component named 'comp1'. Valid values are 'body', 'parent' and 'inertial'. This is an optional parameter for an applied load on a given component.	parent
set Scenario(comp1,appliedload,force) "fx,fy,fz"	Used to specify the force components for the applied load on the component named 'comp1'. This is an optional parameter for an applied load on a given component.	None
set Scenario(comp1,appliedload,moment) "mx,my,mz"	Used to specify the moment components for the applied load on the component named 'comp1'. This is an optional parameter for an applied load on a given component.	None
set Scenario(comp1,appliedload,center) "x,y,z"	Used to specify the moment center for the applied load on the component named 'comp1'. This is an optional parameter for an applied load on a given component.	None
set Scenario(comp1,constraint,start) "start"	Used to specify the start time for the constraint on the component named 'comp1'. This is a required parameter for a constraint on a given component.	None
set Scenario(comp1,constraint,duration) "duration"	Used to specify the duration for the constraint on the component named 'comp1'. This is an optional parameter for a constraint on a given component.	None
set Scenario(comp1,constraint,translate) "0,1,0"	Used to specify the translation constraint on the component named 'comp1'. Three comma delimited values should be specified - one for each of the component directions. The values should be either '0' for unconstrained or '1' for constrained. This is an optional parameter for a constraint on a given component.	None
set Scenario(comp1,constraint,rotate) "0,1,0"	Used to specify the rotation constraint on the component named 'comp1'. Three comma delimited values should be specified - one for each of the component directions. The values should be either '0' for unconstrained or '1' for constrained. This is an optional parameter for a constraint on a given component.	None

Example

The following are example entries in an inputs.tcl file that are used to illustrate the generation of Scenario.xml. Note that this example is unrealistic - one would not specify both a prescribed and aero6dof motion on the same component. This is just for demonstration purposes.

set Scenario(angleunit) "radian"

set Scenario(rotor,prescribed,start) "0"
set Scenario(rotor,prescribed,duration) "100000"
set Scenario(rotor,prescribed,transforms) "rotate"

set Scenario(rotor,rotate,center) "0.0, 0.0, 0.0"
set Scenario(rotor,rotate,axis)   "1.0, 0.0, 0.0"
set Scenario(rotor,rotate,speed)  "-0.198846689"

set Scenario(rotor,translate1,velocity) "10.0, 10.0, 10.0"
set Scenario(rotor,translate1,frame) "body"

set Scenario(rotor,aero6dof,start) "0"
set Scenario(rotor,aero6dof,duration) "100000"
set Scenario(rotor,aero6dof,iprop,mass) "0"
set Scenario(rotor,aero6dof,iprop,com) "0,0,0"
set Scenario(rotor,aero6dof,iprop,pmi) "0,0,0"
set Scenario(rotor,aero6dof,iprop,axis) "0,0,0"
set Scenario(rotor,aero6dof,iprop,angle) "0"

set Scenario(rotor,aero6dof,appliedload,start) "0"
set Scenario(rotor,aero6dof,appliedload,frame) "inertial"
set Scenario(rotor,aero6dof,appliedload,force)  "1,1,1"
set Scenario(rotor,aero6dof,appliedload,moment) "2,2,2"
set Scenario(rotor,aero6dof,appliedload,center) "3,3,3"

set Scenario(rotor,aero6dof,constraint,start) "0"
set Scenario(rotor,aero6dof,constraint,translate) "1,1,0"
set Scenario(rotor,aero6dof,constraint,rotate) "0,0,1"

These above entries result in the following lines in the Scenario.xml file created by the BuildOveri script:

<?xml version='1.0' encoding='utf-8'?>
<Scenario AngleUnit='radian'>

<Prescribed Component='rotor' Start='0' Duration='100000'>
   <Rotate
         Center='0.0, 0.0, 0.0'
         Axis='1.0, 0.0, 0.0'
         Speed='-0.198846689'
         Frame='parent' />
</Prescribed>

<Aero6dof Component='rotor' Start='0' Duration='100000' >
   <InertialProperties
         Mass='0'
         CenterOfMass='0,0,0'
         PrincipalMomentsOfInertia='0,0,0' >
         <PrincipalAxesOrientation Axis='0,0,0' Angle='0'/>
   </InertialProperties>
   <AppliedLoad Start='0' Frame='inertial'
         Force='1,1,1'
         Moment='2,2,2'
         Center='3,3,3' />
   <Constraint Start='0' Translate='1,1,0' Rotate='0,0,1' />
</Aero6dof>

</Scenario>

MIXSUR Inputs

Parameter	Description	Default Value
set MIXSUR(fsmach) fsmach	Used by BuildMixsuri to set the freestream Mach number.	-0.2
set MIXSUR(alpha) alpha	Used by BuildMixsuri to set the freestream angle of attack.	400.0
set MIXSUR(beta) beta	Used by BuildMixsuri to set the freestream angle of sideslip.	400.0
set MIXSUR(rey) rey	Used by BuildMixsuri to set the freestream Reynolds number.	-1.0E6
set MIXSUR(gaminf) gaminf	Used by BuildMixsuri to set the freestream gamma.	-1.0E6
set MIXSUR(tinf) tinf	Used by BuildMixsuri to set the freestream temperature.	-100.0
set MIXSUR(nref) nref	Used by BuildMixsuri to set the number of reference conditions.	1
set MIXSUR(reftype,1) reftype	Used by BuildMixsuri to set the type of reference condition. This parameter is only used when MIXSUR(nref) is explictly set in inputs.tcl. Valid values are 'pointmoment1', 'pointmoment2', and 'hingeline'.	pointmoment1
set MIXSUR(refa) refa --or-- set MIXSUR(refa,1) refa	Used by BuildMixsuri to set the reference area. The first form is used when MIXSUR(nref) is not specified (i.e. only one reference condition is used). The second form is used when MIXSUR(nref) is explictly set in inputs.tcl.	1.0
set MIXSUR(refl) refl --or-- set MIXSUR(refl,1) refl	Used by BuildMixsuri to set the reference length. See the reference area description for which form to use.	1.0
set MIXSUR(refly,1) refly	Used by BuildMixsuri to set the reference length for the Y moment. This parameter is only used when MIXSUR(nref) is explictly set in inputs.tcl and MIXSUR(reftype,iref) for this reference condition number is set to 'pointmoment2'.	1.0
set MIXSUR(reflz,1) reflz	Used by BuildMixsuri to set the reference length for the Z moment. This parameter is only used when MIXSUR(nref) is explictly set in inputs.tcl and MIXSUR(reftype,iref) for this reference condition number is set to 'pointmoment2'.	1.0
set MIXSUR(xmc) xmc --or-- set MIXSUR(xmc,1) xmc	Used by BuildMixsuri to set the X-coordinate of the moment axis center. See the reference area description for which form to use.	0.0
set MIXSUR(ymc) ymc --or-- set MIXSUR(ymc,1) ymc	Used by BuildMixsuri to set the Y-coordinate of the moment axis center. See the reference area description for which form to use.	0.0
set MIXSUR(zmc) zmc --or-- set MIXSUR(zmc,1) zmc	Used by BuildMixsuri to set the Z-coordinate of the moment axis center. See the reference area description for which form to use.	0.0
set MIXSUR(xmh,1) xmh	Used by BuildMixsuri to set the X-coordinate of the hinge moment axis vector head. The parameter MIXSUR(xmc,iref) is used for the hinge moment axis vector base. This parameter is only used when MIXSUR(nref) is explictly set in inputs.tcl and MIXSUR(reftype,iref) for this reference condition number is set to 'hingeline'.	1.0
set MIXSUR(ymh,1) ymh	Used by BuildMixsuri to set the Y-coordinate of the hinge moment axis vector head. The parameter MIXSUR(ymc,iref) is used for the hinge moment axis vector base. This parameter is only used when MIXSUR(nref) is explictly set in inputs.tcl and MIXSUR(reftype,iref) for this reference condition number is set to 'hingeline'.	0.0
set MIXSUR(zmh,1) zmh	Used by BuildMixsuri to set the Z-coordinate of the hinge moment axis vector head. The parameter MIXSUR(zmc,iref) is used for the hinge moment axis vector base. This parameter is only used when MIXSUR(nref) is explictly set in inputs.tcl and MIXSUR(reftype,iref) for this reference condition number is set to 'hingeline'.	0.0
set MIXSUR(iref,comp1) iref	Used by BuildMixsuri to set the reference condition used for the mixsur component named 'comp1'. Both the integration surface (AKA family) and the component will use the reference condition number specified. This parameter is only used when MIXSUR(nref) is explictly set in inputs.tcl.	1
lappend priority(family_name_a) "zone1 zone2"	Used by BuildMixsuri to specify priorities within the mixsur input file. This gives zone1 priority over zone2 within the family named family_name_a.	none
lappend priority(family_name_a) "-zone1 -zone2"	Used by BuildMixsuri to specify priorities within the mixsur input file. Placing the minus sign in front of each zone name indicates to mixsur that these two zones abut one another and do not overlap.	none
set mixsurcomp(comp1) "comp2 comp3"	Used by BuildMixsuri to construct composite components within the mixsur input file. BuildMixsuri will automatically add a component for every family. This parameter can be used to specify a component that are combinations of other families. In this example, a component will be added called 'comp1' that is a combination of the 'comp2' and 'comp3' families. The components specified on the right side should be a space-delimited list of names and must already exist as mixsur families.	none

Misc. Info

• For debugging boundary conditions and family information, use the BuildPlot script. It can plot composite surfaces or volumes, using PLOT3D to assign color coding for visual debugging.
• Cleaning can be accomplished with the ScriptClean script.
• You can access further help for any of the scripts in chimera/bin by executing that script with the -help flag at the command line.