FOAMHELP(1)

✨ FOAMHELP(1) ✨

okay bestie, so this is the manual for foamHelp — a whole little part of OpenFOAM (aka The Open Source CFD Toolbox, aka the girlies' favourite computational fluid dynamics situation). It's from the OpenFOAM Commands Manual. We're doing this 💅

---

🌸 NAME 🌸

foamHelp — part of OpenFOAM (The Open Source CFD Toolbox).

like literally that's it, that's the name section, she's humble 🎀

---

🦋 SYNOPSIS 🦋

foamHelp [OPTIONS] tool

---

💖 DESCRIPTION 💖

So the valid options for <tool> are:

• boundary
• functionObject
• solver

⚠️ NOTE: the <tool> has to actually show up before any options. Not after. Not vibing in the middle. Before. The order matters, bestie, it's giving strict 🫶

---

🎀 ARGUMENTS 🎀

• tool — yeah that's the argument. That's the whole thing. Pick one of the tools from up above ✨

---

👑 OPTIONS 👑

• -case dir — tell it which case directory to use instead of the cwd (current working directory, iykyk)
• -decomposeParDict file — use the specified file for the decomposePar dictionary
• -parallel — run in parallel ✨ [Parallel option]
• -region name — specify an alternative mesh region
• -doc — display the documentation in your browser 🌈
• -help — display short help and exit
• -help-full — display the FULL help and exit, the deluxe version 💅

🌟 ADVANCED OPTIONS 🌟

• -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)
• -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 the 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: https://www.openfoam.com/documentation/

go read it, it's iconic ⭐

---

💜 COPYRIGHT 💜

Copyright © 2018-2019 OpenCFD Ltd.

---

and that's the whole page, bestie 🫶 this lil manual lives over at www.openfoam.com and it's tagged as OpenFOAM- version vibes — no cap, that's genuinely everything, go run your solver and slay 💅✨