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

💖 potentialFreeSurfaceFoam — OpenFOAM Commands Manual 💖

okay so bestie, welcome to potentialFreeSurfaceFoam, which is part of OpenFOAM (The Open Source CFD Toolbox). Yes the real one. The big one. She's iconic, she's open source, and she lives in your terminal now. 🫶

✨ SYNOPSIS ✨

potentialFreeSurfaceFoam [OPTIONS]

that's it. that's the whole vibe. options only, no positional args, we love a low-maintenance queen. 💅

🌊 DESCRIPTION 🌊

So potentialFreeSurfaceFoam is an incompressible Navier-Stokes solver — and the lil twist is she carries a wave height field around with her, which is what lets her do single-phase free-surface approximations. Like, no full two-phase situation needed, she's approximating, she's cute, she's efficient. That's the whole personality. 🌸

🎀 OPTIONS 🎀

every single one, bestie, we are NOT skipping any. no cap.

  • -case dir — tell her which case directory to run in, instead of just using the cwd. very "here's where I live now."
  • -decomposeParDict file — use this specific file as the decomposePar dictionary. you get to pick, main character choice. 👑
  • -dry-run — just check the case set-up, and only using a single time step. a lil dress rehearsal. no writing.
  • -dry-run-write — same energy, check the set-up with a single time step, but this one does write. dress rehearsal but she posts it. 🙈
  • -parallel — run in parallel. [Parallel option] so it's a parallel-specific thing, iykyk.
  • -postProcess — only run the functionObjects, nothing else. side quest only.
  • -doc — pop the documentation open in your browser. study session. ✨
  • -help — short help, then she's out. bye.
  • -help-full — the FULL help, then exit. the extended cut. director's commentary.

🔥 ADVANCED OPTIONS 🔥

this is the deep lore section. buckle up.

  • -debug-switch name=val — set the value of a registered debug switch. if you leave the value out it defaults to 1. can be used multiple times. 🐛
  • -fileHandler handler — override the file handler type. yes ma'am, overwriting. 💅
  • -hostRoots ((host1 dir1) .. (hostN dirN)) — per-host slave root directories for distributed running, and the host spec can be a regex. [Parallel option]. fancy.
  • -info-switch name=val — set the value of a registered info switch. omit the value and it defaults to 1. can be used multiple times.
  • -lib name — load an extra library or a whole list of libraries. can be used multiple times. stack 'em up. 🧚
  • -listFunctionObjects — list functionObjects. that's the whole job.
  • -listFvOptions — list fvOptions. same energy.
  • -listRegisteredSwitches — list the switches that are registered for run-time modification. (peep the -listUnsetSwitches option too, bestie.)
  • -listScalarBCs — list scalar field boundary conditions, aka fvPatchField<scalar>. nerd moment and I respect it.
  • -listSwitches — list the switches declared in libraries. (again, see -listUnsetSwitches.)
  • -listTurbulenceModels — list turbulenceModels. go off.
  • -listUnsetSwitches — changes the switch listing so it shows values that are not set in etc/controlDict. the little gremlins. 👀
  • -listVectorBCs — list vector field boundary conditions, aka fvPatchField<vector>. matching set, obsessed.
  • -noFunctionObjects — do NOT execute function objects. hard pass, none of them.
  • -opt-switch name=val — set the value of a registered optimisation switch (int/bool). omit the value and it defaults to 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. reading the source, truly the final boss move. 💀
  • -help-man — full help, manpage format, then exit.
  • -help-notes — help notes (the description), then exit.

👀 SEE ALSO 👀

Copyright © 2018-2019 OpenCFD Ltd.

okay but fr, big shoutout to OpenCFD Ltd. for that 2018-2019 copyright era, legends only. 🫶

and that's the whole page bestie — stamped from www.openfoam.com with the version tag OpenFOAM- (no date on this one, she's mysterious like that 🌙), and she's filed under POTENTIALFREESURFACEFOAM(1). mwah, periodt. 💖✨

📦 where this page comes from