INTERFOAM(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

💖 interFoam 💖

okay bestie, sit down, hydrate, because we're about to talk about interFoam — and yes, it's part of OpenFOAM (The Open Source CFD Toolbox), and yes, it is that girl. This whole thing lives in the OpenFOAM Commands Manual, so like… you already know it's iconic. 🫶

✨ NAME ✨

interFoam — part of OpenFOAM (The Open Source CFD Toolbox). she's a solver. she's a legend. periodt. 👑

🌸 SYNOPSIS 🌸

interFoam [OPTIONS]

that's it. that's the whole summoning ritual. no positional args, just options, bestie. 💅

🦋 DESCRIPTION 🦋

okay so, what does she actually do? interFoam is a solver for two incompressible, isothermal immiscible fluids using VOF phase-fraction based interface capturing. two fluids. not mixing. not blending. literally refusing to combine, and we respect that energy fr fr. 🌊

and the plot twist? she comes with optional mesh motion and mesh topology changes including adaptive re-meshing. so the mesh can move, the topology can change, and she can re-mesh adaptively on top of that. main character behaviour honestly. 😭✨

🎀 OPTIONS 🎀

here's the whole menu, no skips, no cuts. every single one. 💖

  • -case dir — tell her which case directory to use (instead of the cwd, which is where she'd look by default).
  • -decomposeParDict file — use the specified file for the decomposePar dictionary.
  • -dry-run — just check the case set-up, using a single time step. a little vibe check before the real thing. 🧚
  • -dry-run-write — check the case set-up and write, using a single time step.
  • -parallel — run in parallel. [Parallel option]
  • -postProcess — execute functionObjects only.
  • -doc — display documentation in the browser. 🌈
  • -help — display short help and exit.
  • -help-full — display full help and exit.

💜 ADVANCED OPTIONS 💜

these are the deep cuts, iykyk. 🔥

  • -debug-switch name=val — specify the value of a registered debug switch. default is 1 if the value is omitted. (Can be used multiple times)
  • -fileHandler handler — override the file handler type.
  • -hostRoots ((host1 dir1) .. (hostN dirN)) — per-host slave root directories for distributed running. the host specification can be a regex. [Parallel option]
  • -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).
  • -listFunctionObjects — list functionObjects.
  • -listFvOptions — list fvOptions.
  • -listRegisteredSwitches — list switches registered for run-time modification (see -listUnsetSwitches option).
  • -listScalarBCs — list scalar field boundary conditions (fvPatchField<scalar>).
  • -listSwitches — list switches declared in libraries (see -listUnsetSwitches option).
  • -listTurbulenceModels — list turbulenceModels.
  • -listUnsetSwitches — modifies switch listing to display values not set in etc/controlDict.
  • -listVectorBCs — list vector field boundary conditions (fvPatchField<vector>).
  • -noFunctionObjects — do not execute function objects.
  • -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]
  • -doc-source — display source code in the browser. 👀
  • -help-man — display full help (manpage format) and exit.
  • -help-notes — display help notes (description) and exit.
bestie note: several of these bad boys are marked [Parallel option], so if you're not running parallel they're just sitting there looking cute. and remember -debug-switch, -info-switch, -opt-switch and -lib can all be used multiple times — stack them like accessories. 💅

🌟 SEE ALSO 🌟

go read it, it's giving knowledge. 📚✨

Copyright © 2018-2019 OpenCFD Ltd.

and that's the whole page, bestie!! 🎀 the footer round here says www.openfoam.com, version stamp OpenFOAM-, and the date slot is just kinda vibing empty — so consider this your cute little sign-off. go run some two-phase flow, you're gonna slay. 🦋💖🌸

📦 where this page comes from