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

✨ NAME ✨

okay bestie, gather round πŸ’– this is overSimpleFoam, and it's part of OpenFOAM (The Open Source CFD Toolbox). That's it, that's the whole vibe check β€” she's one little cog in a very big, very iconic machine πŸŽ€


🌸 SYNOPSIS 🌸

overSimpleFoam [OPTIONS]

like… that's the whole thing. one binary, a pile of options, go off πŸ‘‘


πŸ¦‹ DESCRIPTION πŸ¦‹

Steady-state solver for incompressible, turbulent flow.

no cap, that's what she does. steady-state, incompressible, turbulent β€” the holy trinity of "my flow is chaotic but at least it's not moving in time" πŸ’…


πŸ’… OPTIONS πŸ’…

every flag, no skips, we don't gatekeep here ✨

  • -case dir β€” point her at the case directory you wanna use instead of the cwd (she'd otherwise just assume you're already standing in it πŸ™ˆ)
  • -decomposeParDict file β€” use this specific file for the decomposePar dictionary, iykyk
  • -parallel β€” run it in parallel πŸ”₯ [Parallel option]
  • -postProcess β€” only run the functionObjects, nothing else, she's just here for the post-processing moment
  • -doc β€” pop the documentation open in your browser 🌈
  • -help β€” short help, then she dips. bye πŸ‘‹
  • -help-full β€” the FULL help, then exit. the director's cut, the extended edition πŸ‘‘

πŸ‘‘ ADVANCED OPTIONS πŸ‘‘

this is where the real ones live, bestie. the deep cuts. the lore 🧚

  • -debug-switch name=val β€” set the value of a registered debug switch. if you leave the value off it defaults to 1. (you can use this one multiple times, go feral)
  • -fileHandler handler β€” override the file handler type
  • -hostRoots ((host1 dir1) .. (hostN dirN)) β€” per-host slave root directories for distributed running. the host spec can be a regex, so yes, you can be fancy about it ✨ [Parallel option]
  • -info-switch name=val β€” set the value of a registered info switch. default is 1 if you don't give a value. (multiple times? absolutely, go off)
  • -lib name β€” load an extra library or a whole list of libraries (and yes, you can do it more than once)
  • -listFunctionObjects β€” list the functionObjects πŸ“‹
  • -listFvOptions β€” list the fvOptions
  • -listRegisteredSwitches β€” list the switches that are registered for run-time modification (peep the -listUnsetSwitches option for more)
  • -listScalarBCs β€” list scalar field boundary conditions, aka fvPatchField<scalar>
  • -listSwitches β€” list switches declared in libraries (again, see -listUnsetSwitches)
  • -listTurbulenceModels β€” list turbulenceModels πŸŒͺ️
  • -listUnsetSwitches β€” changes up the switch listing so it shows you the values that are NOT set in etc/controlDict
  • -listVectorBCs β€” list vector field boundary conditions, aka fvPatchField<vector>
  • -noFunctionObjects β€” do NOT execute function objects. she's off duty 🚫
  • -opt-switch name=val β€” set the value of a registered optimisation switch (int/bool). defaults to 1 if the value's missing. (multiple times, obviously)
  • -roots (dir1 .. dirN) β€” slave root directories for distributed running [Parallel option]
  • -doc-source β€” display the source code in your browser, for the girlies who like to read the source directly πŸ“–
  • -help-man β€” display full help in manpage format, then exit
  • -help-notes β€” display help notes (the description) and exit

πŸ” SEE ALSO πŸ”

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

(the link to the mothership, go look, it's giving resources πŸ’–)


Copyright Β© 2018-2019 OpenCFD Ltd.


and that's the whole page, bestie!! 🫢 this was brought to you by OpenFOAM over at www.openfoam.com, in the OpenFOAM- release, and it's the OVERSIMPLEFOAM(1) page β€” go forth and simulate responsibly, mwah πŸ’‹βœ¨