nadnaps / lb3d Goto Github PK

=========================================================================

 Copyright 1999-2012, Owners retain copyrights to their respective works.

 This file is part of lb3d.

 lb3d is free software: you can redistribute it and/or modify it under
 the terms of the GNU Lesser General Public License as published by
 the Free Software Foundation, either version 3 of the License, or (at
 your option) any later version.

 lb3d 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 Lesser General Public
 License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with lb3d. If not, see <http://www.gnu.org/licenses/>.

=========================================================================

* Introduction

LB3D is an implementation of the lattice Boltzmann algorithm for ternary 
amphiphilic fluid mixtures and binary (im)miscible fluid mixtures. It is
written in Fortran90 and parallelized using MPI.

Below you find a quick start guide. Please refer to the user-manual in the
directory lb3d/doc/manual/ for further details.

* Requirements
 - Fortran compiler (Intel, IBM, Cray, GNU are known to work)
 - MPI implementaion (MPICH2, openMPI, MPVAPICH)
 - XDRF library for Fortran (Available at http://hpcv100.rc.rug.nl/xdrf.html)
 - Parallel HDF5 library (Available at http://www.hdfgroup.org)
 - GNU make
 - tar, patch, diff

To rebuild the documentation from sources
 - Doxygen 
 - pdflatex

* Installation of XDRF

 Download the xdrf library from http://hpcv100.rc.rug.nl/binaries/xdrf.tar.gz
 and unpack it into the directory lb3d/code/ 

tar xvf xdrf.tar.gz

Apply the patch provided there

patch -p0 < xdrf.patch

Done

* Configuration

Please review a suiting defines.PLATFORM file or create a new one for your platform from defines.TEMPLATE. You most likely need to adjust the compiler environment-variables and flags.

To trigger the configuration issue:

./configLB3D.sh CONFIG PLATFORM COMPILEROPTIONS

A typical example would be 

./configLB3D.sh CONFIG LINUX64 -DUSEXDRF -DUSEHDF

To compile the code to include three fluid components.

If the configuration is successful, the code can be compiled by issueing

./configLB3D.sh MAKE

If successfull, this will create a binary 'lb3d' in the directory lb3d/code/


* Running, issue for example to run two processes

mpirun -n 2 ./lb3d -f input-file

Please refer to the lb3d-manual in the directory lb3d/doc/manual/ for further 
details.

You can contact us via e-mail: [email protected]