SURFACEFEATUREEXTRACT(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

💖 surfaceFeatureExtract — the OpenFOAM commands manual, but make it make sense 💖

okay bestie, welcome to surfaceFeatureExtract(1), straight outta the OpenFOAM Commands Manual. she's part of OpenFOAM, aka The Open Source CFD Toolbox, and she's here to help you pull those cute little feature lines off your surfaces. let's get into it 🫶

✨ SYNOPSIS ✨

surfaceFeatureExtract [OPTIONS]

that's it. that's the whole summoning ritual. run the command, hand her some options, she does her thing 💅

🌸 DESCRIPTION 🌸

so what does she actually do? She extracts surface feature lines and writes them out to a file. iconic behaviour, honestly.

⚠️ but listen — feature line extraction is only valid on closed manifold surfaces. if your surface isn't a closed manifold, this is not the vibe and it will not work. no cap. 😭

🎀 OPTIONS 🎀

here's the lineup, bestie. every single one, no gatekeeping:

  • -case dir — tell her which case directory to use instead of the cwd (the current working directory). like, "not here, there" 💁‍♀️
  • -dict file — read the surfaceFeatureExtractDict from a location you specify. you point, she reads 🍓
  • -doc — pops the documentation open in your browser. study mode activated 📖✨
  • -help — shows you the short help and then dips. quick lil hello 👋
  • -help-full — shows you the full help and then exits. the whole lore drop 🗂️

👑 ADVANCED OPTIONS 👑

these ones are for when you're feeling brave. main character energy only ✨

  • -debug-switch name=val — sets the value of a registered debug switch. if you leave the value off, the default is 1. (you can use this one multiple times, go wild) 🐛
  • -fileHandler handler — overrides the file handler type. not your usual handler, a different one 💫
  • -info-switch name=val — sets the value of a registered info switch. omit the value and it defaults to 1. (also repeatable, multiple times, yes ma'am) 📢
  • -lib name — loads an additional library or a whole library list. can be used multiple times 🧚
  • -opt-switch name=val — sets the value of a registered optimisation switch, and it's int/bool only. default is 1 if you skip the value. (multiple times, you already know) ⚡
  • -doc-source [no args] — opens the source code in your browser. for the girlies who like to read the receipts 🔍
  • -help-compat — displays the compatibility options and exits 🙈
  • -help-man — displays the full help in manpage format and exits 📜
  • -help-notes — displays the help notes, aka the description, and exits 📝

💀 COMPATIBILITY OPTIONS 💀

  • -noFunctionObjects — ngl bestie... this option is ignored. she sees it, she acknowledges it, she moves on. it does literally nothing 🙃

🌈 SEE ALSO 🌈

the online documentation, if you wanna go deeper: https://www.openfoam.com/documentation/

Copyright © 2018-2019 OpenCFD Ltd.

k bye, love you, go extract some features 🦋 — brought to you by www.openfoam.com, version OpenFOAM- (yeah the version field is just vibing there empty, we don't make the rules), and dated however the page says. stay slay, bestie 💅✨🎀

📦 where this page comes from