FOAMTOENSIGHT(1)

💖 NAME 💖

okay so bestie, welcome to FOAMTOENSIGHT(1) — it's a page from the OpenFOAM Commands Manual, and foamToEnsight is literally part of OpenFOAM, aka The Open Source CFD Toolbox. yes. the whole toolbox. she contains multitudes 💅

---

✨ SYNOPSIS ✨

foamToEnsight [OPTIONS]

that's it. that's the whole vibe. you give her options, she gives you Ensight files 🦋

---

🌸 DESCRIPTION 🌸

So what does she actually do, you ask? She translates your OpenFOAM data into Ensight format — and not as one big blob, no no. She makes a part for the internalMesh, plus a part for each patch. Every patch gets its own little moment on stage. main character energy for each one, fr fr 👑

---

💅 OPTIONS 💅

• -ascii — write everything in ASCII format instead of the default 'C Binary'. human-readable queen, but bigger files, just saying 🍓
• -case dir — tell her which case directory to use, instead of the cwd (current working directory, iykyk)
• -cellZone word — pick which cellZone to write
• -constant — include the 'constant/' dir in the times list. she's coming along too 🫶
• -faceZones wordRes — specify one faceZone, or a whole lil list of them, to write. Eg, 'cells' or '( slice "mfp-.*" )'
• -fields wordRes — pick one field or a whole list of fields to write (all of them by default, she's generous like that). Eg, 'T' or '( "U.*" )'
• -latestTime — just grab the latest time. no thoughts, only now ✨
• -name subdir — sub-directory name for the Ensight output. default is 'EnSight'
• -no-boundary — suppress writing any patches. silence them all 💀
• -no-internal — suppress writing the internal mesh. she said not today
• -no-lagrangian — suppress writing lagrangian positions and fields
• -noZero — exclude the '0/' dir from the times list
• -nodeValues — write the values at the nodes
• -parallel — run it in parallel 🔥 [Parallel option]
• -patches wordRes — pick a single patch or multiple patches to write. Eg, 'inlet' or '(outlet "inlet.*")'
• -region name — specify an alternative mesh region
• -time ranges — a whole list of ranges, bestie. Eg, ':10,20 40:70 1000:', 'none', etc
• -width n — width of the Ensight data subdir
• -doc — pop the documentation open in your browser 🌈
• -help — short help, then exit. lil snack 🎀
• -help-full — full help, then exit. the whole meal 😭

👑 ADVANCED OPTIONS 👑

• -debug-switch name=val — set the value of a registered debug switch. default is 1 if you omit the value. (can be used multiple times, go off)
• -decomposeParDict file — use the specified file for the decomposePar dictionary
• -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, she's flexible like that 💅 [Parallel option]
• -info-switch name=val — set the value of a registered info switch. default is 1 if the value is omitted. (can be used multiple times)
• -lib name — an additional library, or a whole list of libraries, to load (can be used multiple times)
• -noFunctionObjects — do not execute function objects
• -opt-switch name=val — set 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 👀
• -help-compat — display compatibility options, then exit
• -help-man — display full help (manpage format), then exit
• -help-notes — display help notes (the description), then exit

🦋 COMPATIBILITY OPTIONS 🦋

okay so these are the old ones. they're giving vintage. still listed, still real, but like — they're legacy, bestie.

• -noLagrangian (now -no-lagrangian) — the option was last used in 1806.
• -noPatches (now -no-boundary) — the option was last used in 1806.

---

🌟 SEE ALSO 🌟

Online documentation, go read it, it's iconic: https://www.openfoam.com/documentation/

---

💜 COPYRIGHT 💜

Copyright © 2018-2019 OpenCFD Ltd.

---

okay that's the whole page, and now the cute sign-off: this lil masterpiece lives at www.openfoam.com, carries the source/version tag OpenFOAM-, and answers to the manual name FOAMTOENSIGHT(1) — so if you ever need her again, that's where to find her 🫶✨ slay, go translate some data, mwah 💖