SHALLOWWATERFOAM(1)

💧 SHALLOWWATERFOAM(1) 💧

okay bestie, so like… this is a page from the OpenFOAM Commands Manual ✨ it's the manual for shallowWaterFoam, and honestly? she's niche but she serves. Let's get into it 🫶

---

✨ NAME ✨

shallowWaterFoam — part of OpenFOAM (The Open Source CFD Toolbox). yes that's the whole name section, it's short and she's confident about it 💅

---

✨ SYNOPSIS ✨

shallowWaterFoam [OPTIONS]

that's it. that's the whole vibe. just the command and whatever options you wanna throw at her 🌸

---

✨ DESCRIPTION ✨

Transient solver for inviscid shallow-water equations with rotation.

so like — transient meaning she moves through time babes, inviscid meaning no viscosity drama, shallow water equations, and there's rotation in there too (hello Coriolis, we see you 👑). that's the whole description, no cap. 🦋

---

✨ OPTIONS ✨

• -case dir — Specify case directory to use (instead of the cwd). like, tell her where to live instead of assuming she's in the current working directory 🏠
• -decomposeParDict file — Use specified file for decomposePar dictionary. custom dict file, slay 📂
• -dry-run — Check case set-up only using a single time step. lowkey a vibe check for your case, no full run 💀
• -dry-run-write — Check case set-up and write only using a single time step. same energy but she also writes ✍️
• -parallel — Run in parallel. [Parallel option] 🔥
• -postProcess — Execute functionObjects only. just the lil extras, nothing else 💖
• -doc — Display documentation in browser. go read, bestie 📖
• -help — Display short help and exit. the quick version, in and out 🎀
• -help-full — Display full help and exit. the whole novel, she's thorough 🌈

🌟 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). 📚
• -listFunctionObjects — List functionObjects. 🧾
• -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). 🎛️
• -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 browser. peek behind the curtain 🪞
• -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 click it, iykyk 🔗

---

✨ COPYRIGHT ✨

Copyright © 2018-2019 OpenCFD Ltd. 🫶

---

ok so fr fr, don't forget the [Parallel option] tags on -parallel, -hostRoots and -roots — those ones only make sense when you're running distributed, bestie, no cap 💀

---

and that's the whole page!! she's from www.openfoam.com, tagged OpenFOAM- version, and this page is dated the same era as that copyright. mwah, go run your shallow water sim, you're doing amazing sweetie 💖✨🎀🦋🌸💅🫶👑🌈⭐🍓🧚💜