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

💖 THERMOFOAM 💖

okay bestie, welcome to thermoFoam, part of OpenFOAM (The Open Source CFD Toolbox) — yes the whole iconic toolbox, and this is one of its little stars. it lives in section 1 of the OpenFOAM Commands Manual, iykyk 💅

✨ SYNOPSIS ✨

thermoFoam [OPTIONS]

that's it. that's the whole vibe. one binary, a whole pile of options, and honestly? she ate 🎀

🌸 DESCRIPTION 🌸

so what does she actually do? Solver for energy transport and thermodynamics on a frozen flow field. periodt. she's not out here solving the flow — the flow is frozen, it's giving background music — she's doing the energy transport and thermodynamics on top of it. main character energy, no cap 💖

🦋 OPTIONS 🦋

here's the full menu, no skipping, every single one:

  • -case dir — point her at a case directory to use, instead of just vibing in the cwd. 📁
  • -decomposeParDict file — use the file you name for the decomposePar dictionary.
  • -dry-run — just check the case set-up, using a single time step. a lil test run, no commitment 🫶
  • -dry-run-write — check the case set-up and write, still only using a single time step.
  • -parallel — run in parallel. [Parallel option] ✨
  • -postProcess — execute functionObjects only. that's the whole job, nothing else.
  • -doc — display documentation in browser. 🌈
  • -help — display short help and exit. bye bestie 👋
  • -help-full — display full help and exit.

🔥 ADVANCED OPTIONS 🔥

this is the deep end, the "i've been doing this for years" section, and yes you're ready for it:

  • -debug-switch name=val — specify the value of a registered debug switch. default is 1 if you omit the value. (Can be used multiple times) 💀
  • -fileHandler handler — override the file handler type.
  • -hostRoots ((host1 dir1) .. (hostN dirN)) — per-host slave root directories for distributed running. the host specification can be a regex. [Parallel option] 👑
  • -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). load her up 🎀
  • -listFunctionObjects — list functionObjects.
  • -listFvOptions — list fvOptions.
  • -listRegisteredSwitches — list switches registered for run-time modification (see the -listUnsetSwitches option).
  • -listScalarBCs — list scalar field boundary conditions (fvPatchField<scalar>).
  • -listSwitches — list switches declared in libraries (see the -listUnsetSwitches option).
  • -listTurbulenceModels — list turbulenceModels.
  • -listUnsetSwitches — modifies the switch listing to display values not set in etc/controlDict. sneaky peek energy 🙈
  • -listVectorBCs — list vector field boundary conditions (fvPatchField<vector>).
  • -noFunctionObjects — do not execute function objects. not today, functionObjects. 💀
  • -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] 🫶
  • -doc-source — display source code in browser. go read the source, bestie, it's iconic ⭐
  • -help-man — display full help (manpage format) and exit.
  • -help-notes — display help notes (description) and exit.

👀 SEE ALSO 👀

Copyright © 2018-2019 OpenCFD Ltd.

fr fr, that's the whole page. no gatekeeping, every flag accounted for 💖

and that's a wrap, babe — with love from the OpenFOAM squad over at www.openfoam.com, running the OpenFOAM- version, filed under THERMOFOAM(1). go run something beautiful, you've got this 🧚✨🌸

📦 where this page comes from