Document DEM bonds, templates and clumps, and superquadric types

Summary

This MR documents the inputs added by exa/mfix!1898 and must merge together with it. The GUI specs in that MR are generated from this branch.

Changes

  • DEM model (dem_model.rst): a new Bonds section replaces the dem.agglomeration table and the dem.enable.agglomeration row. It covers:
    • model (none, central, beam), normal and max_bonds;
    • when initial bonds are made (initial, initial.tolerance);
    • bond formation by liquid bridges;
    • the per-pair-of-types spring, damping, beam, breakage and critical-Stokes inputs.
  • Templates (new page templates.rst, after the PIC model):
    • dem.templates, check_cells, and per template file, mass and drag;
    • the multisphere coupling keys (dem.multisphere.coupling, dem.multisphere.drag.model).
  • Solids model (solids_model.rst):
    • [solid_name].shape (renamed from dem.[solid_name].shape), with sphere, multisphere and superquadric;
    • the superquadric semi_axes and exponents;
    • conduction for superquadric types.
  • Initial conditions:
    • templated ICs, with the two ways ICs place clumps (placement = volfrac, count or file), plus the count, orientation and placement.* keys;
    • the particle wet fraction.
  • Boundary conditions: the wet fraction of inflow particles.
  • Model options: mfix.drag.model = DiFeliceHoelzerSommerfeld.
  • Plotting: wet_fraction, coordination, bond_rest_length, bond_neighbor_flags, orientation and superquadric_shape.
  • Reports: a Bond census section for output.reports.bonds and output.reports.bonds.[bond_report_name].* (region, int, per_approx), with the report file's contents and an example.
  • Tools: new page tools/clump_design.rst on mfix-clump-design, including how to build it with CMake or GNU make.
  • References (refs.bib): Hölzer and Sommerfeld (2008), Di Felice (1994), Gao et al. (2021, SuperDEM) and Podlozhnyuk et al. (2017).
    • The gao2021 and podlozhnyuk2017 entries still need their details checked against the papers.

Checks

  • sphinx-build -E -W is clean.
  • codespell --ignore-words-list oint,strack,HEP --quiet-level 2 docs/source_docs/ docs/picvva/ is clean.
  • The latest pipeline passes.
Edited by Jordan Musser

Merge request reports

Loading
Loading