Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rymanderson committed Aug 6, 2024
1 parent 998962f commit 8218440
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,15 @@
*A fast, multi-system, multi-kernel, differentiable implementation of the fast multipole method for use with scalar-plus-vector potential N-body problems in pure Julia.*

Authors: Ryan Anderson and contributors

Features:

* Laplace $1/r$ kernel
* meant to incorporate seamlessly into existing Julia code without modifications (only additions to define a few interface functions)
* convenience functions for determining the expansion coefficients for source points, vortex points, source panels, and dipole panels (this list is growing!)
* $\mathcal{O}(p^4)$ multipole-to-local translation operator (where ```math p``` is the expansion order), though this may improve in the near future
* velocity and velocity gradient (or their equivalent for non-fluids problems) obtained using analytic expressions (no finite difference)
* CPU-parallelization for expansions and direct interactions
* GPU-parallelization for direct interactions using `CUDA.jl`
* `ForwardDiff` and `ReverseDiff` compatible

0 comments on commit 8218440

Please sign in to comment.