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

πŸ’– FOAMUPGRADECYCLICS πŸ’–

okay bestie, so this is foamUpgradeCyclics, and it's part of OpenFOAM (aka The Open Source CFD Toolbox, aka the reason your laptop fan sounds like a jet engine). pull up a chair, we're doing this together 🫢


✨ SYNOPSIS ✨

foamUpgradeCyclics [OPTIONS]

🌸 DESCRIPTION 🌸

so this little icon is a tool to upgrade mesh and fields for split cyclics. that's the whole vibe. it takes your old-school split cyclic setup and gives it the glow-up it deserves ✨


πŸŽ€ OPTIONS πŸŽ€

no skipping, we're going through all of them, periodt πŸ’…

  • -case dir β€” tell it which case directory to use instead of just vibing in the cwd (current working directory, iykyk)
  • -constant β€” include the constant/ dir in the times list. yes, that one
  • -decomposeParDict file β€” use this specific file for the decomposePar dictionary instead of the default one
  • -dry-run β€” test only, do not change any files. it's giving window shopping πŸ›οΈ
  • -enableFunctionEntries β€” turn on expansion of dictionary directives β€” #include, #codeStream, etc. the spicy stuff
  • -latestTime β€” select the latest time. most recent era only πŸ’…
  • -noZero β€” exclude the 0/ dir from the times list
  • -parallel β€” run in parallel πŸ”₯ [Parallel option]
  • -region name β€” specify an alternative mesh region
  • -time ranges β€” a list of ranges. for example ':10,20 40:70 1000:', or 'none', etc
  • -doc β€” display the documentation in your browser 🌐
  • -help β€” display short help and dip
  • -help-full β€” display the full help and exit. the whole meal, no crumbs

πŸ‘‘ ADVANCED OPTIONS πŸ‘‘

this is the VIP section, bestie 🎟️

  • -debug-switch name=val β€” set 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 β€” set the value of a registered info switch. default is 1 if you omit the value. (can be used multiple times)
  • -lib name β€” an additional library or library list to load (can be used multiple times)
  • -noFunctionObjects β€” do not execute function objects. they stay seated 😌
  • -opt-switch name=val β€” set 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 the source code in your browser πŸ‘€
  • -help-compat β€” display compatibility options and exit
  • -help-man β€” display full help in manpage format and exit
  • -help-notes β€” display help notes (the description) and exit

πŸ’€ COMPATIBILITY OPTIONS πŸ’€

  • -test (now -dry-run) β€” this option was last used in 1806. it's a relic, an artifact, a museum piece. it's been replaced, so use -dry-run instead 🫠

πŸ¦‹ SEE ALSO πŸ¦‹

online documentation, literally right here: https://www.openfoam.com/documentation/


Copyright Β© 2018-2019 OpenCFD Ltd.


no cap, every single flag above is real and does exactly what it says. don't come for me if you skip a section πŸ™ˆ

okay that's the whole page, you ate that πŸ’… this was foamUpgradeCyclics(1) from the OpenFOAM Commands Manual, brought to you by the fine folks at www.openfoam.com on OpenFOAM-. go upgrade those cyclics, bestie, you've got main character energy πŸŒˆβ­πŸŽ€