POTENTIALFOAM(1)

🌸 POTENTIALFOAM(1) — it's giving OpenFOAM Commands Manual energy 🌸

okay bestie, sit down, hydrate, because we're about to talk about potentialFoam — yes she's part of OpenFOAM (The Open Source CFD Toolbox), yes she's iconic, and yes she solves for the velocity potential. 💅

---

✨ NAME ✨

potentialFoam — part of OpenFOAM (The Open Source CFD Toolbox). no cap, that's literally her whole government name. 🫶

---

🦋 SYNOPSIS 🦋

potentialFoam [OPTIONS]

that's it. that's the whole summoning ritual. [OPTIONS] is optional, so she'll run with zero flags if you're feeling brave (or reckless, no judgement 🙈).

---

🎀 DESCRIPTION 🎀

Potential flow solver which solves for the velocity potential. ✨

she's the lowkey queen of the setup phase — the one who shows up, solves the potential field, and lets the rest of your case get its life together. main character energy fr fr.

---

💖 OPTIONS 💖

every single flag, babes. nothing skipped, nothing merged, nothing invented. this is the whole list, periodt.

• -case dir — tell her which case directory to use instead of the cwd. like, she was gonna assume you meant where you're standing, but you can point her somewhere else. 💁
• -decomposeParDict file — use the specified file for the decomposePar dictionary instead of whatever the default is.
• -dry-run — just check the case set-up, bestie. only a single time step. she's peeking, not committing. 👀
• -dry-run-write — same energy as above but she also writes — check the case set-up and write only, using a single time step.
• -initialiseUBCs — initialise the U boundary conditions. that's the move.
• -pName pName — the name of the pressure field. yes, you get to name her. 🍼
• -parallel — run in parallel. [Parallel option] she's got friends and she's not afraid to use them. 🔥
• -region name — specify an alternative mesh region.
• -withFunctionObjects — execute functionObjects. yes, actually run them.
• -writePhi — write the final velocity potential field. a gift, for you 🎁
• -writep — calculate and write the Euler pressure field.
• -writephi — write the final volumetric flux field. (careful, that's phi, not Phi — different girls, different vibes 💅)
• -doc — display documentation in browser. very demure, very mindful. 🧚
• -help — display short help and exit. in and out, no drama.
• -help-full — display full help and exit. she will yap. you will read. it's a whole thing. 📖

💜 ADVANCED OPTIONS 💜

for the girlies who read the source. iykyk.

• -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 — go off, stack them 🫶)
• -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] spicy. 🌶️
• -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) — bring your whole friend group, it's fine. 🌈
• -listFunctionObjects — list functionObjects. a whole roster, displayed.
• -listRegisteredSwitches — list switches registered for run-time modification (see -listUnsetSwitches option).
• -listScalarBCs — list scalar field boundary conditions (fvPatchField<scalar>). yes the angle brackets are part of it, copy them exactly, don't freestyle. 💀
• -listSwitches — list switches declared in libraries (see -listUnsetSwitches option).
• -listUnsetSwitches — modifies the switch listing to display values not set in etc/controlDict. the chaos option, the "what did nobody configure" option.
• -listVectorBCs — list vector field boundary conditions (fvPatchField<vector>).
• -noFunctionObjects — do not execute function objects. the anti--withFunctionObjects. ✋
• -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. read her diary, she doesn't mind. 📓
• -help-man — display full help (manpage format) and exit.
• -help-notes — display help notes (description) and exit.

⚠️ quick note bestie: the [Parallel option] tags on -parallel, -hostRoots and -roots are real — those ones belong to the parallel side of the house. don't act surprised later. 💅

---

🌟 SEE ALSO 🌟

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

that's the link. that's the whole vibe. go read, glow up, come back smarter. 📚✨

---

👑 COPYRIGHT 👑

Copyright © 2018-2019 OpenCFD Ltd.

protect her, respect her, cite her. periodt. 💖

---

and that's the whole page, bestie!! 💅🎀

this was POTENTIALFOAM(1) from www.openfoam.com, running the OpenFOAM- version line, dated (yes, the footer date is just… blank, she's mysterious like that 🦋). love you, go solve something beautiful. 🫶🌸✨