POROUSSIMPLEFOAM(1)

💖 POROUSSIMPLEFOAM 💖

okay bestie, welcome to the porousSimpleFoam page — it's part of OpenFOAM (aka The Open Source CFD Toolbox, you already knew that tho). this is from the OpenFOAM Commands Manual and it's genuinely one of the good ones, so let's get into it 🫶

---

✨ SYNOPSIS ✨

porousSimpleFoam [OPTIONS]

that's it. that's the whole vibe. options only, no positional args, no drama 💅

---

🌸 DESCRIPTION 🌸

okay so, steady-state solver for incompressible, turbulent flow with implicit/explicit porosity treatment. yes, porosity — the whole "stuff is flowing through a porous medium" situation. it's giving sponge energy fr fr 🧚

and it has MRF support too, so rotating zones? handled. iconic.

---

🎀 OPTIONS 🎀

the standard lineup, no cap:

• -case dir — tell it which case directory to use instead of just vibing in the current working directory (cwd).
• -decomposeParDict file — use a specific file for the decomposePar dictionary. you're the one picking the file, bestie.
• -dry-run — just check the case set-up, using a single time step. no full run, just a little peek 👀
• -dry-run-write — check the case set-up and write, still only using a single time step.
• -parallel — run in parallel. [Parallel option] — this one's a whole category, iykyk.
• -postProcess — execute functionObjects only. nothing else, just the function objects, main character energy.
• -doc — pops the documentation open in your browser 🌈
• -help — short help, then exit. quick lil snack.
• -help-full — full help, then exit. the whole meal 🍓

💫 ADVANCED OPTIONS 💫

this is where the real ones hang out:

• -debug-switch name=val — set the value of a registered debug switch. if you leave the value off, it defaults to 1. (can be used multiple times, stack 'em up)
• -fileHandler handler — override the file handler type. you're overriding, periodt.
• -hostRoots ((host1 dir1) .. (hostN dirN)) — per-host slave root directories for distributed running. the host specification can be a regex, so go wild. [Parallel option]
• -info-switch name=val — set the value of a registered info switch. value omitted? defaults to 1. (can be used multiple times)
• -lib name — load an additional library or a library list. (can be used multiple times)
• -listFunctionObjects — lists the functionObjects.
• -listFvOptions — lists the fvOptions.
• -listRegisteredSwitches — lists switches registered for run-time modification (go peek at the -listUnsetSwitches option too).
• -listScalarBCs — lists scalar field boundary conditions, aka fvPatchField<scalar>.
• -listSwitches — lists switches declared in libraries (again, see the -listUnsetSwitches option).
• -listTurbulenceModels — lists the turbulenceModels.
• -listUnsetSwitches — modifies the switch listing so it displays values not set in etc/controlDict.
• -listVectorBCs — lists vector field boundary conditions, aka fvPatchField<vector>.
• -noFunctionObjects — do not execute function objects. it said what it said.
• -opt-switch name=val — set the value of a registered optimisation switch (int/bool). omit the value and it defaults to 1. (can be used multiple times)
• -roots (dir1 .. dirN) — slave root directories for distributed running. [Parallel option]
• -doc-source — displays the source code in your browser. code reading hour 📖✨
• -help-man — full help in manpage format, then exit.
• -help-notes — help notes (the description) and exit.

---

👑 SEE ALSO 👑

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

---

💜 COPYRIGHT 💜

Copyright © 2018-2019 OpenCFD Ltd.

---

okay that's the whole page! go forth and solve those porous flows, you absolute legend 🦋💅

and that's a wrap from www.openfoam.com, source/version OpenFOAM- — the OpenFOAM Commands Manual, page POROUSSIMPLEFOAM(1). mwah, bye bestie 💖⭐