SURFACTANTFOAM(1)

💖 SURFACTANTFOAM(1) 💖

okay bestie, welcome to the OpenFOAM Commands Manual page for surfactantFoam, which is literally part of OpenFOAM (The Open Source CFD Toolbox). yes, that OpenFOAM. the big one. she's iconic, she's open source, and she has a solver just for you 💅

---

✨ NAME ✨

surfactantFoam — part of OpenFOAM (The Open Source CFD Toolbox). that's the whole vibe. that's the whole name. 🎀

---

✨ SYNOPSIS ✨

surfactantFoam [OPTIONS]

just the command, plus whatever options you're feeling today. no positional args, no drama. 🦋

---

✨ DESCRIPTION ✨

Passive scalar transport finiteArea equation solver.

that's it. that's the girl. she solves the passive scalar transport equation, and she does it on a finiteArea mesh — so if you're out here doing surface/finite-area scalar transport, this is your main character. no cap. 🔥

---

✨ OPTIONS ✨

• -case dir — tell her which case directory to use, instead of just assuming you meant the current working directory (cwd). she's not a mind reader, bestie. 🙈
• -decomposeParDict file — use the file you specify for the decomposePar dictionary. your dict, your rules. ✨
• -parallel — run it in parallel. [Parallel option] — she's got range, she multitasks. 👑
• -doc — pops the documentation open in your browser. cute lil study session. 🌸
• -help — shows the short help, then dips. bye! 👋
• -help-full — shows the full help, then dips. the deluxe version. 💖

🌈 ADVANCED OPTIONS 🌈

these are the deep cuts. iykyk. 🧚

• -debug-switch name=val — set the value of a registered debug switch. if you leave the value out, it defaults to 1. (can be used multiple times — stack 'em up) 💅
• -fileHandler handler — override the file handler type. you're in charge of the file handler now. slay. 🎀
• -hostRoots ((host1 dir1) .. (hostN dirN)) — per-host slave root directories for distributed running. the host spec can be a regex, which is honestly so powerful of her. [Parallel option] ⭐
• -info-switch name=val — set the value of a registered info switch. omit the value and it defaults to 1. (can be used multiple times) 🦋
• -lib name — load an additional library, or a whole list of libraries. (can be used multiple times — keep going, queen) 💜
• -listFunctionObjects — lists the functionObjects. window shopping but make it CFD. 🍓
• -listRegisteredSwitches — lists the switches registered for run-time modification (check out the -listUnsetSwitches option for the plot twist). ✨
• -listScalarBCs — lists scalar field boundary conditions, aka fvPatchField<scalar>. ✨
• -listSwitches — lists switches declared in libraries (again, see -listUnsetSwitches for the ✨twist✨). 🌈
• -listUnsetSwitches — changes up the switch listing so it displays values that are not set in etc/controlDict. the missing ones. the mystery ones. 👀
• -listVectorBCs — lists vector field boundary conditions, aka fvPatchField<vector>. ✨
• -noFunctionObjects — do not execute function objects. she's sitting this one out. 💀
• -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 — opens the source code in your browser. reading the source is a love language, ngl. 📖
• -help-man — displays the full help in manpage format, then exits. meta. very meta. 😭
• -help-notes — displays the help notes (the description) and exits. the tl;dr. 🫶

---

✨ SEE ALSO ✨

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

go read, bestie. the docs are right there and they're free. 💖

---

✨ COPYRIGHT ✨

Copyright © 2018-2019 OpenCFD Ltd.

---

and that's the whole page, periodt 💅 source is www.openfoam.com, version tag OpenFOAM-, and this page is filed under SURFACTANTFOAM(1). go solve something pretty, bestie 🦋✨💖