README 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. PVFMM README File
  2. *****************
  3. PVFMM Version 1.0.0 is the latest release (January 2014)
  4. WHAT IS PVFMM?
  5. ==============
  6. PVFMM is a library for solving certain types of elliptic partial
  7. differential equations.
  8. * We support Stokes, Poisson, and Helmholtz problems on the unit
  9. cube, with free-space or periodic boundary conditions, with
  10. constant or mildly varying coefficients. Our method is based on
  11. volume potential integral equation formulation accelerated by the
  12. Kernel Independent Fast Multipole Method.
  13. HOW TO GET PVFMM
  14. ================
  15. For the latest stable release of PVFMM
  16. <URL: padas.ices.utexas.edu/pvfmm.tgz>
  17. LICENSE
  18. =======
  19. PVFMM is distributed under the LGPLv3 licence. See COPYING in
  20. the top-level directory of the distribution.
  21. INSTALLING PVFMM
  22. ================
  23. To install PVFMM, follow the steps in the INSTALL file, which is
  24. located in the top directory of the source distribution.
  25. USING PVFMM
  26. ===========
  27. The file examples/Makefile can be used as a template makefile for any
  28. project using the library. In general the MakeVariables file should
  29. be included in any makefile and CXXFLAGS_PVFMM and LDFLAGS_PVFMM should
  30. be used to compile the code.
  31. Two very simple examples illustrating usage of the library are available:
  32. For particle N-body : examples/src/example1.cpp
  33. For volume potentials: examples/src/example2.cpp
  34. To compile these examples:
  35. make examples/bin/example1
  36. make examples/bin/example2
  37. * The volume potentials example will take a long time, the first time
  38. it is used, since it has to precompute quadrature rules. This data
  39. is saved to a file and used for subsequent runs. See INSTALL for
  40. the configure option '--with-precomp-dir=DIR' to set the default
  41. path for precomputed data.
  42. Acknowledgment
  43. ==============
  44. This software has been developed as part of the work supported by,
  45. * US National Institutes of Health/10042242
  46. * US Department of Energy/DE-SC0010518
  47. * US Department of Energy/DE-SC0009286
  48. * US National Science Foundation/CCF-1337393
  49. * US Air Force Office for Scientific Research /FA9550-12-10484
  50. The authors would also like to thank ORNL/OLCF and TACC for providing
  51. access to computing resources for the development, testing and
  52. benchmarking of this software.