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

ENGINEFOAM(1) πŸ‘‘

okay bestie, welcome to engineFoam β€” she's part of OpenFOAM (The Open Source CFD Toolbox), and she is lowkey iconic πŸ’… this whole page lives in the OpenFOAM Commands Manual, and we're gonna go through it together, no skimming, no skipping, fr fr 🫢


✨ SYNOPSIS ✨

engineFoam [OPTIONS]

that's it. that's the whole vibe. you run her, you hand her some options, she goes 🌈


🌸 DESCRIPTION 🌸

so what does she do, you ask? Transient solver for compressible, turbulent engine flow with a spray particle cloud.

periodt. that's the whole job. transient (meaning she moves through time, she's not standing still, she's giving main character energy ⏱️), compressible, turbulent, engine flow, and there's a spray particle cloud in there too β€” she's doing a LOT and she's doing it all at once πŸ”₯


πŸ’– OPTIONS πŸ’–

here's where it gets juicy. every single flag, in order, no gatekeeping πŸŽ€

  • -case dir β€” tell her which case directory to use instead of the cwd. like, "bestie, work here not there" πŸ“
  • -decomposeParDict file β€” use the file you specify for the decomposePar dictionary 🧩
  • -parallel β€” run in parallel. she said "let's get the whole group chat involved" ✨ [Parallel option]
  • -postProcess β€” execute functionObjects only. nothing else, just the functionObjects, she's being picky πŸ’…
  • -doc β€” display documentation in browser πŸ“–
  • -help β€” display short help and exit. the little "hey bestie here's the TL;DR" πŸ™ˆ
  • -help-full β€” display full help and exit. the whole essay, all of it, no cuts πŸ“š

🌟 ADVANCED OPTIONS 🌟

these are the ones for when you're really in your Unix era πŸ‘‘

  • -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 β€” stack 'em, queen) πŸ›
  • -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 you omit the value. (can be used multiple times) ℹ️
  • -lib name β€” additional library or library list to load (can be used multiple times) πŸ“¦
  • -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 switch listing to display values not set in etc/controlDict πŸ™ˆ
  • -listVectorBCs β€” list vector field boundary conditions (fvPatchField<vector>) 🏹
  • -noFunctionObjects β€” do not execute function objects. she's off duty 🚫
  • -opt-switch name=val β€” specify the value of a registered optimisation switch (int/bool). default is 1 if you omit the value. (can be used multiple times) βš™οΈ
  • -roots (dir1 .. dirN) β€” slave root directories for distributed running [Parallel option] 🌳
  • -doc-source β€” display source code in browser πŸ’»
  • -help-man β€” display full help (manpage format) and exit πŸ“œ
  • -help-notes β€” display help notes (description) and exit πŸ—’οΈ
ngl, if you're new here, start with -help before you start throwing advanced flags around like confetti 🎊

πŸ¦‹ SEE ALSO πŸ¦‹

Online documentation πŸ‘‰ https://www.openfoam.com/documentation/

go read it, she's worth it πŸ’–


Copyright Β© 2018-2019 OpenCFD Ltd.


and that's the whole page, bestie 🫢 this came to you from www.openfoam.com, version OpenFOAM-, and it's filed under ENGINEFOAM(1) in the OpenFOAM Commands Manual. slay, go run your solver, and hydrate πŸ’œβœ¨