CYTRAN 2.1

W.A. Houlberg, ORNL
houlbergwa@ornl.gov
865-574-1350


Files
------------------------------------------------------------------------

From the tarred/zipped files you should get the directory structure:

  \cytran          -main directory
    \bin           -binaries
    \dat           -data
    \doc           -documentation
    \results       -results
    \src           -source code

In the \src subdirectory are the Fortran 90 source routines:

  cytran_dr.f90         Driver for CYTRAN
  com cytran_mod.f90    CYTRAN module
  com spec_kind_mod.f90 Precision specification module
  com x_mod.f90         Cross-section and reaction rate module
  com setup_ajax.f90    Routines to set up AJAX
  com ajax_mod.f90      Plasma MHD equilibrium interface module
  com linear1_mod.f90   1D linear interpolation module
  com spline1_mod.f90   1D spline interpolation module
  com write_mod.f90     Formatted output module

Also in the \src subdirectory is the makefile.  The makefile requires
an environment variable, CPU, that can be set in any one of three ways
for the system you are using:

1) Set externally before executing make, e.g.,

setenv CPU SOL

2) Set internally by inserting a line in the makefile before first usage,
    e.g.,

CPU=SOL

3) Set when executing the makefile, e.g.,

make CPU=SOL cytran

Incorporated options are: DEC, HP, IBM, J90, NAG, PGI, SGI, and SOL.

Options for running the makefile are:

make             -compile and load CYTRAN
make cytran      -compile and load CYTRAN
make test        -run with default namelist file
make fire        -run FIRE test case
make ignitor     -run IGNITOR test case
make iter        -run ITER test case
make all         -run all test cases
make clean       -remove all .o and .mod files


There are three test cases -- ITER, FIRE, and IGNITOR -- in the \dat
directory.  Each test case generates three output files:

1d_cytran.dat         1D output along path for IDL postprocessing
sum_cytran.dat        1D output along path for viewing with editor
msg_cytran.dat        Error, warning and other messages

Sample output files for each test case have a case name appended and
either _4 or _8 designating the precision set in spec_kind_mod.f90,
which can be editted to change the precision.


Documentation
------------------------------------------------------------------------
This documentation was generated in LaTeX.  Contact me
(houlbergwa@ornl.gov) for the LaTeX source files.  There is a 14-page
document (/cytran/doc/cytran.pdf) describing the CYTRAN module in
detail. 
