Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 4.02 KB

README.md

File metadata and controls

51 lines (37 loc) · 4.02 KB
Raw

IBAMR - CMake-ified git mirror

What Is IBAMR?

IBAMR is a distributed-memory parallel implementation of the immersed boundary (IB) method with support for Cartesian grid adaptive mesh refinement (AMR). Support for distributed-memory parallelism is via MPI, the Message Passing Interface. Support for spatial adaptivity is via SAMRAI, the Structured Adaptive Mesh Refinement Application Infrastructure, which is developed at the Center for Applied Scientific Computing at Lawrence Livermore National Laboratory.

This implementation of the IB method also makes extensive use of functionality provided by several high-quality third-party software libraries, including:

  • PETSc, the Portable, Extensible Toolkit for Scientific Computation,
  • hypre, a library of high performance preconditioners that features parallel multigrid methods for both structured and unstructured grid problems,
  • HDF5, a general purpose library and file format for storing scientific data,
  • Blitz++, a high-performance C++ array class library, and
  • Silo, a general purpose I/O library and file format for storing scientific data for visualization and post-processing.

IBAMR outputs visualization files that can be read by the VisIt Visualization Tool. Work is also underway to implement support for finite element mechanics models in IBAMR via the libMesh finite element library.

What Is the IB Method?

The immersed boundary (IB) method is a general-purpose numerical method for simulating fluid-structure interaction. The IB formulation of such problems uses an Eulerian description of the fluid and a Lagrangian description of the structure. Interaction equations that take the form of integral equations with delta function kernels couple the Eulerian and Lagrangian variables.

For general information about the IB method, see http://math.nyu.edu/faculty/peskin. For visualizations of simulations that use IBAMR, see http://cims.nyu.edu/~griffith.

Getting Started

  1. [Download CMake] (http://www.cmake.org)

  2. [Clone the repository] (http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository#Cloning-an-Existing-Repository)

     $ git clone git://github.com/MSV-Project/IBAMR.git

  3. CMake workflow:

     $ mkdir ibamr-debug # Create out of source directory to build IBAMR
 $ cd ibamr-debug
 $ cmake source_directory # Generate necesary cmake files to build IBAMR
 $ ccmake source_directory # Customize build by specifying variables

Source code documentation for IBAMR is available [on-line] (http://ibamr.googlecode.com/svn/doc/ibamr/HEAD/html/annotated.html). Source code documentation is also available for the IBTK support library. File format documentation is also available on-line.

Guidelines on how to contribute to the IBAMR project.

Support

Support for IBAMR is available from the IBAMR Developers (ibamr-dev) Google Group. There is also list of frequently asked questions.

Bugs and Other Issues

Please use the Google Code issue tracking system to report bugs, feature requests, or other issues with IBAMR. A list of issues is available.

Acknowledgments

IBAMR development is supported in part by an NSF Software Infrastructure for Sustained Innovation award (NSF OCI 1047734). Work to extend IBAMR to support finite element mechanics models is also supported in part the NSF (NSF DMS 1016554). We gratefully acknowledge this support.