PVFMM

Getting started

  • Introduction
    • Two evaluation modes
    • Method
    • Parallelism
    • Interfaces
    • References
  • Installation
    • Requirements
    • Building with autotools (primary)
      • Linking your own code (Makefile projects)
    • Building with CMake
    • Platform notes
    • Building this documentation
  • Getting started
    • 1. Clone and build
    • 2. Build the examples
    • 3. Run a particle FMM
    • 4. Run a volume FMM
    • 5. Where to go next

Tutorials

  • Particle FMM in C++
    • 1. Select a kernel
    • 2. Set up sources and targets
    • 3. Build the tree and load the operators
    • 4. Evaluate
    • 5. Re-evaluate with new densities
    • 6. Verify and clean up
  • Volume FMM in C++
    • 1. Define the source density
    • 2. Build the Chebyshev tree
    • 3. Load operators, set up, evaluate
    • 4. Beyond target-point values
  • Using the C and Fortran interfaces
    • Particle FMM in C (example-c.c)
    • Volume FMM in C (example2-c.c)
    • Fortran (example-f.f90, example2-f.f90)
  • Using the Python and Julia bindings
    • Python: particle FMM
    • Python: volume FMM
    • Julia: particle FMM
  • Test drivers and advanced usage
    • fmm_pts — particle FMM driver
    • fmm_cheb — volume FMM driver
    • example-sctl — PVFMM as a far-field backend for SCTL

Concepts

  • Kernel functions
    • Formulas
    • Double-layer sources
    • Custom kernels (C++)
  • Boundary conditions
  • Precomputed operator files
    • Search path
    • First-run cost
  • Performance and tuning
    • Accuracy/cost knobs
    • Parallel execution
    • Profiling

API reference

  • API reference
    • C++ interface
      • Kernel functions
      • Boundary conditions
      • Volume FMM
      • Particle FMM
      • Tree evaluation
    • C interface
      • Kernel selection
      • Boundary conditions
      • Volume FMM
      • Particle FMM
    • Fortran interface
      • Particle FMM
      • Volume FMM
    • Python interface
      • Installation and setup
      • FMMKernel
      • FMMBoundaryType
      • Particle FMM
      • Volume FMM
      • Examples
    • Julia interface
      • Installation and setup
      • FMMKernel
      • FMMBoundaryType
      • Particle FMM
      • Volume FMM
      • Tests as examples
PVFMM
  • Search

© Copyright 2010-2026, Dhairya Malhotra.

Built with Sphinx using a theme provided by Read the Docs.