FOAMLISTREGIONS(1)

💖 FOAMLISTREGIONS — the OpenFOAM manual, bestie edition 💖

okay so real talk: this page is foamListRegions(1) from the OpenFOAM Commands Manual, and it's part of OpenFOAM — aka The Open Source CFD Toolbox. yes that OpenFOAM. the CFD one. the big one. 🌀✨

---

🌸 NAME 🌸

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

that's it, that's the whole job description. she's a team player, she's on the roster, she does her one little thing and she does it cute. 💅

---

✨ SYNOPSIS ✨

foamListRegions [OPTIONS] [regionType ... regionType]

so like. you give her options, you optionally give her a bunch of regionTypes, and she goes. no drama. 🦋

---

🎀 DESCRIPTION 🎀

she lists regions from constant/regionProperties. that's the gig. that's the whole gig. she opens up constant/regionProperties, reads what's in there, and tells you what regions you've got.

not me being obsessed with how simple that is. 😭 she's giving "I have one job and I slayed it."

---

🫶 ARGUMENTS 🫶

• regionType ... regionType — zero or more of these, your choice. you can pass one, you can pass a whole little squad of them, or you can pass none at all (which is also valid, she's not gonna be weird about it).

---

💅 OPTIONS 💅

• -case dir — tell her which case directory to use instead of the current working directory (cwd). like, "bestie, look over here instead." 🏠
• -doc — pops the documentation open in your browser. reading is fundamental, babes. 📖
• -help — short help, then she dips. quick lil "hey here's the gist," and she's gone. 👋
• -help-full — the FULL help, and then she exits. she's not holding back, she's telling you everything. 💅

👑 ADVANCED OPTIONS 👑

• -debug-switch name=val — set the value of a registered debug switch. if you leave the value off, the default is 1. and yes, you can use this multiple times, go off. 🐛
• -fileHandler handler — override the file handler type. you're the boss, you decide. 📁
• -info-switch name=val — set the value of a registered info switch. omit the value and the default is 1. also repeatable, multiple times, as many as you want. ℹ️
• -lib name — load an additional library, or a whole library list. can be used multiple times, stack 'em up. 📚
• -opt-switch name=val — set the value of a registered optimisation switch, and heads up, it's an int/bool situation. leave the value out and the default is 1. multiple times? absolutely. ⚡
• -doc-source — shows you the source code in your browser. peek behind the curtain, queen. 🔍
• -help-compat — displays the compatibility options, then exits. the ✨legacy✨ corner of the menu.
• -help-man — displays the full help in manpage format, then exits. hello, that's literally this vibe. 📜
• -help-notes — displays the help notes (aka the description), then exits. just the lore, no extras. 📝

🌈 COMPATIBILITY OPTIONS 🌈

• -noFunctionObjects — this option is ignored. not deprecated, not dangerous, just... ignored. she's here for the vibes and literally nothing else. 💀

---

🔥 SEE ALSO 🔥

• Online documentation: https://www.openfoam.com/documentation/

go read it, iykyk. 📚✨

---

💜 COPYRIGHT 💜

Copyright © 2018-2019 OpenCFD Ltd.

---

and that's the whole page, bestie. no cap. 🎀

this iconic little number lives over at www.openfoam.com, source/version OpenFOAM-, and it's the FOAMLISTREGIONS(1) page in the OpenFOAM Commands Manual — so go list some regions and slay. 🦋⭐💖