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

💖 MHDFOAM(1) 💖

okay bestie, welcome to mhdFoam — she's part of OpenFOAM (The Open Source CFD Toolbox), and she is so much cooler than her plain little name suggests. this is the page for the mhdFoam command in the OpenFOAM Commands Manual, and we're gonna go through every single flag together, no skipping, no scrolling past the "boring" bits. periodt. ✨

✨ SYNOPSIS ✨

mhdFoam [OPTIONS]

🦋 DESCRIPTION 🦋

so basically: mhdFoam is a solver for magnetohydrodynamics (MHD). it does incompressible, laminar flow of a conducting fluid under the influence of a magnetic field. that's the whole vibe. fluid + magnets + laminar + incompressible, and the solver handles it. main character energy fr fr 🔥

💅 OPTIONS 💅

  • -case dir — tell her which case directory to use, instead of just assuming you mean the cwd (current working directory). 🏠
  • -decomposeParDict file — use the file you specify for the decomposePar dictionary.
  • -dry-run — check the case set-up only, using a single time step. like a lil rehearsal, no commitment. 🎭
  • -dry-run-write — check the case set-up and write, still only using a single time step.
  • -parallel — run in parallel. [Parallel option] 🏃‍♀️🏃‍♀️🏃‍♀️
  • -postProcess — execute functionObjects only. nothing else, just the functionObjects.
  • -doc — display documentation in your browser. 🌐
  • -help — display short help and exit. (the quick lil snack version)
  • -help-full — display full help and exit. (the whole meal)

👑 ADVANCED OPTIONS 👑

  • -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) 🐛
  • -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. [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). 📚
  • -listFunctionObjects — list functionObjects.
  • -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).
  • -listUnsetSwitches — modifies the switch listing to display values not set in etc/controlDict. 👀
  • -listVectorBCs — list vector field boundary conditions (fvPatchField<vector>).
  • -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 your browser. 🤓
  • -help-man — display full help (manpage format) and exit.
  • -help-notes — display help notes (description) and exit.

🌈 SEE ALSO 🌈

online documentation, bestie: https://www.openfoam.com/documentation/ — go, slay, read. 🫶

Copyright © 2018-2019 OpenCFD Ltd.

and that's the whole thing!! written by the OpenFOAM crew at www.openfoam.com, from the OpenFOAM- source, and this page is dated like a classic manpage footer because that's just how she rolls. mwah 💋 stay conducting, babe ✨💖

📦 where this page comes from