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

💖 MDEQUILIBRATIONFOAM 💖

okay bestie, so this one lives in the OpenFOAM Commands Manual (that's the OpenFOAM part of the header, in case you were wondering), and its whole vibe is: it's mdEquilibrationFoam, part of OpenFOAM, the Open Source CFD Toolbox. she's a real one. 🧚

✨ SYNOPSIS ✨

mdEquilibrationFoam [OPTIONS]

that's it. that's the whole thing. no required args, she just wants options. 💅

🌸 DESCRIPTION 🌸

Equilibrate and/or precondition molecular dynamics systems. that's the entire job description and she's not elaborating. lowkey iconic behaviour honestly. 🦋

🎀 OPTIONS 🎀

  • -case dir — pick the case directory you wanna work in (instead of the cwd, which is what you get if you don't say anything).
  • -decomposeParDict file — use the file you name for the decomposePar dictionary. no cap.
  • -dry-run — just vibe-check the case set-up, using a single time step only. 🫶
  • -dry-run-write — check the case set-up and write, still only using a single time step.
  • -parallel — run in parallel. [Parallel option] go off, queen. 🔥
  • -doc — opens the documentation in your browser. study session fr.
  • -help — short help, then she exits. bye bestie 👋
  • -help-full — the full help, then exit. she's giving main character energy.

👑 ADVANCED OPTIONS 👑

  • -debug-switch name=val — set the value of a registered debug switch. if you leave the value out, the default is 1. (can be used multiple times — stack 'em, queen)
  • -fileHandler handler — override the file handler type.
  • -hostRoots ((host1 dir1) .. (hostN dirN)) — per-host slave root directories for distributed running. the host spec can be a regex, so you can be messy with it. [Parallel option]
  • -info-switch name=val — set the value of a registered info switch. value omitted? default is 1. (can be used multiple times)
  • -lib name — an additional library, or a whole list of libraries, to load (can be used multiple times).
  • -listFunctionObjects — list the 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 so it shows values that are not set in etc/controlDict.
  • -listVectorBCs — list vector field boundary conditions (fvPatchField<vector>).
  • -noFunctionObjects — do not execute function objects. periodt.
  • -opt-switch name=val — set the value of a registered optimisation switch (int/bool). value omitted → default 1. (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. peek behind the curtain, bestie 🙈
  • -help-man — display the full help in manpage format, then exit.
  • -help-notes — display the help notes (the description), then exit.

🌈 SEE ALSO 🌈

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

Copyright © 2018-2019 OpenCFD Ltd.

okay and for the lil sign-off: this page comes to you from www.openfoam.com, running the OpenFOAM- version line, and she's filed under MDEQUILIBRATIONFOAM(1) in the OpenFOAM Commands Manual. that's the whole page bestie, mwah 💖✨🎀

📦 where this page comes from