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

💖 CAVITATINGFOAM 💖

okay bestie, so this one's a cavitatingFoam situation — it's part of OpenFOAM (aka The Open Source CFD Toolbox, and yes it's as iconic as it sounds 🫶).

✨ SYNOPSIS ✨

cavitatingFoam [OPTIONS]

like... that's it. that's the whole vibe check. just the command and whatever options you feel like throwing at it 💅

🌸 DESCRIPTION 🌸

so this is a transient cavitation solver, okay? it's built on the homogeneous equilibrium model, and the way it works is it pulls the compressibility of the liquid/vapour 'mixture' out of that model. literally the whole point. it's giving physics. it's giving bubbles. no cap 💀✨

🎀 OPTIONS 🎀

  • -case dir — tells it which case directory to use instead of the cwd (current working directory, bestie, in case that acronym tried to jump you)
  • -decomposeParDict file — use the file you name for the decomposePar dictionary
  • -dry-run — just checks the case set-up, using a single time step
  • -dry-run-write — checks the case set-up and writes, still only using a single time step
  • -parallel — runs it in parallel 🔥 [Parallel option]
  • -postProcess — executes functionObjects only, nothing else
  • -doc — opens the documentation in your browser
  • -help — short help, then it dips. bye 👋
  • -help-full — full help, then it dips

👑 ADVANCED OPTIONS 👑

these are the main character options, iykyk ✨

  • -debug-switch name=val — sets the value of a registered debug switch. default is 1 if you don't give a value. (you can use this more than once, go off)
  • -fileHandler handler — overrides the file handler type
  • -hostRoots ((host1 dir1) .. (hostN dirN)) — per-host slave root directories for distributed running. the host specification can be a regex, so yeah, regexes, iconic. [Parallel option]
  • -info-switch name=val — sets the value of a registered info switch. default is 1 if the value is omitted. (can be used multiple times)
  • -lib name — loads an additional library, or a whole list of libraries (can be used multiple times)
  • -listFunctionObjects — lists the functionObjects
  • -listRegisteredSwitches — lists the switches registered for run-time modification (peep the -listUnsetSwitches option for more)
  • -listScalarBCs — lists scalar field boundary conditions (fvPatchField<scalar>)
  • -listSwitches — lists switches declared in libraries (again, see the -listUnsetSwitches option)
  • -listTurbulenceModels — lists turbulenceModels
  • -listUnsetSwitches — modifies the switch listing so it displays values that are not set in etc/controlDict
  • -listVectorBCs — lists vector field boundary conditions (fvPatchField<vector>)
  • -noFunctionObjects — does not execute function objects 🚫
  • -opt-switch name=val — sets 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 — opens the source code in your browser
  • -help-man — full help, but in manpage format, then exits
  • -help-notes — help notes (the description), then exits

🦋 SEE ALSO 🦋

Online documentation → https://www.openfoam.com/documentation/ (go read it, bestie, it's right there 🌈)

Copyright © 2018-2019 OpenCFD Ltd.

fr fr, that's the whole page. every flag accounted for. nothing skipped. we ate and left no crumbs 🍓

okay so that's a wrap, my love 💖 this little write-up was brought to you by www.openfoam.com and the OpenFOAM- release series, and yeah it's got that manual-page energy from way back — mwah, stan, periodt 👑✨

📦 where this page comes from