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

💅 STAR4TOFOAM — the OpenFOAM glow-up corner

okay bestie, so this one is star4ToFoam, and she's part of OpenFOAM (The Open Source CFD Toolbox) 💖. Yes, the whole manual is literally called OpenFOAM Commands Manual and you're in the right place, promise 🫶

✨ SYNOPSIS ✨

star4ToFoam [OPTIONS] prefix

that's it, that's the whole vibe. one command, one prefix, infinite possibilities 🦋

🌸 DESCRIPTION 🌸

she converts a STARCD/PROSTAR (v4) mesh into OpenFOAM. that's the entire job, and she does it flawlessly, no cap 💅

🎀 ARGUMENTS 🎀

  • prefix — the prefix for the input PROSTAR files. like, the name-y part that comes before the rest of the filename, you know? 🍓

👑 OPTIONS 👑

  • -ascii — write it out in ASCII instead of binary format. text mode era ✨
  • -case dir — specify the case directory to use, instead of the cwd (current working directory, iykyk) 🎀
  • -scale factor — geometry scaling factor, and the default is 0.001 (that's [mm] to [m], so she's quietly fixing your units for you 💖)
  • -solids — retain solid cells and treat them like fluid cells. solidarity!! 🫶
  • -doc — display documentation in browser 📖
  • -help — display short help and exit 🧚
  • -help-full — display full help and exit 🌈

💀 ADVANCED OPTIONS 💀

  • -debug-switch name=val — specify the value of a registered debug switch. the default is 1 if you leave the value out. (can be used multiple times, go wild) 🔥
  • -fileHandler handler — override the file handler type 🗂️
  • -info-switch name=val — specify the value of a registered info switch. default is 1 if the value is omitted. (also multiple times, we love a repeatable flag) ⭐
  • -lib name — additional library or library list to load (can be used multiple times, obviously) 💜
  • -noFunctionObjects — do not execute function objects 🚫
  • -opt-switch name=val — specify the value of a registered optimisation switch (int/bool). default is 1 if the value is omitted. (yep, multiple times too) 👑
  • -doc-source — display source code in browser 👀
  • -help-man — display full help (manpage format) and exit 📜
  • -help-notes — display help notes (description) and exit 📝

🦋 SEE ALSO 🦋

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

Copyright © 2018-2019 OpenCFD Ltd.

k so that's the whole page, no gatekeeping here 💅

and for the cute sign-off: this icon of a page lives over at www.openfoam.com, and she's stamped OpenFOAM- (that's the version, slay) 🌸 mwah, go convert some meshes, you've got this 🫶✨

📦 where this page comes from