Skip to main content

Manual

Use the sidebar to browse every guide—under Getting Started, Phynexis Overview comes first for the product summary; Start here (this page) is the manual hub with setup tables and links to everything else, then installation, usage, and visualization. The header API menu jumps straight to Python or C++ reference pages.

Setup​

StepPage
Read the product overviewPhynexis overview
Install the Python packageInstallation
Run simulations from PythonBasic usage

Product overview​

PageWhat it covers
Phynexis overviewModules, particle shapes, capabilities
CFD–DEM simulationFluid–particle coupling
Restart and checkpointContinuing runs

Visualization​

PageWhat it covers
ParaView renderingScientific visualization
Blender renderingOffline rendering

Developer guide​

For anyone extending the C++ core or bindings: read Architecture & development first (profiling, pybind rules, Doxygen). Environment and tooling for building or running on clusters are grouped here too.

PageWhat it covers
Architecture & developmentCode layout, lifecycle, coding standards
Pybind11 binding stylePython binding conventions
Docker & HPCContainers and clusters
Developer toolsGitHub CLI, proxies, workstation setup

Theory & models​

PageWhat it covers
Theory overviewHub linking DEM basics, homogenization, particle models
DEM basicsDiscrete element fundamentals
Discrete to continuumContinuum stress / homogenization (page body in Chinese — draft)
Particle modelsPoly-super-ellipsoid formulations (page body in Chinese — draft)

API reference​

Python reference pages use their own left sidebar (module tree only). Open API → Python or the Python API overview to switch.

ResourceHow to open
PythonHeader API → Python, or Python API overview
C++Header API → C++ (Doxygen) (new tab), or Doxygen HTML

Outside this manual​