User manual

Installation: installation, test, and dependencies, etc.

Basic usage: running simulation, particle shape reconstruction, post-processing, etc.

Computer tips: some useful tips in linux and computer methods, e.g., github token, DNS issue, etc.

Paraview rendering: hints and procedures in paraview visualization.

Blender rendering: hints and procedures in blender visualization.

CFD-DEM simulation: coupled CFD-DEM simulation using OpenFOAM NetDEM.

Read restart: restart simulation from saved state, both in DEM and CFD sides.

Python API reference

dem: defines the basic classes for dem calculations, including contact model, contact solver, etc.

domain:defines classes for domain management, including CellManager, Domain, DomainManager, etc.

fem: for FEM calculations, including TetMesh and Membrane, etc.

modifier: defines the classes for modify DEM calculations, such as adding gravity, dumping simulation data, prescribing particle velocities, etc.

mpi: for exchanging particle information through MPI parallel computing.

netdem: defines all the basic classes for NetDEM modelling, including utils, fem, dem, domain, peridigm, shape, scene, modifier, mpi, simulation, etc.

peridigm: interface to couple with peridigm for modeling particle breakage.

scene: defines the basic classes for DEM units, including Scene, Particle, Wall, ContactPP, etc.

shape: defines a variety of shapes, including Sphere, Ellipsoid, TriMesh, etc.

simulation: a class for handling all the resources of a DEM simulation, incluidng domain_manager, mpi_manager, modifier_manager, scene, dem_solver, mech_time, mech_cycles, enable_logging, etc.

utils: other ultility classes and functions, including Math, STLReader, STLModel, etc.

Python API reference

Python API (English)

dem: defines the basic classes for DEM calculations, including contact model, contact solver, etc.

domain: defines classes for domain management, including CellManager, Domain, DomainManager, etc.

fem: for FEM calculations, including TetMesh and Membrane, etc.

modifier: defines the classes for modifying DEM calculations, such as adding gravity, dumping simulation data, prescribing particle velocities, etc.

mpi: for exchanging particle information through MPI parallel computing.

netdem: defines all the basic classes for NetDEM modelling, including utils, fem, dem, domain, peridigm, shape, scene, modifier, mpi, simulation, etc.

peridigm: interface to couple with Peridigm for modeling particle breakage.

scene: defines the basic classes for DEM units, including Scene, Particle, Wall, ContactPP, etc.

shape: defines a variety of shapes, including Sphere, Ellipsoid, TriMesh, etc.

simulation: a class for handling all the resources of a DEM simulation, including domain_manager, mpi_manager, modifier_manager, scene, dem_solver, mech_time, mech_cycles, enable_logging, etc.

utils: other utility classes and functions, including Math, STLReader, STLModel, etc.

Python API (中文)

dem：DEM 接口模块（C++ 核心绑定）

domain：域管理模块（含并行划分）

fem：有限元模块（绑定 FEM 数据结构）

modifier：修饰器模块（用于添加物理场等）

mpi：并行通信模块（MPI 支持）

netdem：NetDEM 总入口模块，统一接口封装

peridigm：Peridigm 耦合模块（颗粒破坏模拟）

scene：场景与粒子定义模块

shape：几何与形状模块（Sphere, TriMesh 等）

simulation：模拟控制模块（顶层入口）

utils：实用工具模块（数学函数、读写等）