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

👑 CREATEBOXTURB 💅

okay bestie, welcome to the createBoxTurb page — it's a lil tool that's part of OpenFOAM (aka The Open Source CFD Toolbox), and it's genuinely so fun once you know what it does. this is from the OpenFOAM Commands Manual, section 1 (that's the user-commands girlies), and we're gonna go through every single flag together, no skipping, no cap. ✨

🌸 SYNOPSIS 🌸

createBoxTurb [OPTIONS]

that's it, that's the whole vibe. you run it, you give it some options, it does its thing. 🫶

🦋 DESCRIPTION 🦋

okay so here's the tea: createBoxTurb makes you a box of isotropic turbulence — and it builds it based on an energy spectrum that you specify. that's the whole entire job. it's giving "let me just spin up some turbulence real quick" and honestly? iconic. 👑

✨ OPTIONS ✨

every flag, every one, here we go:

  • -case dir — tell it which case directory to use, instead of just rolling with the current working directory (cwd). 🎀
  • -createBlockMesh — build the block mesh, then dip. exit right after. that's it, that's all she does. 💅
  • -decomposeParDict file — use the file you hand it for the decomposePar dictionary. you pick, she obeys. 🍓
  • -parallel — run it in parallel. this one's a Parallel option, so iykyk. 🔥
  • -doc — pops the documentation open in your browser. study buddy mode. 📖
  • -help — shows you the short help, then exits. quick lil hello. 👋
  • -help-full — shows you the FULL help, then exits. the whole lore drop. 😭

💜 ADVANCED OPTIONS 💜

these are for when you're feeling fancy. main character energy only.

  • -debug-switch name=val — set the value of a registered debug switch. if you leave the value off, the default is 1. (Can be used multiple times) so go off. 🐛
  • -fileHandler handler — override the file handler type. bossy, but make it yours. 🗂️
  • -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 — set the value of a registered info switch. value omitted? default is 1. (Can be used multiple times) 💬
  • -lib name — load an additional library, or a whole library list. (can be used multiple times) 📚
  • -noFunctionObjects — do NOT execute function objects. nope. not today. 🙈
  • -opt-switch name=val — set the value of a registered optimisation switch (int/bool). omit the value and you get 1 by default. (Can be used multiple times) ⚙️
  • -roots (dir1 .. dirN) — slave root directories for distributed running. [Parallel option] 🌳
  • -doc-source — shows the source code in your browser. peek behind the curtain, bestie. 🔍
  • -help-man — displays the full help in manpage format, then exits. meta. 🎀
  • -help-notes — displays the help notes (aka the description), then exits. 🗒️
💀 reminder bestie: the parallel-flavoured ones (-parallel, -hostRoots, -roots) are Parallel options, so they're living their best life in distributed-running land. don't be surprised when they act like it.

🌈 SEE ALSO 🌈

go read it, it's right there. 🦋

Copyright © 2018-2019 OpenCFD Ltd.

okay that's the whole page, you ate it, you understood it, you're basically a turbulence girlie now. 💖

signing off from www.openfoam.com, version OpenFOAM-, under the manual section CREATEBOXTURB(1) — periodt. ✨👑🫶

📦 where this page comes from