SURFACEBOOLEANFEATURES(1)

💅 SURFACEBOOLEANFEATURES(1) — OpenFOAM Commands Manual 🦋

okay bestie, welcome to the surfaceBooleanFeatures page, part of OpenFOAM (aka The Open Source CFD Toolbox). yes it's a mouthful, no we're not renaming it, it's iconic like that. 💖

---

✨ NAME ✨

surfaceBooleanFeatures — literally just one little slice of the OpenFOAM toolbox, but a main character slice, fr fr.

---

🌸 SYNOPSIS 🌸

surfaceBooleanFeatures [OPTIONS] action surface1 surface2

that's it. that's the whole vibe check. 💅

---

🧚 DESCRIPTION 🧚

So what does it DO, you ask? It generates the extendedFeatureEdgeMesh for the interface that gets created when you do a boolean operation on two surfaces. Two surfaces walk in, one interface walks out. slay. ✨

---

🎀 ARGUMENTS 🎀

• action — bestie you gotta pick ONE of these three: intersection | union | difference. that's the whole menu, no substitutions. 😌
• surface1 — the input surface file 1. the first one. the OG. 🫶
• surface2 — the input surface file 2. the sequel. the part two. 💜

---

💅 OPTIONS 💅

• -case dir — tell it which case directory to use instead of just rolling with the cwd (current working directory). 🏠
• -invertedSpace — do the surfaces have inverted space orientation? i.e. a point at infinity counts as inside. lowkey important caveat: this is only sensible for union and intersection. don't come for me if you try it with difference. 🙈
• -perturb — perturbs the surface points so you can escape degenerate intersections. it's giving "shake it loose and hope for the best" but in a mathematically legit way. 🔥
• -scale factor — geometry scaling factor. and yes it applies to both surfaces, not just one. ✨
• -surf1Baffle — marks surface 1 as a baffle. 🎀
• -surf2Baffle — marks surface 2 as a baffle. matching set, we love symmetry. 🎀
• -trim ((surface1 volumeType) .. (surfaceN volumeType)) — trims the resulting intersection with additional surfaces. the volumeType can be:
  • inside — keep (parts of) edges that are inside
  • outside — keep (parts of) edges that are outside
  • mixed — keep all of them, no notes

choose your fighter. 👑

• -doc — opens the documentation in your browser. 🦋
• -help — short help, then it dips. bye bestie. 👋
• -help-full — the full help, then it dips. the deluxe version. 💖

---

🌈 ADVANCED OPTIONS 🌈

these are for when you're feeling brave, or just very very specific. 🧚

• -debug-switch name=val — sets the value of a registered debug switch. if you omit the value, the default is 1. can be used multiple times. 🔁
• -fileHandler handler — overrides the file handler type. 🗂️
• -info-switch name=val — sets the value of a registered info switch. omit the value and the default is 1. also can be used multiple times. 🔁
• -lib name — an additional library or library list to load. can be used multiple times. 📚
• -noFunctionObjects — do NOT execute function objects. they stay unexecuted. periodt. 💀
• -opt-switch name=val — sets the value of a registered optimisation switch (int/bool). omit the value and the default is 1. and yep, can be used multiple times. 🔁
• -doc-source — shows you the source code in your browser. peek behind the curtain. 👀
• -help-man — displays the full help in manpage format, then exits. meta. ✨
• -help-notes — displays the help notes (the description), then exits. 📝

---

👑 SEE ALSO 👑

Online documentation, bestie: https://www.openfoam.com/documentation/ — go read, it's good for you. 🌸

---

💜 COPYRIGHT 💜

Copyright © 2018-2019 OpenCFD Ltd.

---

🫶 cute sign-off time: this page lives at www.openfoam.com under the OpenFOAM- version tag, and it's filed as SURFACEBOOLEANFEATURES(1). no date on this one bestie, so we're just vibing with the version as-is. 💖

bye bestie, go do a boolean operation responsibly. 🌈✨🎀