DPM TUI Reference -- Complete Text User Interface Command Index for Fluent 2024 R1
#+CATEGORY: cfd
#+TAGS: DPM TUI command reference text-user-interface journal-scripting automation
#+MATURITY: growing
DPM TUI Reference :: Complete Command Index
This page is a comprehensive index of every TUI command related to the Discrete Phase Model in Fluent 2024 R1. Organized by task for quick lookup. All commands can be recorded in journal files for automation and reproducibility.
Model Activation and Configuration
define/models/discrete-phase (toggle DPM on/off)
define/models/discrete-phase/non-interactive (solve flow, then DPM)
define/models/discrete-phase/interactive-mode (enable coupling)
define/models/discrete-phase/track-time (steady tracking params)
define/models/discrete-phase/track-time/max-steps (set max tracking steps)
define/models/discrete-phase/unsteady-tracking (enable unsteady tracking)
define/models/discrete-phase/dense-discrete-phase (enable DDPM)
define/models/discrete-phase/dense-discrete-phase/ktgf/
> algebraic (KTGF algebraic)
> transport-equation (KTGF transport eq.)
define/models/discrete-phase/dense-discrete-phase/collision-model/
> stochastic (stochastic collision)
> nozzle (nozzle collision model)
> dem (discrete element method)
define/models/discrete-phase/dense-discrete-phase/restitution-coefficient
define/models/discrete-phase/dense-discrete-phase/packing-limitInteraction and Coupling
define/models/discrete-phase/interaction (interaction panel)
define/models/discrete-phase/interaction/coupling (coupling method)
define/models/discrete-phase/interaction/max-vf-allowed-for-blocking
define/models/discrete-phase/interaction/iterations (DPM iterations per coupling)
define/models/discrete-phase/interaction/under-relaxation (under-relaxation factor)
define/models/discrete-phase/interaction/drag-law/ (select drag model)
> spherical (Stokes/schiller-naumann)
> non-spherical (Haider-Levenspiel)
> user-defined (UDF hook)
define/models/discrete-phase/interaction/heat-law/ (heat transfer law)
define/models/discrete-phase/interaction/mass-law/ (mass transfer law)
define/models/discrete-phase/interaction/breakup-model/ (breakup model)
> tab (Taylor Analogy)
> wave (Reitz-DPKH)
define/models/discrete-phase/interaction/collision/ (collision model)
> stochastic
> off
define/models/discrete-phase/interaction/collision/coalescence/enable
define/models/discrete-phase/interaction/collision/coalescence/disablePhysical Models (Forces, Radiation, etc.)
define/models/discrete-phase/physical-models (physical models panel)
define/models/discrete-phase/physical-models/stochastic-tracking/enable
define/models/discrete-phase/physical-models/stochastic-tracking/number-of-tries
define/models/discrete-phase/physical-models/thermophoretic-force/enable
define/models/discrete-phase/physical-models/thermophoretic-force/disable
define/models/discrete-phase/physical-models/saffman-lift/enable
define/models/discrete-phase/physical-models/saffman-lift/disable
define/models/discrete-phase/physical-models/virtual-mass/enable
define/models/discrete-phase/physical-models/virtual-mass/disable
define/models/discrete-phase/physical-models/pressure-gradient/enable
define/models/discrete-phase/physical-models/pressure-gradient/disable
define/models/discrete-phase/physical-models/brownian-motion/enable (v2024R1+)
define/models/discrete-phase/physical-models/brownian-motion/disableInjection Setup
define/injections/ (injection management)
> create (new injection)
> delete (remove injection)
> list (all injections)
> rename (rename injection)
define/injections/create/
> single (single injection)
> group (injection group)
> file (file injection)
> conical (conical injector)
> solid-cone-atomizer (solid cone)
> hollow-cone-atomizer (hollow cone)
> ring (ring injection)
define/injections/create/single/
> type: surface / point / face (injection origin type)
> x0, y0, z0 (position)
> direction: x, y, z (direction vector)
> diameter: <value> (particle diameter [m])
> total-flow-rate: <value> (mass flow rate [kg/s])
> number-of-parcels: <value> (parcels to inject)
> material: <material-name> (particle material)
> size-distribution:
> uniform (constant diameter)
> log-normal (log-normal PSD)
> rosin-rammler (R-R distribution)
> custom (user-specified)
> start-time: <value> (transient: start [s])
> stop-time: <value> (transient: stop [s])
> interval: <value> (transient: interval [s])
> velocity: <value> (injection velocity [m/s])
> temperature: <value> (injection temperature [K])Boundary Conditions
define/boundary-conditions/ (set DPM BCs per zone)
define/boundary-conditions/wall/<zone-name>/dpm/
> trap (particle absorbed)
> escape (particle exits)
> reflect (elastic bounce)
> bounce (restitution coefficients)
> wall-jet (wall jet model)
> semi-reflect (sticking probability)
define/boundary-conditions/outlet/<zone-name>/dpm/
> escape (default for outlets)
define/boundary-conditions/inlet/<zone-name>/dpm/
> escape (default for inlets)
> reflect (if recirculation expected)
define/boundary-conditions/wall/<zone-name>/dpm/bounce/
> tangential-restitution: <value> (0-1)
> normal-restitution: <value> (0--1)
define/boundary-conditions/wall/<zone-name>/dpm/erosion/
> model: finnie / oka / user-defined
> parameters: ... (model-specific)Numerics and Solver Settings
solve/set/dpm-iterations <N> (set DPM iteration count)
solve/set/dpm-under-relaxation <factor> (set DPM URF)
solve/set/dpm-parallel yes/no (parallel DPM toggle)
solve/iterate (iterate continuous phase)
solve/dual-time-iterate <sub-its> <steps> (transient)
solve/set/discrete-phase/coupling-interval <N> (couple every N iterations)
solve/discrete-phase/iterations <N> (run DPM iterations)
solve/discrete-phase/interaction (iterate with coupling)Reporting and Sampling
report/discrete-phase/summary (global DPM statistics)
report/discrete-phase/injection-summary (per-injection statistics)
report/discrete-phase/sample (DPM sample at surface)
> surface: <name>
> sample-file: <filename.dpm>
> write-properties: yes/no
> include-cell-volume: yes/no
report/discrete-phase/histogram (property histogram)
> variable: diameter / velocity / temperature / time / mass
> number-of-bins: <N>
> range: <min> <max>
> weight: number / mass
report/discrete-phase/fluxes (mass/momentum flux report)
report/surface-integrals/area-weighted-avg (concentration on surface)
> surface: <name>
> field: dpm-concentrationGraphics and Display
display/particle-tracks (show particle trajectories)
> injections: <all / specific>
> color-by: velocity / diameter / temperature / time / mass
> style: line / arrow / point
> release-from-injection: yes/no
display/contours (concentration contours)
> contours-of: dpm-concentration
> surface: <plane / iso-surface>
> levels: <N>
> range: auto / manual <min> <max>
display/vectors (particle velocity vectors)
> surface: <plane>
> color-by: dpm-velocity-magnitudeUDF Hookup
define/user-defined/compiled-functions (compile/load UDF)
> compile "<filename.c>"
> load "libudf"
> unload
define/models/discrete-phase/interaction/drag-law/user-defined
> <function-name>
define/models/discrete-phase/physical-models/body-force/x-component/user-defined
> <function-name>
define/models/discrete-phase/physical-models/body-force/y-component/user-defined
> <function-name>
define/models/discrete-phase/physical-models/body-force/z-component/user-defined
> <function-name>
define/models/discrete-phase/physical-models/erosion-rate/user-defined
> <function-name>
define/models/discrete-phase/physical-models/boundary-condition/user-defined
> <function-name>Automation: Journal File Template
Complete journal file for a steady shisha PM2.5 DPM run:
; === DPM journal file for shisha PM2.5 ===
; Load case
(file/read-case "shisha_case.cas.h5")
; Enable DPM
(ti-menu-load-string "define/models/discrete-phase yes")
(ti-menu-load-string "define/models/discrete-phase/non-interactive")
; Set tracking
(ti-menu-load-string "define/models/discrete-phase/track-time/max-steps 5000")
; Enable stochastic tracking
(ti-menu-load-string "define/models/discrete-phase/physical-models/stochastic-tracking/enable")
(ti-menu-load-string "define/models/discrete-phase/physical-models/stochastic-tracking/number-of-tries 20")
; Enable thermophoretic force
(ti-menu-load-string "define/models/discrete-phase/physical-models/thermophoretic-force/enable")
; Set injection
(ti-menu-load-string "define/injections/create/single/type surface")
(ti-menu-load-string "define/injections/create/single/name bowl-outlet")
(ti-menu-load-string "define/injections/create/single/surface bowl-outlet-face")
(ti-menu-load-string "define/injections/create/single/diameter 1e-6")
(ti-menu-load-string "define/injections/create/single/total-flow-rate 5e-8")
(ti-menu-load-string "define/injections/create/single/number-of-parcels 50000")
(ti-menu-load-string "define/injections/create/single/material smoke-aerosol")
; Set wall BCs
(ti-menu-load-string "define/boundary-conditions/wall/chamber-walls/dpm/trap")
(ti-menu-load-string "define/boundary-conditions/outlet/hose-exit/dpm/escape")
; Solve continuous phase (should already be converged)
(ti-menu-load-string "solve/iterate 500")
; Solve DPM
(ti-menu-load-string "solve/set/dpm-iterations 2000")
(ti-menu-load-string "solve/discrete-phase/iterations 2000")
; Report summary
(ti-menu-load-string "report/discrete-phase/summary")
; Sample at breathing zone plane
(ti-menu-load-string "report/discrete-phase/sample breathing-zone-plane breathing_zone.dpm")
; Save results
(ti-menu-load-string "file/write-case-data shisha_dpm_results.cas.h5")
(exit)