• Packing List
  1. Makefiles
  2. Header Files
  3. Program Source Files
  4. Support Routine Source Files
  5. Documentation
• Back to Contents Page

Packing List

The following list provides brief descriptions of the files in the distribution. Most of the links within this page will not function unless you have the package installed and the ../source directory is accessible. Since moving over to using RCS as a way of maintaining the source files, you need to have all of the appropriate files "checked out" also.

Makefiles

makefile

Master make file which invokes make.mb_cns with options appropriate for each compiler and environment. For example, to build the package for use on a SGI Power Challenge, type "make for_sg" at the UNIX prompt.

make.mb_cns

Lists all of the files and their dependencies for UNIX and GNU environments.

make.watcom

Lists all of the files and dependencies for the Watcom C/C++ compiler.

Header Files

mb_cns.h

Header file with the definitions for macros, data structures and function prototypes.

compiler.h

Compiler-specific switches. When porting between platforms, this should be the only file that needs to be changed. For standard (ANSI) compilers, the code should need no changes.

ivdep.h

Ignore vector dependency for the Cray C and Fujitsu VCC compilers.

qd_power.h

Approximate power function (macro version)

ssp.h, gd.h

Header files for the plotting functions.

Program Source Files

scriptit.c

A script interpreter that takes a written description of the geometry and flow. This program then produces the Bezier geometry description file and the input parameter file to be used by mb_prep and mb_cns

mb_prep.c

The pre-processor which sets up the grid and initial flow files.

mb_cns.c

The CFD solver program. All that this program does is to read some parameters from a "parameter file", read a "grid file" and an "initial flow file", and then loop a number of times to integrate the governing equations in time. A flow solution may be written periodically.

mb_post.c

The post-processor which can read a solution file containing several snap-shots of the flow field and then write out an individual solution, possibly in a format suitable for a visualisation package. Currently, the output format is ASCII and is compatible with the TECPLOT graphics program, EnSight, MATLAB or our home-grown SSP package.

mb_prof.c

Another post-processor used to extract data profiles (along index directions) from the solution file.

mb_hist.c

Extract data from the "history file". This file may contain detailed (historical) data for a small number of cells.

contour.c

A contouring/visualisation program that can read the data from mb_post and produce a GIF or postscript file. To avoid naming conflict, the executable is actually called mb_cont.exe.

Support Routine Source Files

mb_blurb.inc

Fragment of code for writing out the current version number and compiled environment.

mb_drag.inc

Fragment of code to compute the pressure drag (and save it to a file) for a number of special cases.

mb_cfg.c

Routines to initialise and manage out the code configuration. These routines essentially encapsulate some of the global configuration data.

mb_exch.c

Routines to exchange boundary data between adjoining blocks.

mb_init.c

Routines to read the input parameter file, set up and initialise the flow-field data.

cns_bc.c

Apply the inviscid and viscous boundary conditions.

cns_geom.c

Geometry related routines (compute areas, cell centroids etc...)

cns_invs.c

Coordinate the computation of the inviscid-fluxes.

cns_inth.c

Interpolation/reconstruction for horizontal interfaces.

cns_intv.c

Interpolation/reconstruction for vertical interfaces.

cns_io.c

Input/Output routines. These routines are also used by the pre- and postprocessing programs.

cns_tstp.c

Time-stepping routines. Estimation of time derivatives, Euler and predictor-corrector updates, encoding/decoding of conserved quantities, CFL check.

cns_turb.c

Turbulence model. (Currently, the Baldwin-Lomax eddy-viscosity model)

cns_visc.c

Compute viscous-fluxes.

rivp.c

Approximate Riemann solver for inviscid flux calculation.

efm.c

Macrossan and Pullin's equilibrium flux calculator.

ausm.c

AUSM flux-splitting by Liou and Steffen.

ausmdv.c

A 1D flux calculator based on Wada & Liou's AUSMDV scheme.

gas.c

Gas model: Equation of State, Thermodynamic and transport properties.

tgas1.c, tgas1.h

A C version of the Srinivassan-Tannehill curve-fits for equilibrium air thermodynamics.

co2eq.c, co2eq.h

Ian Johnston's equilibrium carbon-dioxide routines.

n2eq.c, n2eq.h

Nitrogen in chemical/thermodynamic equilibrium.

roberts.c, roberts.h

Routines to distribute points with a specified clustering.

massage.c, massage.h

Grid smoothing routines by Andrew McGhee.

bezier.c, bezier.h

Bezier curve routines for defining block boundaries.

geom.c, geom.h

Basic geometry routines.

logfile.c, logfile.h

Message logging routines. All functions should output to the screen via these routines so that the messages can also be logged to a file.

s_string.inc, s_flow.inc, s_geom.inc, s_cntrl.inc, s_write.inc

Components of the scriptit program. These components include a set of routines for manipulating strings, an interpreter for the geometry definition, the flow definition and the time-stepping control of the simulation. The data is written to the Bezier and Input parameter files by the routines in s_write.inc.

sspkern.c, ssp.c, ssp3d.c, sspmisc.c, sspcont.c

Plotting functions used by mb_cont.

gd.c

Thomas Boutell's GIF creation functions.

Documentation

mb_cns.ps.gz

A postscript version of Report 10/96 ready for printing.

mb_cns.html

Index file to the hypertext documentation

mb_intro.html

Preamble and other formalities.

mb_files.html

The packing list (this file).

mb_build.html

Instructions for building the executables.

mb_use.html

A discussion of the use of the programs within package and a couple of examples.

mb_pfile.html

A description of the Input Parameter File format.

mb_bez.html

A description of the Bezier Geometry File format.

scriptit.html

Instructions for using the preprocessing script interpreter.

mb_prep.html

Brief instructions for the grid-generation preprocessor.

mb_cns2.html

Brief instructions for running the main NS integration program.

mb_post.html

Brief instructions for running the postprocessor that reformats the solution data.

mb_prof.html

Instructions for running the postprocessor that extracts profile data.

mb_hist.html

Instructions for the postprocessor that extracts the history data.

mb_cont.html

Instructions for the contouring/plotting program.