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

👑 POTENTIALFREESURFACEDYMFOAM 👑

okay so this is potentialFreeSurfaceDyMFoam, and it lives in the OpenFOAM Commands Manual (yes the whole name is a mouthful, we love her anyway 💖). She's an OpenFOAM solver, she's part of the Open Source CFD Toolbox, and she's here to do waves. let's get into it bestie.

✨ NAME ✨

potentialFreeSurfaceDyMFoam — part of OpenFOAM (The Open Source CFD Toolbox). that's the whole name section, short and sweet, periodt. 🎀

🌸 SYNOPSIS 🌸

potentialFreeSurfaceDyMFoam [OPTIONS]

that's it. that's the vibe. options are optional, the drama is mandatory. 💅

🦋 DESCRIPTION 🦋

so what does she actually do. she's an incompressible Navier-Stokes solver — classic — but with a lil something extra: she includes a wave height field so you can do single-phase free-surface approximations. it's giving "waves but make it efficient". 🌊

and she's flexible too: optional mesh motion and mesh topology changes are on the menu. so like, the mesh can move, the mesh can change shape, she handles it. main character energy fr fr. 👑

💖 OPTIONS 💖

  • -case dir — tell her which case directory to use, instead of just going with the cwd (the current working directory). girl knows how to find her own home but she'll take directions too. 🫶
  • -decomposeParDict file — use this specific file for the decomposePar dictionary. not the default one, this one. 💅
  • -parallel — run in parallel! [Parallel option] so you can spread the workload across multiple cores and feel powerful. 🔥
  • -postProcess — only execute the functionObjects. nothing else, just the functionObjects, like a lil snack. 🍓
  • -doc — display the documentation in your browser. ✨
  • -help — display short help and exit. quick lil peek. 🙈
  • -help-full — display full help and exit. the whole thing. no skimping. 💖

🌈 ADVANCED OPTIONS 🌈

these are the deep cuts, iykyk. 🧚

  • -debug-switch name=val — specify the value of a registered debug switch. the default is 1 if you omit the value. (can be used multiple times — stack 'em up bestie) 💜
  • -fileHandler handler — override 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 you can be fancy with it. [Parallel option] 👑
  • -info-switch name=val — specify the value of a registered info switch. default is 1 if the value is omitted. (can be used multiple times) ⭐
  • -lib name — additional library or library list to load (can be used multiple times). load 'em up. 🎀
  • -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 — modifies the switch listing to display values not set in etc/controlDict. sneaky peek at the blanks. 🙈
  • -listVectorBCs — list vector field boundary conditions (fvPatchField<vector>). 🌸
  • -noFunctionObjects — do not execute function objects. hard pass on those. 🚫
  • -opt-switch name=val — specify 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 — display the source code in your browser. go read the source, icon. 📖
  • -help-man — display full help (manpage format) and exit. 📄
  • -help-notes — display help notes (description) and exit. 📝

🔗 SEE ALSO 🔗

Online documentation: https://www.openfoam.com/documentation/ — go read it, bestie, it's right there. ✨

Copyright © 2018-2019 OpenCFD Ltd. all rights reserved, all respect given. 🫶

lowkey a whole solver, highkey obsessed with her. 💅

and that's the tea, bestie — this page came to you straight from www.openfoam.com, sitting pretty in OpenFOAM- land, and she's been serving since the day this manual page was stamped. slay, POTENTIALF...FACEDYMFOAM(1), we love you, bye 💖🌸🦋

📦 where this page comes from