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

πŸ’– OpenFOAM Commands Manual πŸ’–

Okay bestie, let's talk about XiFoam πŸ”₯

✨ NAME ✨

XiFoam is part of OpenFOAM (The Open Source CFD Toolbox) 🌈 It's giving open-source CFD energy.

πŸ¦‹ SYNOPSIS πŸ¦‹

XiFoam [OPTIONS]

🌸 DESCRIPTION 🌸

Okay so XiFoam is a solver for compressible premixed/partially-premixed combustion, and it comes with turbulence modelling built in. It's literally a whole vibe πŸ’…

πŸŽ€ OPTIONS πŸŽ€

Here's the full lineup of options, no cap πŸ‘‘

  • -case dir β€” Pick the case directory you want to use, instead of the current working directory πŸ“‚
  • -decomposeParDict file β€” Tell it which file to use as the decomposePar dictionary 🧩
  • -dry-run β€” Check your case set-up only, using a single time step πŸ™ˆ
  • -dry-run-write β€” Check your case set-up and write, but still only using a single time step ✨
  • -parallel β€” Run in parallel 🫢 [Parallel option]
  • -postProcess β€” Only execute functionObjects, nothing else 🧚
  • -doc β€” Pull up the documentation in your browser πŸ“–
  • -help β€” Show a short help message and exit πŸ’œ
  • -help-full β€” Show the full help and exit πŸ“

🌟 ADVANCED OPTIONS 🌟

Ngl these ones are for the power users 😭

  • -debug-switch name=val β€” Set the value of a registered debug switch. If you leave the value off, it defaults to 1. You can use this multiple times πŸ”₯
  • -fileHandler handler β€” Override the file handler type πŸŽ€
  • -hostRoots ((host1 dir1) .. (hostN dirN)) β€” Set per-host slave root directories for distributed running. The host spec can be a regex, which is giving flexibility πŸ¦‹ [Parallel option]
  • -info-switch name=val β€” Set the value of a registered info switch. If the value is omitted, it defaults to 1. Multiple uses are allowed 🌈
  • -lib name β€” Load an extra library or library list. You can use this multiple times πŸ’…
  • -listFunctionObjects β€” List the functionObjects πŸ“‹
  • -listFvOptions β€” List the fvOptions ✨
  • -listRegisteredSwitches β€” List the switches registered for run-time modification. See the -listUnsetSwitches option too πŸ‘‘
  • -listScalarBCs β€” List the scalar field boundary conditions (fvPatchField<scalar>) 🧁
  • -listSwitches β€” List the switches declared in libraries. See the -listUnsetSwitches option too 🫧
  • -listTurbulenceModels β€” List the turbulenceModels 🌊
  • -listUnsetSwitches β€” This one changes the switch listing so it shows values not set in etc/controlDict πŸ™ˆ
  • -listVectorBCs β€” List the vector field boundary conditions (fvPatchField<vector>) πŸ’œ
  • -noFunctionObjects β€” Don't execute function objects 🚫
  • -opt-switch name=val β€” Set the value of a registered optimisation switch (int/bool). If you leave the value off, it defaults to 1. Multiple uses are allowed πŸ“
  • -roots (dir1 .. dirN) β€” Slave root directories for distributed running [Parallel option] 🌸
  • -doc-source β€” Pull up the source code in your browser 🧚
  • -help-man β€” Show the full help in manpage format, then exit πŸ“œ
  • -help-notes β€” Show the help notes (description), then exit 🫢

πŸ¦‹ SEE ALSO πŸ¦‹

Check out the online docs, they're iconic: Online documentation https://www.openfoam.com/documentation/ πŸ“š

Copyright Β© 2018-2019 OpenCFD Ltd. πŸ‘‘


Okay that's the whole tea, bestie 🫢 Brought to you by www.openfoam.com, source OpenFOAM-, and the XIFOAM(1) page. Periodt πŸ’…βœ¨