DRIFTFLUXFOAM(1)

πŸ“¦
version 1912.200626 Β· 2 versions
  • 1912.200626 Β· debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu stonking (latest)
  • 2512 Β· nixpkgs unstable
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu stonking

πŸ’– DRIFTFLUXFOAM πŸ’–

okay bestie, so this one lives in the OpenFOAM Commands Manual (that's the Open Source CFD Toolbox, no cap) and it's a whole solver. let's get into it 🫢


✨ NAME ✨

driftFluxFoam β€” part of OpenFOAM (The Open Source CFD Toolbox). that's the whole name, she's lowkey mysterious like that πŸ’…


✨ SYNOPSIS ✨

driftFluxFoam [OPTIONS]

✨ DESCRIPTION ✨

okay so picture this: it's a solver for two incompressible fluids using the mixture approach, with the drift-flux approximation handling the relative motion of the phases. it's giving physics but make it ✨relative✨

it's used for simulating the settling of the dispersed phase and other similar separation problems. so like, when stuff separates out and one phase settles β€” that's her moment, that's her main character energy πŸ‘‘


✨ OPTIONS ✨

  • -case dir β€” tell her which case directory to use instead of the cwd. (the cwd is so last season, we love a specified directory πŸ’–)
  • -decomposeParDict file β€” use the specified file for the decomposePar dictionary. custom dict? iconic.
  • -dry-run β€” check the case set-up only, using a single time step. a little vibe check before the real thing πŸ¦‹
  • -dry-run-write β€” check the case set-up and write, only using a single time step. vibe check + actually commit to the bit.
  • -parallel β€” run in parallel. [Parallel option] she's bringing the whole friend group πŸ«‚
  • -postProcess β€” execute functionObjects only. no solving, just the little extras ✨
  • -doc β€” display documentation in browser. reading is fundamental bestie πŸ“–
  • -help β€” display short help and exit. the quick version, for when you're in a rush πŸƒ
  • -help-full β€” display full help and exit. the deluxe version, all the tea β˜•

🌸 ADVANCED OPTIONS 🌸

  • -debug-switch name=val β€” specify the value of a registered debug switch. the default is 1 if the value is omitted. (can be used multiple times β€” go off, stack them πŸ’…)
  • -fileHandler handler β€” override the file handler type. you're in charge of the handler now, queen.
  • -hostRoots ((host1 dir1) .. (hostN dirN)) β€” per-host slave root directories for distributed running. the host specification can be a regex. [Parallel option] so fancy ✨
  • -info-switch name=val β€” specify the value of a registered info switch. default is 1 if the value is omitted. (can be used multiple times πŸŽ€)
  • -lib name β€” additional library or library list to load (can be used multiple times). collect them all 🌈
  • -listFunctionObjects β€” list functionObjects. a little show-and-tell.
  • -listFvOptions β€” list fvOptions. same energy, different list πŸ’œ
  • -listRegisteredSwitches β€” list switches registered for run-time modification (see the -listUnsetSwitches option). iykyk.
  • -listScalarBCs β€” list scalar field boundary conditions (fvPatchField<scalar>). scalars say hi πŸ‘‹
  • -listSwitches β€” list switches declared in libraries (see the -listUnsetSwitches option). library switches, the whole crew 🫢
  • -listUnsetSwitches β€” modifies switch listing to display values not set in etc/controlDict. the ones that didn't show up to the party πŸ™ˆ
  • -listVectorBCs β€” list vector field boundary conditions (fvPatchField<vector>). now the vectors get their turn ⭐
  • -noFunctionObjects β€” do not execute function objects. sorry girlies, they're not coming πŸ’€
  • -opt-switch name=val β€” specify the value of a registered optimisation switch (int/bool). default is 1 if the value is omitted. (can be used multiple times πŸ”₯)
  • -roots (dir1 .. dirN) β€” slave root directories for distributed running [Parallel option]. roots, but make them distributed 🌱
  • -doc-source β€” display source code in browser. going straight to the source, ngl.
  • -help-man β€” display full help (manpage format) and exit. hi, that's literally what you're reading πŸ’–
  • -help-notes β€” display help notes (description) and exit. the notes version, for the lore πŸ“

✨ SEE ALSO ✨

online documentation, bestie: https://www.openfoam.com/documentation/


Copyright Β© 2018-2019 OpenCFD Ltd.


just a heads up: -parallel, -hostRoots and -roots are all tagged as [Parallel option], and both -listRegisteredSwitches and -listSwitches point you at -listUnsetSwitches for the full picture. also -debug-switch, -info-switch, -opt-switch and -lib can each be used multiple times. don't forget it 🫢

and that's the whole page, bestie πŸ’… source and version, as promised: www.openfoam.com, OpenFOAM- β€” that's the version string, she's a little cryptic but we love her anyway πŸŽ€βœ¨ go simulate something gorgeous, mwah πŸ’–