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

💅 GMSHTOFOAM — okay bestie, let's convert some meshes ✨

Hi hi! So this little icon is gmshToFoam, and she's part of OpenFOAM (aka The Open Source CFD Toolbox, the whole legend). She lives in the OpenFOAM Commands Manual section of your man pages, and she has exactly one job, which she does flawlessly, no notes. 🫶

🌸 SYNOPSIS 🌸

gmshToFoam [OPTIONS] .msh file

That's it. That's the whole vibe check. ✨

🦋 DESCRIPTION 🦋

Convert a gmsh .msh file to OpenFOAM. Periodt. 💖

Like — you made your mesh in gmsh, slay, but OpenFOAM doesn't speak gmsh, so you hand it over to this girl and she translates. It's giving bilingual queen. 👑

🎀 ARGUMENTS 🎀

  • .msh file — the gmsh file you want converted, bestie. Yes it's literally just called that. Not me writing the argument name as the file extension 💀

⭐ OPTIONS ⭐

  • -case dir — tell her which case directory to work in, instead of just using the cwd (the current working directory, iykyk).
  • -keepOrientation — keep the raw orientation for prisms/hexs. No remixing, no reorienting, we keep it exactly how it came. 🙈
  • -region name — pick an alternative mesh region if you're feeling spicy.
  • -doc — pops the documentation open in your browser. Very demure, very mindful. 🌈
  • -help — short help, then she dips. Byeee 👋
  • -help-full — the FULL help, then exit. She's thorough, she's committed. 💅

👑 ADVANCED OPTIONS 👑

  • -debug-switch name=val — set the value of a registered debug switch. Default is 1 if you just... don't give a value. (Can be used multiple times, go off.)
  • -fileHandler handler — override the file handler type. Fancy.
  • -info-switch name=val — set the value of a registered info switch. Default is 1 if the value is omitted. (Can be used multiple times.)
  • -lib name — load an additional library or a whole list of libraries. (Can be used multiple times.) Load her up 🍓
  • -noFunctionObjects — do NOT execute function objects. Not today. 🚫
  • -opt-switch name=val — set the value of a registered optimisation switch (int/bool). Default is 1 if the value is omitted. (Can be used multiple times.)
  • -doc-source — opens the source code in your browser, for when you wanna read the actual receipts. 🔥
  • -help-man — full help in manpage format, then exit.
  • -help-notes — help notes (the description), then exit.

💜 SEE ALSO 💜

Online documentation, bestie: https://www.openfoam.com/documentation/

Copyright © 2018-2019 OpenCFD Ltd.

Also just so we're clear, she's not reinventing anything — everything above is exactly as documented, and the flags mean what they mean. Don't come for me if you skip -keepOrientation and your prisms get reoriented. 😭

And that's the whole page, angel! 🧚 This gorgeous little manual lives over at www.openfoam.com, stamped OpenFOAM- and filed under GMSHTOFOAM(1). Go convert something cute. 💖✨🎀

📦 where this page comes from