diff --git a/tutorials/README.md b/tutorials/README.md new file mode 100644 index 00000000..7a603ef9 --- /dev/null +++ b/tutorials/README.md @@ -0,0 +1,40 @@ +# phasicFlow Tutorials + +This directory contains various tutorial examples to help you learn how to use phasicFlow for different particle simulation scenarios. Each tutorial provides a complete working example with configuration files and instructions. + + +## 1. Sphere DEM Simulations (`sphereGranFlow`) + +The most comprehensive collection of tutorials using spherical particles for DEM simulations: + +- [Rotating Drum (Small)](./sphereGranFlow/rotatingDrumSmall/) - Simple rotating drum simulation with 30,000 spherical particles (4 mm diameter) +- [Rotating Drum (Medium)](./sphereGranFlow/rotatingDrumMedium/) - Medium-sized rotating drum simulation +- [Rotating Drum with Baffles](./sphereGranFlow/RotatingDrumWithBaffles/) - Rotating drum with internal baffles and binary particle mixture +- [Rotating Drum with Periodic Boundaries](./sphereGranFlow/drum-PeriodicBoundary/) - Simulates an "infinite length" drum using periodic boundaries +- [V-blender](./sphereGranFlow/V-blender/) - V-shaped blender simulation for particle mixing +- [Tote Blender](./sphereGranFlow/toteBlender/) - Double pedestal tote blender simulation with 24,000 particles +- [Binary System of Particles](./sphereGranFlow/binarySystemOfParticles/) - Demonstrates particle segregation in a rotating drum with two particle sizes +- [Screw Conveyor](./sphereGranFlow/screwConveyor/) - Simulates particle transport using a screw conveyor +- [Conveyor Belt](./sphereGranFlow/conveyorBelt/) - Simulates particles on a moving conveyor belt +- [Rotary Air Lock Valve](./sphereGranFlow/RotaryAirLockValve/) - Simulates a rotary air lock valve with particle insertion +- [Layered Silo Filling](./sphereGranFlow/layeredSiloFilling/) - Demonstrates filling a silo with layers of particles +- [Homogenization Silo (Periodic Boundaries)](./sphereGranFlow/homogenizationSilo-PeriodicBoundary/) - Simulates homogenization in a silo with periodic boundaries + +## 2. Course-grained (Grain) DEM Simulations (`grainGranFlow`) + +Tutorials for simulations with non-spherical (grain-shaped) particles: + +- [Rotating Drum](./grainGranFlow/rotatingDrum/) - Demonstrates non-spherical grain particles in a rotating drum + +## 3. Geometry Iteration (`iterateGeometry`) + +Tutorials focused on geometry handling and visualization: + +- [Inclined Screw Conveyor](./iterateGeometry/inclinedScrewConveyor/) - Visualizes the geometry of an inclined screw conveyor without particles + +## 4. Post-processing (`postprocessPhasicFlow`) + +Tutorials focused on post-processing and analysis: + +- [Segregation Analysis](./postprocessPhasicFlow/segregation/) - Demonstrates how to analyze particle segregation in simulation results + diff --git a/tutorials/sphereGranFlow/V-blender/README.md b/tutorials/sphereGranFlow/V-blender/README.md index 323e659b..f9c02f08 100644 --- a/tutorials/sphereGranFlow/V-blender/README.md +++ b/tutorials/sphereGranFlow/V-blender/README.md @@ -5,7 +5,8 @@ This tutorial demonstrates the simulation of a V-blender, a common mixing device