How prisms-center/phasefield works
Project type and purpose
• This is an open-source, HPC‐oriented C++ library and application suite (PRISMS-PF) for phase-field simulations.
• It exposes a core library for finite-element PDE solves (matrix-free, deal.II‐based), plus ~24 prebuilt “application” executables (each realizing a particular PDE model), accompanied by testing harnesses, documentation, and postprocessing utilities.
File‐structure analysis
• Top‐level:
– CMakeLists.txt orchestrates build, versioning, and template expansion
– include/ & src/ contain the “prismspf” library source (modularized into core, solvers, user_inputs, utilities)
– applications/ holds standalone PDE applications (each in its own subfolder with main.cc, parameters.prm, custom_pde.h, etc.)
– tests/ holds automatic_tests (regression), performance_tests (scaling), unit_tests (Catch2‐based)
– contrib/ holds Python postprocessing and shell utilities
– doc/ holds Doxygen config and tutorial files
– GitHub workflows automate linting, compilation, CI, and docs deployment
• Key patterns:
– Modular layered library (core → solvers → problem setup → user I/O)
– Template instantiation macros (cmake/macros) to generate PDE operator code
– Plugin‐style applications linking against the common library
– CI pipelines building library, apps, running tests, generating docs
Insights from README
• Depends on external libraries: deal.II, p4est, Caliper, VTK for I/O
• Uses MPI for parallel execution
• Provides both Debug (main-debug) and Release builds
• Visualization via VTK‐format output (pvtu/vtu)