C++ API reference

Doxygen extracts declarations and source comments from OpenPFC public headers. Breathe renders the selected public contracts directly inside this Sphinx site. The API section is organized by user-facing concepts rather than by the physical include tree, so implementation helpers do not dominate navigation or search results.

Use the tour of main types for architectural orientation and the pages below for exact members and declarations.

• Data and domains
  • pfc::Domain
  • pfc::Box3i
  • Strong geometry values
  • pfc::Array
• Decomposition and FFT
  • pfc::decomposition::Decomposition
  • pfc::fft::IFFT
  • pfc::fft::CpuFft
• Simulation contracts
  • pfc::Model
  • pfc::Simulator
  • pfc::Time
  • pfc::FieldModifier
  • pfc::ResultsWriter
• Application frontend
  • pfc::ui::App
  • pfc::ui::SpectralCpuStack
  • pfc::ui::SpectralSimulationSession
• Execution and fields
  • pfc::View
  • pfc::data::Field
  • pfc::field::LocalField
  • pfc::field::PaddedBrick

The complete installed source-level contract remains the public headers under include/openpfc/. Add a type to this curated reference when it is a supported entry point users are expected to call directly.