
			How to use the Lgapack routines

				S. Zaleski
				zaleski@lmm.jussieu.fr

                                version 0.98


Copyright (C) 1997 D.H. Rothman and S. Zaleski. 

This code is covered by the GNU General Public License, see the file README.


CONTENTS

I.   General structure

There are four main directories, each corresponding
to one or several different models:

Fhp7_msite  
Fhp6_msite  
Fhp6_simp   
ilg

There are other directories that contain code written at MIT by
Olav Van Genabeek as supporting material for the course 
taught there by Dan Rothman. 

ilb2
lb3
mlb3

This code is structured differently from the rest of the package
but is included for whatever purpose this may serve. 

In addition, there are other directories

testdir           A directory for running simple tests of the code. 
processing	  A directory for preparing initial conditions 
                    and viewing the results.
parabolas         A directory for making experimental studies of Poiseuille
		    flows

General definitions about coding conventions are in the files macros_gen.h,
macros_ilg.h, macros_6.h, macros_7.h of each of the four main directories. 

For instance, particles are named A,B,C etc... with the following convention

/*
                    C             B
                      \        / 
                        \    /
              D   ------  G   ------  A
                        /    \
                       /      \
                    E            F
*/


                       -------------------

II. Installation

Please look at the INSTALL file. 


III. Table look up, 6-velocity code. 

This is the code Fhp6_simp. It may have solid sites, and an elementary 
form of gravity forcing. It correspondg to the FHP-I model of
Frisch, Hasslacher and Pomeau. See the file README in  directory Fhp6_simp
for more details.  


IVa. Multisite coding, 7-velocity code

This is the code Fhp7_msite. It may have solid sites, and an elaborate
form of gravity forcing. It corresponds to the FHP-III model of
Frisch et al. See the file README in directory "Fhp7_msite"
for more details.  

IVb. Multisite coding, 6-velocity code

This is the code Fhp6_msite. It is mainly derived from the 7-velocity
code. 

IVc. Multisite coding, 7-velocity code with LG interactions. 

This code is derived from the liquid-gas model of Appert and Zaleski. 
Its source is also in Fhp7_msite. It is created by a switch in file
parameter_7.h . The procedure for switching on interactions is
described in the file README in directory Fhp7_msite. 


V. ILG code

This is a 2D version of the ILG model 
of Rothman and Keller. Read the file README in directory "ilg". 


VI. Preparation of initial conditions and visualisation of results

Very elementary ways of preparing the flow boundary conditions
(aka solid sites) are provided. Some indications on how results
may be visualised are also indicated, but no graphics code is
present. The available tools and instructions are in directory "processing".
Please see the file README there. 


VII. Testing

No elaborate testing procedure exists at present. A shell script exists
in directory "testdir". It is written to run quickly all programs 
in a sequence. 

Experiments on Poiseuille flow may ultimately serve as a test,
but are still under construction (as of Feb 5 1997, version 0.98). 
To set up the experiment,  create the appropriate b.c.
as described in processing/README. Then use the appropriate
parameters in Fhp7_msite, taking as example the Makefile there or
directly editing in Fhp7_msite/parameters_7.h . 



