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

💖 MAGNETICFOAM 💖

okay bestie, sit DOWN, because we're about to talk about magneticFoam, a certified icon of the OpenFOAM Commands Manual, part of OpenFOAM (The Open Source CFD Toolbox). yes, that OpenFOAM. the CFD toolbox. she's giving legend behaviour and honestly? deserved. 🫶

✨ SYNOPSIS ✨

magneticFoam [OPTIONS]

like. that's it. that's the whole vibe. you run the thing, you hand it options, she goes. 💅

🧲 DESCRIPTION 🧲

magneticFoam is the solver for the magnetic field generated by permanent magnets. that's her whole job. she looks at your permanent magnets and she tells you what the magnetic field is doing. no cap, she ate. 🔥

🎀 OPTIONS 🎀

every single one, in order, no skips, because we do not gatekeep here:

  • -HdotGradH — writes the paramagnetic particle force field. yes bestie, the H-dot-grad-H one. say it with me.
  • -case dir — tells her which case directory to use instead of the cwd (current working directory). very "i brought my own folder" of you. 💅
  • -decomposeParDict file — use the specified file for the decomposePar dictionary. custom dict, custom energy.
  • -dry-run — check the case set-up only, using a single time step. a lil peek, no commitment. 👀
  • -dry-run-write — check the case set-up and write, still only using a single time step. so she checks AND she writes. main character behaviour fr fr.
  • -noB — do not write the magnetic flux density field. B? we don't know her. 🙈
  • -noH — do not write the magnetic field intensity field. H? also not invited.
  • -parallel — run in parallel. [Parallel option] multiple cores, multiple vibes, same solve. ⚡
  • -doc — display the documentation in your browser. learn the lore.
  • -help — display short help and exit. the quick lil recap.
  • -help-full — display full help and exit. the whole entire saga.

👑 ADVANCED OPTIONS 👑

this is the vip section. the options for when you're lowkey a wizard. 🧚

  • -debug-switch name=val — specify the value of a registered debug switch. default is 1 if you leave the value out. (can be used multiple times, she's flexible like that)
  • -fileHandler handler — override the file handler type. you pick the handler, you hold the aux.
  • -hostRoots ((host1 dir1) .. (hostN dirN)) — per-host slave root directories for distributed running. the host specification can be a regex. [Parallel option] the host spec being a regex is so slay of her.
  • -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) bring your friends, the more the merrier 💖
  • -listFunctionObjects — lists functionObjects. boom. there they are.
  • -listRegisteredSwitches — list switches registered for run-time modification (see the -listUnsetSwitches option).
  • -listScalarBCs — list scalar field boundary conditions, aka fvPatchField<scalar>. keep that type exactly as written, bestie, it's load-bearing.
  • -listSwitches — list switches declared in libraries (see the -listUnsetSwitches option).
  • -listUnsetSwitches — modifies the switch listing to display values not set in etc/controlDict. the deep lore edition.
  • -listVectorBCs — list vector field boundary conditions, aka fvPatchField<vector>. same deal, exact spelling, no shortcuts.
  • -noFunctionObjects — do not execute function objects. they're off the guest list. 🚫
  • -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 actual code, nerd (affectionate) 🥰
  • -help-man — display full help (manpage format) and exit. it's giving recursive, it's giving meta.
  • -help-notes — display help notes (description) and exit.
🫶 tiny reminder bestie: a bunch of these are [Parallel option], so they only make sense in the parallel girlie lifestyle.

🌈 SEE ALSO 🌈

the online documentation, obviously: https://www.openfoam.com/documentation/

go. read. absorb. iykyk. ✨

Copyright © 2018-2019 OpenCFD Ltd.

periodt. 💅

that's the whole page, bestie — brought to you by the OpenFOAM Commands Manual over at www.openfoam.com, and the version stamp reads OpenFOAM- with the version bit literally blank, which is honestly so mysterious of her 😭. mwah, go solve some magnets. 🧲💖🦋

📦 where this page comes from