FIREFOAM(1)

💖 FIREFOAM(1) — the OpenFOAM Commands Manual glow-up 💖

okay bestie, you found your way into the OpenFOAM Commands Manual, and the star of this page is fireFoam, which is, and I quote the vibes here, part of OpenFOAM (The Open Source CFD Toolbox). yes queen, we're doing computational fluid dynamics today. hydrate. 💅

---

✨ NAME ✨

fireFoam — part of OpenFOAM (The Open Source CFD Toolbox). that's literally it, that's the whole name section, she's brief and she's iconic 🎀

---

🦋 SYNOPSIS 🦋

fireFoam [OPTIONS]

that's the whole summoning ritual. no positional args, just vibes and flags, fr fr.

---

🔥 DESCRIPTION 🔥

okay so listen. fireFoam is a transient solver for fires and turbulent diffusion flames 🚒✨

and the way that it does this is with:

• reacting particle clouds
• surface film
• pyrolysis modelling

like. it's literally simulating fire. main character energy, no cap. 🔥👑

---

💅 OPTIONS 💅

every single one, bestie, we are not skipping a single flag:

• -case dir — pick which case directory to use instead of the cwd (your current working directory, aka "wherever I happen to be standing")
• -decomposeParDict file — use the file you specify for the decomposePar dictionary
• -dry-run — check the case set-up only, using a single time step (a little test run, a vibe check, if you will)
• -dry-run-write — check the case set-up and write, only using a single time step
• -parallel — run in parallel. it's giving [Parallel option] 🏃‍♀️🏃‍♀️
• -postProcess — execute functionObjects only
• -doc — display documentation in your browser 🌐
• -help — display short help and dip out
• -help-full — display full help and dip out

🌈 ADVANCED OPTIONS 🌈

for when you're feeling brave. or desperate. either way, valid. 🫶

• -debug-switch name=val — specify the value of a registered debug switch. default is 1 if you omit the value. (can be used multiple times, go off)
• -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, she's flexible like that. [Parallel option]
• -info-switch name=val — specify the value of a registered info switch. default is 1 if you omit the value. (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 the -listUnsetSwitches option, they're besties)
• -listScalarBCs — list scalar field boundary conditions (fvPatchField<scalar>)
• -listSwitches — list switches declared in libraries (see the -listUnsetSwitches option)
• -listTurbulenceModels — list turbulenceModels
• -listUnsetSwitches — modifies the 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 you omit the value. (can be used multiple times)
• -roots (dir1 .. dirN) — slave root directories for distributed running [Parallel option]
• -doc-source — display source code in your browser
• -help-man — display full help (manpage format) and exit
• -help-notes — display help notes (description) and exit

---

👀 SEE ALSO 👀

Online documentation, bestie, go read it: https://www.openfoam.com/documentation/

---

©️ COPYRIGHT ©️

Copyright © 2018-2019 OpenCFD Ltd.

---

heads up babe: -parallel, -hostRoots and -roots are all marked as [Parallel option] — they're the distributed-running girlies, don't forget it 💜

---

and that's the whole page, you ate that 🍓✨

cute lil sign-off for you: this one lives over at www.openfoam.com, and the version tag on it is OpenFOAM- — yeah, that's the whole version string, she's mysterious, we respect it. mwah. 💖🎀🦋