FOAMTOVTK(1)

💖 FOAMTOVTK 💖

okay bestie, gather round, because this is foamToVTK, part of OpenFOAM (The Open Source CFD Toolbox), and we're reading it out of the OpenFOAM Commands Manual. she's iconic, she's powerful, she turns your whole case into VTK files. let's get into it 🫶

---

✨ SYNOPSIS ✨

foamToVTK [OPTIONS]

---

🦋 DESCRIPTION 🦋

General OpenFOAM to VTK file writer. that's the whole plot, no cap — your OpenFOAM case goes in, VTK files come out, and then you go live your main character life in ParaView. 💅

---

👑 OPTIONS 👑

• -allRegions — operate on all the regions in regionProperties. all of them. every single one. 💖
• -ascii — write in ASCII format instead of binary. human-readable, slightly chunky, we love her anyway ✨
• -case dir — specify the case directory to use (instead of the cwd). so you don't have to physically live inside the case folder, you can just point at it 🎀
• -constant — include the constant/ dir in the times list 👑
• -fields wordRes — specify single or multiple fields to write (all by default). eg, 'T' or '(p T U "alpha.*")' 🌸
• -latestTime — select the latest time. just the newest one, she's the moment 🦋
• -name subdir — directory name for VTK output (default: 'VTK')
• -no-boundary — suppress output for boundary patches 🙈
• -no-internal — suppress output for the internal volume mesh
• -no-lagrangian — suppress writing lagrangian positions and fields
• -no-point-data — suppress conversion of pointFields. No interpolated PointData. 💀
• -noZero — exclude the '0/' dir from the times list
• -one-boundary — combine all patches into a single file. one file, one vibe, efficient ✨
• -overwrite — remove any existing VTK output directory. bye bye old output, it's giving fresh start 💅
• -parallel — run in parallel [Parallel option] 🔥
• -patches wordRes — specify single patch or multiple patches to write. eg, 'top' or '( front ".*back" )'
• -region name — specify alternative mesh region
• -regions wordRes — operate on selected regions from regionProperties. eg, '( gas "solid.*" )' 🌈
• -time ranges — list of ranges. eg, ':10,20 40:70 1000:', 'none', etc. you pick the eras you care about bestie ⭐
• -doc — display documentation in browser
• -help — display short help and exit
• -help-full — display full help and exit

🌟 ADVANCED OPTIONS 🌟

• -cellSet name — convert mesh subset corresponding to specified cellSet
• -cellZone name — convert mesh subset corresponding to specified cellZone
• -debug-switch name=val — specify the value of a registered debug switch. Default is 1 if the value is omitted. (can be used multiple times) 🧚
• -decomposeParDict file — use specified file for the decomposePar dictionary
• -excludePatches wordRes — specify single patch or multiple patches to exclude from writing. eg, 'outlet' or '( inlet ".*Wall" )' 🙈
• -faceSet name — convert specified faceSet only
• -faceZones wordRes — specify single or multiple faceZones to write. eg, 'cells' or '( slice "mfp-.*" )' ✨
• -fileHandler handler — override the file handler type
• -finiteAreaFields — write finite area fields
• -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 the value is omitted. (can be used multiple times)
• -legacy — write legacy format instead of xml
• -lib name — additional library or library list to load (can be used multiple times)
• -nearCellValue — use cell value on patches instead of patch value itself
• -noFunctionObjects — do not execute function objects
• -opt-switch name=val — specify the value of a registered optimisation switch (int/bool). Default is 1 if the value is omitted. (can be used multiple times) 🍓
• -pointSet name — convert specified pointSet only
• -poly-decomp — decompose polyhedral cells into tets/pyramids
• -processor-fields — write field values on processor boundaries only
• -roots (dir1 .. dirN) — slave root directories for distributed running [Parallel option]
• -surfaceFields — write surfaceScalarFields (eg, phi) 💜
• -with-ids — additional mesh id fields (cellID, procID, patchID)
• -with-point-ids — additional pointID field for internal mesh
• -doc-source — display source code in browser
• -help-compat — display compatibility options and exit
• -help-man — display full help (manpage format) and exit
• -help-notes — display help notes (description) and exit

💀 COMPATIBILITY OPTIONS 💀

these ones are the throwbacks, the old-era lore. read carefully bestie:

• -allPatches (now -one-boundary) — the option was last used in 1806.
• -noLagrangian (now -no-lagrangian) — the option was last used in 1806.
• -noPointValues (now -no-point-data) — the option was last used in 1806.
• -noFaceZones — this option is ignored after 1806.
• -noLinks — this option is ignored after 1806.
• -poly — this option is ignored after 1806.
• -useTimeName — this option is ignored after 1806.
• -xml — this option is ignored after 1806.

not me still passing the 1806 flags 💀 they will simply not do anything. use the new names, bestie, trust.

---

🔗 SEE ALSO 🔗

Online documentation https://www.openfoam.com/documentation/ — go read, she's got range ✨

---

©️ COPYRIGHT ©️

Copyright © 2018-2019 OpenCFD Ltd.

---

www.openfoam.com · OpenFOAM- · FOAMTOVTK(1) — and that's the whole page, bestie!! you ate. now go convert some meshes and be the main character of your own simulation 🎀💖✨🦋👑