SURFACEPATCH(1)

📦
version 1912.200626 · 2 versions
  • 1912.200626 · debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu stonking (latest)
  • 2512 · nixpkgs unstable
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu stonking

💅 SURFACEPATCH(1) — bestie edition

ok so this is surfacePatch, and it's part of OpenFOAM (aka The Open Source CFD Toolbox, aka the thing that lives rent-free on your cluster). It's a command-line tool, and yes we're doing the whole manpage thing together, no cap. 🫶

✨ SYNOPSIS ✨

surfacePatch [OPTIONS]

that's it. that's the whole vibe. just the command and some options. 💖

🌸 DESCRIPTION 🌸

ok so what does it even do?? It adds patches — like, regions — to a surface. And the method? user-selectable, bestie. You pick it. Main character energy only. 👑

🎀 OPTIONS 🎀

here's where we get into it. every single flag, accounted for, fr fr.

  • -case dir — tells it which case directory to use, instead of just going with the cwd (current working directory, iykyk). 🗂️
  • -dict file — use a different surfacePatchDict if you're feeling spicy and don't wanna use the default one.
  • -doc — pops the documentation open in your browser. cute little field trip. 🌈
  • -help — short help, then it dips. ✌️
  • -help-full — the full help, then it dips. more is more. 💅

⭐ ADVANCED OPTIONS ⭐

ok these are the advanced ones, the ones for when you're lowkey a wizard 🧙

  • -debug-switch name=val — set the value of a registered debug switch. Default is 1 if you don't give a value. (You can use this one multiple times, go off.) 🔍
  • -fileHandler handler — override the file handler type. just take it over, periodt.
  • -info-switch name=val — set the value of a registered info switch. Default is 1 if the value is omitted. (Also usable multiple times.) 💬
  • -lib name — load an extra library, or a whole list of libraries. (Can be used multiple times.) 📚
  • -noFunctionObjects — do not execute function objects. like, at all. not today. 🙈
  • -opt-switch name=val — set the value of a registered optimisation switch, and it's an int/bool situation. Default is 1 if the value is omitted. (Multiple times, yes queen.) ⚡
  • -doc-source — show the actual source code in your browser. the raw material. iconic. 💜
  • -help-man — full help, but in manpage format, then exit.
  • -help-notes — help notes (aka the description) and then exit. the tl;dr of the tl;dr. ✨

👀 SEE ALSO 👀

online documentation, bestie, go read it:

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

Copyright © 2018-2019 OpenCFD Ltd.

like, legally, that's theirs. respect it. 🫡

🌸 and that's the whole page, no notes! stay hydrated, back up your cases, and remember: the method is user-selectable, so choose wisely. 🦋

signing off from the OpenFOAM Commands Manual — brought to you by www.openfoam.com, running OpenFOAM- (the version slot is giving mysterious, honestly), dated whenever this footer felt like it. mwah. 💋

📦 where this page comes from