Loading
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 thedem.agglomerationtable and thedem.enable.agglomerationrow. It covers:model(none,central,beam),normalandmax_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 templatefile,massanddrag;- the multisphere coupling keys (
dem.multisphere.coupling,dem.multisphere.drag.model).
- Solids model (
solids_model.rst):[solid_name].shape(renamed fromdem.[solid_name].shape), withsphere,multisphereandsuperquadric;- the superquadric
semi_axesandexponents; - conduction for superquadric types.
- Initial conditions:
- templated ICs, with the two ways ICs place clumps (
placement=volfrac,countorfile), plus thecount,orientationandplacement.*keys; - the particle wet fraction.
- templated ICs, with the two ways ICs place clumps (
- Boundary conditions: the wet fraction of inflow particles.
- Model options:
mfix.drag.model = DiFeliceHoelzerSommerfeld. - Plotting:
wet_fraction,coordination,bond_rest_length,bond_neighbor_flags,orientationandsuperquadric_shape. - Reports: a Bond census section for
output.reports.bondsandoutput.reports.bonds.[bond_report_name].*(region,int,per_approx), with the report file's contents and an example. - Tools: new page
tools/clump_design.rstonmfix-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
gao2021andpodlozhnyuk2017entries still need their details checked against the papers.
- The
Checks
sphinx-build -E -Wis 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