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

πŸ’– ICOFOAM πŸ’–

okay bestie, so this is icoFoam, part of OpenFOAM (The Open Source CFD Toolbox) β€” it's giving iconic solver energy and it's literally in the OpenFOAM Commands Manual, section 1. periodt.


✨ SYNOPSIS ✨

icoFoam [OPTIONS]

that's it, that's the whole vibe check. πŸŽ€


🌸 DESCRIPTION 🌸

Transient solver for incompressible, laminar flow of Newtonian fluids. no cap β€” that's exactly what it does. it's the moment, it's the main character, it's lowkey the reason you opened this terminal. πŸ’…


πŸ‘‘ OPTIONS πŸ‘‘

bestie these are the standard ones, go off:

  • -case dir β€” tell it which case directory to use instead of the cwd. like, instead of wherever you happen to be standing. πŸ¦‹
  • -decomposeParDict file β€” use the specified file for the decomposePar dictionary.
  • -dry-run β€” check the case set-up only, using a single time step. it's the rehearsal, not the show. πŸ™ˆ
  • -dry-run-write β€” check the case set-up and write, but only using a single time step.
  • -parallel β€” run in parallel. [Parallel option] πŸ”₯
  • -postProcess β€” execute functionObjects only. nothing else, just those.
  • -doc β€” display documentation in browser.
  • -help β€” display short help and exit.
  • -help-full β€” display full help and exit.

🌈 ADVANCED OPTIONS 🌈

this is the deep end bestie, the advanced section, the iykyk zone:

  • -debug-switch name=val β€” specify the value of a registered debug switch. the 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).
  • -listFunctionObjects β€” list functionObjects.
  • -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).
  • -listUnsetSwitches β€” modifies the switch listing to display values not set in etc/controlDict.
  • -listVectorBCs β€” list vector field boundary conditions (fvPatchField<vector>).
  • -noFunctionObjects β€” do not execute function objects. bye bestie πŸ‘‹
  • -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.
  • -help-man β€” display full help (manpage format) and exit.
  • -help-notes β€” display help notes (description) and exit.
πŸ’€ heads up bestie: if a value looks like it might be missing, remember the defaults β€” 1 for the switch options when you omit the value. don't come for me, that's just what it says.

🫢 SEE ALSO 🫢

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

go read it, it's iconic, fr fr. ⭐


Copyright Β© 2018-2019 OpenCFD Ltd.


and that's the whole page bestie, thanks for scrolling to the end πŸ₯° this came to you from www.openfoam.com on the OpenFOAM- release, filed under ICOFOAM(1) β€” slay, bye, drink water, run your solver πŸ’–βœ¨πŸŒΈ