cwangcq / clump Goto Github PK

What CLUMP does • Architectural features • File tree • Simple example • Credits • BYOS Acknowledging CLUMP

CLUMP is a collection of scripts to generate multi-sphere particles of overlapping or non-overlapping spheres, to approximate target geometries. The motivation behind developing CLUMP stemmed from the need to compare different clump-generation techniques, both in terms of particle morphology and mechanical performance. To this, CLUMP offers (to date) two existing and well established clump-generation techniques and proposes a new one. The generated clumps can be exported to various formats, compatible with some of the most prominent DEM codes. Last, the surface of each created clump can be extracted as a triangulated mesh, allowing for a full characterisation of particle morphology, using tools like SHAPE.

CLUMP comprises the following modules:

• GenerateClump

  • Favier et al (1999)
  • Ferellec and McDowell (2010)
  • Euclidean 3D (proposed in this code)

• ExportClump

  • YADE
  • LAMMPS
  • EDEM
  • PFC3D

• CharacteriseClump

  • Surface extraction

• CLUMP
  • LICENSE
  • README.md
  • README.txt
  • classes (Definition of objects)
  • examples
  • figures
  • functions
  • lib (External dependencies)

This example demonstrates different approaches to generate clumps for the same target geometry. The variables below are documented within each function.

addpath(genpath('functions'));	% Load in-house functions
addpath(genpath('lib'));		% Load external functions (dependencies)
addpath(genpath('classes'));	% Load object-oriented architecture

% Generate clumps using the approach of Ferellec and McDowell (2010)
[mesh, clump]=GenerateClump_Ferellec_McDowell( stlFile, dmin, rmin, rstep, pmax, seed, output );

% Generate clumps using the approach proposed in this code, involving the Euclidean transform of 3D images
[mesh, clump]=GenerateClump_Euclidean_3D( stlFile, N, rMin, div, overlap, output );

New users are advised to start from running the available examples in the examples folder, to get familiarised with the syntax and functionalities of CLUMP.

CLUMP uses several external functions available within the Matlab FEX community. We want to acknowledge the following contributions:

• Qianqian Fang - Iso2Mesh
• Luigi Giaccari - Surface Reconstruction From Scattered Points Cloud
• Pau Micó - stlTools
• Anton Semechko - Rigid body parameters of closed surface meshes

These external dependencies are added within the source code of CLUMP, to provide an out-of-the-box implementation. The licensing terms of each external dependency can be found inside the lib folder.

If you enjoy using CLUMP, you are welcome to require the implementation of new clump-generation approaches and features or even better contribute and share your implementations. CLUMP was created to provide a comparison of different methods, by collecting them in one place and we share this tool hoping that members of the community will find it useful. So, feel free to expand the code, propose improvements and report issues.

Angelidakis, V., Nadimi, S., Otsubo, M. and Utili, S., 2021. CLUMP: A Code Library to generate Universal Multi-sphere Particles. SoftwareX 15, p.100735.

Download BibTeX entry