$Id: README,v 1.6 2000/08/23 06:08:50 pfem Exp $

A Python-based finite element program licensed under GPL. Current
capabilities are quite limited including 2-D and 3-D heat transfer
with phase change. The elasticity portion still needs to be
synchronized with the current version.  Input data file is in the
format of ABAQUS. Future capabilities will include large deformation,
large strain plasticity and other areas such as contact.

This version is a redesign of two previous versions used successfully
in research projects. Due to the redesign, which is still in progress,
the software is of pre-alpha quality. 

Python (1.5 or above) and Numerical Python are required.

Please see INSTALL.html for procedures to set up and run the program.
See WhitePaper.html for background information and possible future
directions of Pfem.

Directories:

config: configurations for options not supported by the ABAQUS input
        file.
design:	discussions on the design of the code.
doc:	documentation (incomplete).
geom:	geometry-related modules such as shape functions.
misc:	miscellaneous modules such as restart.
mv:	vector/matrix modules (except for LinAlg.c, the python wrapper
        of a few linear algebra routines, this module will be phased
        out - too slow).
phys:	physics-related modules such as materials, constitutive
	equations.
preproc: preprocessor, now uses ABAQUS input data format (limited)
         and a 'native' preprocessor.
postproc: postprocessor, now has only output in AVS format.
solver:	banded, skyline, conjugate gradient and bi-conjugate gradient
	solvers (some are in C and wrapped in Python).
struct: higher level structures that combine most of the modules
        together
test:	code to support testing.

ROADMAP for the code base:

There are two directions to go to understand the code. One is from
the highest level and the other is from lover levels. 

To study the code from the highest level, it is best to start with
~/struct/PfemStructNum.py to see the flow. Also see the main program
that uses PfemStructNum.py in ~/struct/heat/test/test_StructNum.py.

To study the code from lower levels, one can start with the independent
modules first (not prioritized): ~/pfem/preproc/abaqus,
~/pfem/geom, ~/pfem/solver etc.

More documentations and diagrams are forthcoming.