|
1 | 1 | # Tutorials |
2 | 2 |
|
3 | | -## General |
4 | | -- [Setting up your simulation from scratch](tutorials/tut_setup.md) |
5 | | -- [Modifying or extending components of TrixiParticles.jl within a simulation file](tutorials/tut_custom_kernel.md) |
| 3 | +> New to TrixiParticles.jl? Start with [Setting up your simulation from scratch](tutorials/tut_setup.md). |
6 | 4 |
|
7 | | -## Preprocessing |
8 | | -- [Particle packing tutorial](tutorials/tut_packing.md) |
| 5 | +## Recommended Path |
| 6 | + |
| 7 | +1. [Setting up your simulation from scratch](tutorials/tut_setup.md): learn the structure of a simulation file and run a complete WCSPH example. |
| 8 | +2. [Modifying or extending components of TrixiParticles.jl within a simulation file](tutorials/tut_custom_kernel.md): replace selected parts of an existing setup without cloning the package. |
| 9 | +3. [Particle packing tutorial](tutorials/tut_packing.md): build a body-fitted particle configuration for complex geometries. |
| 10 | + |
| 11 | +## Tutorials |
| 12 | + |
| 13 | +### [Setting up your simulation from scratch](tutorials/tut_setup.md) |
| 14 | + |
| 15 | +```@raw html |
| 16 | +<img src="../tutorials/tut_setup_plot_tank.png" |
| 17 | + alt="Rectangular tank setup used in the first tutorial" |
| 18 | + style="max-width: 360px; width: 100%; border-radius: 12px;" /> |
| 19 | +``` |
| 20 | + |
| 21 | +Build a complete Weakly Compressible SPH dam break setup from particle spacing through |
| 22 | +semidiscretization, callbacks, and time integration. |
| 23 | + |
| 24 | +- Focus: initial conditions, systems, semidiscretization, callbacks |
| 25 | +- Choose this if: you want the full workflow for a minimal example |
| 26 | + |
| 27 | +### [Modifying or extending components of TrixiParticles.jl within a simulation file](tutorials/tut_custom_kernel.md) |
| 28 | + |
| 29 | +```@raw html |
| 30 | +<img src="../tutorials/tut_custom_kernel_plot2.png" |
| 31 | + alt="Kernel comparison plot from the custom kernel tutorial" |
| 32 | + style="max-width: 360px; width: 100%; border-radius: 12px;" /> |
| 33 | +``` |
| 34 | + |
| 35 | +Start from an existing simulation and replace pieces such as the smoothing kernel |
| 36 | +directly in the file you run. |
| 37 | + |
| 38 | +- Focus: `trixi_include`, custom kernels, rapid iteration |
| 39 | +- Choose this if: you want to prototype changes without cloning and modifying the package |
| 40 | + |
| 41 | +### [Particle packing tutorial](tutorials/tut_packing.md) |
| 42 | + |
| 43 | +```@raw html |
| 44 | +<img src="https://github.com/user-attachments/assets/0f7aba29-3cf7-4ec1-8c95-841e72fe620d" |
| 45 | + alt="Packed particle configuration for a complex geometry" |
| 46 | + style="max-width: 360px; width: 100%; border-radius: 12px;" /> |
| 47 | +``` |
| 48 | + |
| 49 | +Go from a geometry file to a packed particle distribution using signed distance fields |
| 50 | +together with boundary and interior sampling. |
| 51 | + |
| 52 | +- Focus: geometry import, signed distance fields, boundary sampling, `ParticlePackingSystem` |
| 53 | +- Choose this if: you need body-fitted particles for complex geometries |
| 54 | + |
| 55 | +See also [Getting started](getting_started.md) and [Examples](examples.md). |
0 commit comments