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

✨ XiEngineFoam ✨

OpenFOAM Commands Manual, section 1 πŸŽ€ Okay bestie, this is the page for XiEngineFoam πŸ’…

🌈 NAME 🌈

Okay so XiEngineFoam is part of OpenFOAM (The Open Source CFD Toolbox) ✨ open-source fluid dynamics energy, no cap 🫢

🧚 SYNOPSIS 🧚

XiEngineFoam [OPTIONS]

πŸ’œ DESCRIPTION πŸ’œ

Ngl this solver is literally made for compressible premixed/partially-premixed combustion πŸ”₯ with turbulence modelling built right in, and it's all for internal combustion engines. It's giving main character energy πŸ’…

πŸŽ€ OPTIONS πŸŽ€

  • -case dir β€” point it at the case directory you want πŸ“ instead of the cwd (current working directory) 🌸
  • -decomposeParDict file β€” use your own file for the decomposePar dictionary 🧩
  • -parallel β€” run in parallel πŸš€ [Parallel option]
  • -postProcess β€” only run the functionObjects, nothing else πŸ¦‹
  • -doc β€” pop the documentation open in your browser 🌐
  • -help β€” get a quick short help and then it exits πŸ’–
  • -help-full β€” get the full help, then it exits πŸ“–

πŸ¦‹ ADVANCED OPTIONS πŸ¦‹

Okay these ones are for the big brain moments 🧠 read them before you dive in, bestie πŸ™ˆ
  • -debug-switch name=val β€” set a registered debug switch to a value πŸ› if you skip the value it defaults to 1, and you can use it as many times as you want
  • -fileHandler handler β€” swap out 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 a registered info switch to a value ℹ️ if the value is left out it defaults to 1, and it's repeatable too
  • -lib name β€” load an extra library or a list of libraries πŸ“š (repeatable)
  • -listFunctionObjects β€” list the functionObjects πŸ“‹
  • -listFvOptions β€” list the fvOptions πŸ“‹
  • -listRegisteredSwitches β€” list the switches that are registered for run-time modification πŸ”§ (see -listUnsetSwitches option)
  • -listScalarBCs β€” list the scalar field boundary conditions (fvPatchField<scalar>) πŸ“
  • -listSwitches β€” list the switches declared in libraries πŸ“œ (see -listUnsetSwitches option)
  • -listTurbulenceModels β€” list the turbulenceModels πŸŒͺ️
  • -listUnsetSwitches β€” tweaks the switch listing so it shows values that aren't set in etc/controlDict πŸ‘€
  • -listVectorBCs β€” list the vector field boundary conditions (fvPatchField<vector>) 🧭
  • -noFunctionObjects β€” don't run the function objects at all πŸ™…β€β™€οΈ
  • -opt-switch name=val β€” set a registered optimisation switch (int/bool) ⚑ if you leave out the value it defaults to 1, and you can repeat it as much as you like
  • -roots (dir1 .. dirN) β€” slave root directories for distributed running 🌳 [Parallel option]
  • -doc-source β€” pop the source code open in your browser πŸ’»
  • -help-man β€” get the full help in manpage format, then it exits πŸ“°
  • -help-notes β€” get the help notes (the description), then it exits πŸ—’οΈ

πŸ¦‹ SEE ALSO πŸ¦‹

Online documentation lives at https://www.openfoam.com/documentation/ πŸ’œ

Copyright Β© 2018-2019 OpenCFD Ltd. πŸŽ€


Okay bestie, that's the whole thing 🫢 It came from www.openfoam.com, version OpenFOAM- (the version number got cut off, lol πŸ’€), and the page is XIENGINEFOAM(1). The footer doesn't list a date, so I'm not making one up πŸ™ˆ Love you, mean it πŸ’…βœ¨