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

✨ SONICFOAM(1) ✨

okay bestie, welcome to the sonicFoam page — it's part of OpenFOAM (The Open Source CFD Toolbox), and it's a whole mood. 🦋

🌸 NAME 🌸

sonicFoam — part of OpenFOAM (The Open Source CFD Toolbox). That's the whole name section, she's lowkey mysterious like that. 💅

🎀 SYNOPSIS 🎀

sonicFoam [OPTIONS]

literally just run it with whatever options you want, bestie. no positional args, she's chill like that. 🫶

🌈 DESCRIPTION 🌈

It's a transient solver for trans-sonic/supersonic, turbulent flow of a compressible gas. So like… fast air. Fancy fast air. The kind of air that goes whoosh and also has opinions about density. 😭✨

no cap: it's transient, so she's stepping through time, and she's dealing with compressible gas, so don't come at her with your incompressible assumptions. 🙈

💖 OPTIONS 💖

  • -case dir — Tell her which case directory to use instead of the cwd (current working directory). She's not gonna guess, bestie.
  • -decomposeParDict file — Use this specific file for the decomposePar dictionary. Iconic of you to specify.
  • -dry-run — Just check the case set-up using a single time step. A lil vibe check, no commitment. ✨
  • -dry-run-write — Check the case set-up and write, still only using a single time step. She's peeking AND taking notes. 💀
  • -parallel — Run in parallel. [Parallel option] — multiple cores, multiple besties, one goal. 👑
  • -postProcess — Execute functionObjects only. Nothing else, just the little guys doing their thing. 🧚
  • -doc — Display documentation in the browser. Go read, queen. 📖
  • -help — Display short help and exit. The quick version, for when you're in a rush. 💨
  • -help-full — Display full help and exit. The whole essay. Grab a snack. 🍓

🔥 ADVANCED OPTIONS 🔥

  • -debug-switch name=val — Specify the value of a registered debug switch. Default is 1 if the value is omitted. (Can be used multiple times.) Spill the tea, repeatedly if you must.
  • -fileHandler handler — Override the file handler type. Changing her whole filing system, slay.
  • -hostRoots ((host1 dir1) .. (hostN dirN)) — Per-host slave root directories for distributed running. The host specification can be a regex. [Parallel option] — yes, a regex, she's fancy like that. 🎀
  • -info-switch name=val — Specify the value of a registered info switch. Default is 1 if the value is omitted. (Can be used multiple times.)
  • -lib name — Additional library or library list to load (can be used multiple times). Bring your friends. 🫶
  • -listFunctionObjects — List functionObjects. Just shows you all of them. ✨
  • -listFvOptions — List fvOptions. Same energy, different list.
  • -listRegisteredSwitches — List switches registered for run-time modification (see the -listUnsetSwitches option).
  • -listScalarBCs — List scalar field boundary conditions (fvPatchField<scalar>). Keeping it scalary. 💅
  • -listSwitches — List switches declared in libraries (see the -listUnsetSwitches option).
  • -listTurbulenceModels — List turbulenceModels. All the chaotic swirls, catalogued. 🌪️
  • -listUnsetSwitches — Modifies switch listing to display values not set in etc/controlDict. The ones who ghosted the config file. 💀
  • -listVectorBCs — List vector field boundary conditions (fvPatchField<vector>). Now with direction. ➡️
  • -noFunctionObjects — Do not execute function objects. Sorry little guys, sitting this one out. 🙈
  • -opt-switch name=val — Specify the value of a registered optimisation switch (int/bool). Default is 1 if the value is omitted. (Can be used multiple times.)
  • -roots (dir1 .. dirN) — Slave root directories for distributed running. [Parallel option] — the distributed-running girlies know. 👑
  • -doc-source — Display source code in the browser. Read the actual source, main character energy. 📜
  • -help-man — Display full help (manpage format) and exit. Meta. We love a self-aware icon. 🪞
  • -help-notes — Display help notes (description) and exit. The commentary track. 🎙️

🦋 SEE ALSO 🦋

Online documentation: https://www.openfoam.com/documentation/ — go forth and hyperlink, bestie. 🌐

Copyright © 2018-2019 OpenCFD Ltd. Respect the elders. 🙏

okay and that's the whole page, fr fr. This little masterpiece lives at www.openfoam.com, tagged OpenFOAM- (yeah the version field is just sitting there being enigmatic, we don't question her 💅), and it's filed under SONICFOAM(1). Go run your supersonic gas, queen. periodt. ✨💖🎀

📦 where this page comes from