VMTKMESHWRITER(1)

💅 VMTKMESHWRITER(1) — User Commands, bestie edition

okay so welcome to the vmtkmeshwriter page, part of the User Commands manual. it's a vmtk script. it writes meshes. that's the whole main character arc. let's go 🦋

✨ NAME ✨

vmtkmeshwriter — it's a vmtk script, babes. literally that's it. vmtkmeshwriter 🎀

🌸 DESCRIPTION 🌸

so the vibe here is automatic piping for vmtkmeshwriter, plus option parsing for vmtkmeshwriter. the script does one iconic thing:

vmtkmeshwriter : write a mesh to disk 💾✨

that's the job. no notes. periodt.

💖 Input arguments:

• -id Id (str,1); default=0 — the script id. it's giving "who am I" but make it numeric 🪪
• -handle Self (self,1) — handle to self. yes bestie, it's a self-reference, we love a recursive queen 👑
• -disabled Disabled (bool,1); default=0 — set this and execution + piping get disabled. like, she's off duty 💀
• -i Mesh (vtkUnstructuredGrid,1) — the input mesh. the raw material. the clay before the sculpt 🗿
• -ifile MeshInputFileName (str,1) — filename for the default Mesh reader. plug in a path, let the reader do its thing 📂
• -f Format (str,1) in ['vtkxml', 'vtk', 'xda', 'fdneut', 'tecplot', 'lifev', 'dolfin', 'fluent', 'tetgen', 'pointdata'] — the file format. quick translation for the girlies: xda is libmesh ASCII format, and fdneut is FIDAP neutral format 🔥
• -guessformat GuessFormat (bool,1); default=1 — guess the file format from the extension. detective mode on by default 🔍
• -compressed Compressed (bool,1); default=1 — output a gz compressed file. dolfin only, so don't go looking for this energy anywhere else 🗜️
• -ofile OutputFileName (str,1) — the output file name. you name it, she writes it ✍️
• -o Mesh (vtkUnstructuredGrid,1) — the output mesh. the glow-up version 🦋
• -mode Mode (str,1) in ['ascii', 'binary']; default=binary — write files in ASCII or binary mode. vtk and vtu only 🧬
• -entityidsarray CellEntityIdsArrayName (str,1); default=CellEntityIds — the name of the array where entity ids are stored 🏷️
• -entityidsoffset CellEntityIdsOffset (int,1); default=-1 — add this number to the entity ids in the output. dolfin only ➕
• -writeregionmarkers WriteRegionMarkers (bool,1); default=0 — write entity ids for volume regions to file. dolfin only 📝

🫶 Output arguments:

• -id Id (str,1); default=0 — script id, yes again, she contains multitudes 🙈
• -handle Self (self,1) — handle to self, also again. iconic of her honestly 💅

heads up bestie: -id, -handle, -mode, -entityidsarray and the rest show up with exact types like str,1, bool,1, vtkUnstructuredGrid,1 — don't freestyle those, they're load-bearing 🌈

that's the whole page fr fr. no cap, every flag stayed. now go write a mesh and slay 💜

🎀 vmtkmeshwriter 1.5, dated April 2026 — that's the source and version signing off. mwah, bye bestie 🎀 ⭐