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

πŸ‘‘ FOAMDICTIONARY β€” the OpenFOAM dictionary whisperer πŸ’…

okay bestie, gather round, because foamDictionary is literally the OpenFOAM command for interrogating and manipulating dictionaries and it's part of OpenFOAM (The Open Source CFD Toolbox) 🫢. Think of it as the group chat where your dict files finally spill the tea β€” you can read them, poke them, diff them, and rewrite them, all from the command line. no cap. ✨


✨ SYNOPSIS ✨

foamDictionary [OPTIONS] dict

πŸŽ€ ARGUMENTS πŸŽ€

  • dict β€” the dictionary file you're processing, aka the main character of this whole operation πŸ’–

🌸 OPTIONS 🌸

  • -add value β€” add a brand new entry, boom, new lore dropped πŸ¦‹
  • -case dir β€” specify the case directory to use, instead of the cwd (so you don't have to be standing in the right spot like a lost little meow meow)
  • -decomposeParDict file β€” use the specified file for the decomposePar dictionary
  • -diff dict β€” write out the differences with respect to the specified dictionary, it's giving comparison content πŸ”₯
  • -diff-etc dict β€” same energy as -diff, but it locates the file as per foamEtcFile
  • -disableFunctionEntries β€” disable expansion of dictionary directives β€” #include, #codeStream etc. they said not today πŸ’€
  • -entry name β€” report/select the named entry, pick your fave πŸ’…
  • -expand β€” read the specified dictionary file, expand the macros etc., and write the resulting dictionary to standard output. literally the glow-up transformation ✨
  • -includes β€” list the #include/#sinclude files to standard output
  • -keywords β€” list keywords πŸ‘‘
  • -parallel β€” run in parallel [Parallel option] πŸƒβ€β™€οΈπŸƒβ€β™€οΈ
  • -precision int β€” set default write precision for IOstreams, numbers gotta be precise bestie
  • -remove β€” remove the entry. gone. deleted. not me erasing it πŸ™ˆ
  • -set value β€” set an entry value or add a new entry, your choice, both slay
  • -value β€” print the entry value
  • -doc β€” display documentation in browser 🌈
  • -help β€” display short help and exit, the lil snack version
  • -help-full β€” display full help and exit, the whole meal πŸ“

πŸ’œ 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)
  • -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)
  • -noFunctionObjects β€” do not execute function objects, they're on pause βœ‹
  • -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-compat β€” display compatibility options and exit
  • -help-man β€” display full help (manpage format) and exit
  • -help-notes β€” display help notes (description) and exit

🧚 COMPATIBILITY OPTIONS 🧚

bestie these are the old ones, tread lightly, they're vintage πŸ‘΅
  • -diffEtc (now -diff-etc) β€” The option was last used in 1712.

πŸ” SEE ALSO πŸ”

Online documentation β€” https://www.openfoam.com/documentation/ β€” go read it, it's giving educational queen πŸ’–


Copyright Β© 2018-2019 OpenCFD Ltd.


okay that's the whole page, you ate that 🫢 this has been FOAMDICTIONARY(1) from the OpenFOAM Commands Manual, brought to you by www.openfoam.com, version OpenFOAM-, and yes it's literally stamped with FOAMDICTIONARY(1) at the bottom too. periodt. πŸ’…βœ¨πŸŒˆ