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

💖 faceAgglomerate — the OpenFOAM glow-up for your boundary faces 💖

okay bestie, listen up, this one is a lil utility from the OpenFOAM crew (the Open Source CFD Toolbox, yes that one) and it lives in the OpenFOAM Commands Manual as faceAgglomerate(1). she's giving quiet overachiever energy: small page, does one thing, does it well. let's get into it 💅

✨ NAME ✨

faceAgglomerate — part of OpenFOAM (The Open Source CFD Toolbox). periodt. that's the whole name section, she's mysterious like that 🎀

✨ SYNOPSIS ✨

faceAgglomerate [OPTIONS]

no positional args, just vibes and options. love that for us 🦋

✨ DESCRIPTION ✨

so what does she actually do? faceAgglomerate agglomerates boundary faces using the pairPatchAgglomeration algorithm. that's the whole plot. and then — the payoff — she writes a map of fine to coarse grid. that's it, that's the job, and she ate 🔥

✨ OPTIONS ✨

the standard lineup, bestie. every single one, no skips:

  • -case dir — specify the case directory to use (instead of the cwd, which is what you'd get otherwise 👀)
  • -decomposeParDict file — use the specified file for the decomposePar dictionary
  • -dict file — use an alternative viewFactorsDict
  • -parallel — run in parallel [Parallel option]
  • -region name — specify an alternative mesh region
  • -doc — display documentation in browser
  • -help — display short help and exit
  • -help-full — display full help and exit

🌸 ADVANCED OPTIONS 🌸

the deep cuts. the ones for when you're feeling brave (or just very specific):

  • -debug-switch name=val — specify the value of a registered debug switch. default is 1 if you omit the value. (can be used multiple times, go wild)
  • -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, yes really 🧚 [Parallel option]
  • -info-switch name=val — specify the value of a registered info switch. default is 1 if you omit the value. (can be used multiple times)
  • -lib name — additional library or library list to load (can be used multiple times)
  • -noFunctionObjects — do not execute function objects
  • -opt-switch name=val — specify the value of a registered optimisation switch (int/bool). default is 1 if you omit the value. (can be used multiple times)
  • -roots (dir1 .. dirN) — slave root directories for distributed running [Parallel option]
  • -doc-source — display source code in browser
  • -help-man — display full help (manpage format) and exit
  • -help-notes — display help notes (description) and exit
ngl bestie, the -help* family is your friend. if you're ever lost, -help-full or -help-notes will catch you 🫶

✨ SEE ALSO ✨

Online documentation: https://www.openfoam.com/documentation/ — go read, iykyk 💜

Copyright © 2018-2019 OpenCFD Ltd. 👑

and that's the whole page, no cap. shoutout to www.openfoam.com and the OpenFOAM- release line for bringing us this iconic lil tool — mwah, she's perfect, stan 💖✨🎀

📦 where this page comes from