ICOUNCOUPL...CELDYMFOAM(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

💖 icoUncoupledKinematicParcelDyMFoam — bestie edition 💖

okay so first things first, the manual name is ICOUNCOUPL...CELDYMFOAM(1) and it lives in the OpenFOAM Commands Manual, which is giving very much "the official docs but make it a group chat". welcome to your new fave page, no cap. ✨

🌸 NAME 🌸

icoUncoupledKinematicParcelDyMFoam — it's part of OpenFOAM (The Open Source CFD Toolbox). that's it, that's the whole vibe. she's a member of the family, an icon, a legend, and honestly? she ate. 💅

🦋 SYNOPSIS 🦋

icoUncoupledKinematicParcelDyMFoam [OPTIONS]

literally that's all you gotta type, bestie. options are optional, the solver is not. 👑

🎀 DESCRIPTION 🎀

she's a transient solver for the passive transport of a single kinematic particle cloud. that's the main character energy right there. and the way she does it? with optional mesh motion and mesh topology changes too. like, she's flexible. she adapts. she's that girl. 🧚

💜 OPTIONS 💜

here's where it gets juicy. every single flag, in order, no skipping, because we don't gatekeep in this house. 🫶

  • -case dir — point her at a specific case directory to use instead of the cwd. basically "hey girl, work over here instead." 📁
  • -cloud name — name your cloud something else if you want. the default is 'kinematicCloud' and that's lowkey iconic as-is, but you do you. ☁️
  • -decomposeParDict file — use the file you specify for the decomposePar dictionary. custom dict, custom slay. 📖
  • -parallel — run in parallel. [Parallel option] she's doing it with her friends, not alone. 🔥
  • -postProcess — execute functionObjects only. no solver run, just the fun little extras. 🙈
  • -doc — display documentation in your browser. go read, bestie, knowledge is free. 📚
  • -help — display short help and exit. the quick version. 💫
  • -help-full — display full help and exit. the whole novel, every last word. 📜

✨ ADVANCED OPTIONS ✨

okay so now we're in the advanced section, this is the VIP area, the backstage pass, the iykyk zone. 💅

  • -debug-switch name=val — specify the value of a registered debug switch. if you leave out the value, the default is 1. (Can be used multiple times — yes, multiple times, she's generous like that.) 🐛
  • -fileHandler handler — override the file handler type. just. override it. periodt. 💅
  • -hostRoots ((host1 dir1) .. (hostN dirN)) — per-host slave root directories for distributed running. the host specification can be a regex, which is highkey powerful. [Parallel option] 🌐
  • -info-switch name=val — specify the value of a registered info switch. value omitted = default of 1. (Can be used multiple times.) ℹ️
  • -lib name — additional library or library list to load. can be used multiple times, load up as many as your heart desires. 📚
  • -listFunctionObjects — list functionObjects. boom, listed. 🗂️
  • -listRegisteredSwitches — list switches registered for run-time modification (see the -listUnsetSwitches option, she'll be mentioned again, don't worry). 🔧
  • -listScalarBCs — list scalar field boundary conditions (fvPatchField<scalar>). scalars, but make it a list. 🔢
  • -listSwitches — list switches declared in libraries (again, see -listUnsetSwitches option). 🧠
  • -listTurbulenceModels — list turbulenceModels. all of them. the whole roster. 🌪️
  • -listUnsetSwitches — modifies switch listing to display values not set in etc/controlDict. sneaky but useful. 🕵️
  • -listVectorBCs — list vector field boundary conditions (fvPatchField<vector>). now with vectors. ⬆️
  • -noFunctionObjects — do not execute function objects. the opposite of -postProcess, she contains multitudes. 🚫
  • -opt-switch name=val — specify the value of a registered optimisation switch (int/bool). omit the value and the default is 1. (Can be used multiple times.) ⚡
  • -roots (dir1 .. dirN) — slave root directories for distributed running. [Parallel option] 🖥️
  • -doc-source — display source code in your browser. go read the source, you brave beautiful soul. 👀
  • -help-man — display full help (manpage format) and exit. yes, exactly like the page you're reading right now. full circle moment. 🔁
  • -help-notes — display help notes (description) and exit. the tl;dr of the tl;dr. 📝
ngl, that's a LOT of options, but you don't need all of them at once, bestie. use what you need, leave the rest. it's not that deep. 💀

🌈 SEE ALSO 🌈

Online documentation, right here, go get your life: https://www.openfoam.com/documentation/ — click it, love it, bookmark it. ⭐

Copyright © 2018-2019 OpenCFD Ltd. — protect the legacy, respect the legacy. 💜

okay and that's the whole page!! 🎀 sign-off time: this lil masterpiece comes from www.openfoam.com, version OpenFOAM-, and the date line is just... sitting there being mysterious, so we're gonna leave it exactly as she came. mwah. 💋✨🦋🌸💖

📦 where this page comes from