README

This is the first public release of the Stokes library in R^3.
Date: May 30, 2012

Version 1.2 - First external release.

%% Copyright (C) 2010-2012: Leslie Greengard and Zydrunas Gimbutas
%% Contact: greengard@cims.nyu.edu
%% 
%% This program is free software; you can redistribute it and/or modify 
%% it under the terms of the GNU General Public License as published by 
%% the Free Software Foundation; either version 2 of the License, or 
%% (at your option) any later version.  This program is distributed in 
%% the hope that it will be useful, but WITHOUT ANY WARRANTY; without 
%% even the implied warranty of MERCHANTABILITY or FITNESS FOR A 
%% PARTICULAR PURPOSE.  See the GNU General Public License for more 
%% details. You should have received a copy of the GNU General Public 
%% License along with this program; 
%% if not, see <http://www.gnu.org/licenses/>.


src/ - Fortran source code
examples/ - Fortran testing drivers and makefiles
matlab/ - matlab scripts and mex files 
contrib/mwrap-0.33.3/ - mwrap source code

To test the library, please type 'make test'. 


Fortran
=======


Particle FMM routines.

stfmm3dpartself - Stokes particle FMM in R^3.
sthfmm3dpartself - Stokes half-space particle FMM in R^3.
lfmm3dpartquadself - Supplementary Laplace particle FMM in R^3.

stfmm3dparttarg - Stokes particle target FMM in R^3.
sthfmm3dparttarg - Stokes half-space particle target FMM in R^3.
lfmm3dpartquadtarg - Supplementary Laplace particle target FMM in R^3.



Direct evaluation routines.

st3dpartdirect - Stokes particle interactions in R^3.
sth3dpartdirect - Stokes half-space particle interactions in R^3.
l3dpartquaddirect - Supplementary Laplace particle interactions in R^3.



Matlab
======

% Particle FMM routines.
%   stfmm3dpart - Stokes particle FMM in R^3.
%   sthfmm3dpart - Stokes half-space particle FMM in R^3.
%   lfmm3dpartquad - Supplementary Laplace particle FMM in R^3.
%
% Direct evaluation routines.
%   st3dpartdirect - Stokes particle interactions in R^3.
%   sth3dpartdirect - Stokes half-space particle interactions in R^3.
%   l3dpartquaddirect - Supplementary Laplace particle interactions in R^3.
%
% Field postprocessing routines.
%   st3stress - Evaluate stress tensor from p and \grad u.
%   st3strain - Evaluate strain tensor from \grad u.
%   st3traction - Evaluate traction vector from p, \grad u, and n.
%   st3stress2traction - Evaluate traction vector from stress tensor and n.
%