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

πŸ’– coalChemistryFoam(1) πŸ’–

okay bestie, welcome to the OpenFOAM Commands Manual β€” yes, that manual, and yes, we're doing this together 🫢


✨ NAME ✨

coalChemistryFoam β€” part of OpenFOAM (The Open Source CFD Toolbox). that's the whole name section, she's lowkey mysterious like that πŸ’…


🌸 SYNOPSIS 🌸

coalChemistryFoam [OPTIONS]

πŸ¦‹ DESCRIPTION πŸ¦‹

so what does she DO. coalChemistryFoam is a transient solver</> for compressible, turbulent flow with coal and limestone clouds</>, energy sources</> and combustion</>. yeah. she's doing the absolute most and she's doing it well πŸ”₯

basically: gas + particles + heat + fire, all evolving in time. main character energy fr fr πŸ‘‘


πŸŽ€ OPTIONS πŸŽ€

here's the whole roster, no gatekeeping, every single one:

  • -case dir β€” tell her which case directory to use, instead of just vibing in the cwd 🏠
  • -decomposeParDict file β€” use this specific file for the decomposePar dictionary
  • -dry-run β€” check that your case set-up is even valid, using just a single time step. the "getting ready in the mirror" option ✨
  • -dry-run-write β€” same vibe check, but it also writes, still only a single time step
  • -parallel β€” run in parallel πŸƒβ™€οΈ [Parallel option]
  • -postProcess β€” only execute the functionObjects, nothing else
  • -doc β€” pop the documentation open in your browser 🌐
  • -help β€” short help, then she dips
  • -help-full β€” the full help, then she dips

🌈 ADVANCED OPTIONS 🌈

the deep lore section. iykyk πŸ’œ

  • -debug-switch name=val β€” set the value of a registered debug switch. if you omit the value, the default is 1. (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 spec can be a regex πŸ‘€ [Parallel option]
  • -info-switch name=val β€” set the value of a registered info switch. value omitted? default is 1. (can be used multiple times πŸ”)
  • -lib name β€” load an extra library, or a whole list of them (can be used multiple times)
  • -listFunctionObjects β€” list the functionObjects
  • -listFvOptions β€” list the 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 the turbulenceModels
  • -listUnsetSwitches β€” flips the switch listing so it shows values not set in etc/controlDict
  • -listVectorBCs β€” list vector field boundary conditions (fvPatchField<vector>)
  • -noFunctionObjects β€” do not execute function objects πŸ™…β™€οΈ
  • -opt-switch name=val β€” set the value of a registered optimisation switch (int/bool). omit the value and the default is 1. (can be used multiple times πŸ”)
  • -roots (dir1 .. dirN) β€” slave root directories for distributed running [Parallel option]
  • -doc-source β€” open the source code in your browser πŸ“œ
  • -help-man β€” full help in manpage format, then exit
  • -help-notes β€” help notes (the description) and exit

πŸ‘€ SEE ALSO πŸ‘€

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


Copyright Β© 2018-2019 OpenCFD Ltd.


bestie reminder: this is the OpenFOAM Commands Manual page for coalChemistryFoam(1), hosted over at www.openfoam.com β€” and that footer said OpenFOAM- (version string, as shipped) with the manpage date tag riding along at the bottom. go slay some combustion πŸ’–πŸ”₯

periodt. πŸ’…βœ¨