VMTKTETGEN(1)

💖 NAME 💖

vmtktetgen — the vmtk script vmtktetgen, living her best tetrahedral life 💅

🦋 DESCRIPTION 🦋

okay bestie, so Automatic piping for vmtktetgen, plus Parsing options for vmtktetgen. That's the whole vibe.

vmtktetgen is a wrapper around TetGen, the tetrahedral mesh generator by Hang Si 🧚 — you can find it at http://tetgen.berlios.de/. She doesn't do the meshing herself, she's the main character delegating.

Below is everything she takes in and everything she hands back 🫶

✨ Input arguments ✨

like, the stuff you feed her:

• -id — takes Id (str,1); default 0. The script id.
• -handle — takes Self (self,1). Handle to self, she's holding her own hand, iconic.
• -disabled — takes Disabled (bool,1); default 0. Turns execution and piping off. Not her era.
• -i — takes Mesh (vtkUnstructuredGrid,1). The input mesh.
• -ifile — takes MeshInputFileName (str,1). The filename for the default Mesh reader.
• -caps — takes GenerateCaps (bool,1); default 0. Close those surface holes with caps before meshing. Plug the leaks, periodt.
• -plc — takes PLC (int,1); default 1. See the TetGen documentation.
• -refine — takes Refine (int,1); default 0. See the TetGen documentation.
• -coarsen — takes Coarsen (int,1); default 0. See the TetGen documentation.
• -noboundarysplit — takes NoBoundarySplit (int,1); default 0. See the TetGen documentation.
• -quality — takes Quality (int,1); default 1. See the TetGen documentation.
• -minratio — takes MinRatio (float,1); default 1.414. See the TetGen documentation.
• -mindihedral — takes MinDihedral (float,1); default 10.0. See the TetGen documentation.
• -maxdihedral — takes MaxDihedral (float,1); default 165.0. See the TetGen documentation.
• -varvolume — takes VarVolume (int,1); default 0. See the TetGen documentation.
• -fixedvolume — takes FixedVolume (int,1); default 0. See the TetGen documentation.
• -maxvolume — takes MaxVolume (float,1); default 0.1. See the TetGen documentation.
• -removesliver — takes RemoveSliver (int,1); default 0. See the TetGen documentation.
• -regionattrib — takes RegionAttrib (int,1); default 0. See the TetGen documentation.
• -epsilon — takes Epsilon (float,1); default 1e-08. See the TetGen documentation.
• -nomerge — takes NoMerge (int,1); default 0. See the TetGen documentation.
• -detectinter — takes DetectInter (int,1); default 0. See the TetGen documentation.
• -checkclosure — takes CheckClosure (int,1); default 0. See the TetGen documentation.
• -order — takes Order (int,1); default 1. See the TetGen documentation.
• -docheck — takes DoCheck (int,1); default 0. See the TetGen documentation.
• -verbose — takes Verbose (int,1); default 0. See the TetGen documentation.
• -usesizingfunction — takes UseSizingFunction (int,1); default 0. See the TetGen documentation.
• -entityidsarray — takes CellEntityIdsArrayName (str,1); default CellEntityIds. The name of the array where the cell entity ids are stored.
• -tetravolumearray — takes TetrahedronVolumeArrayName (str,1); default TetrahedronVolume. The name of the array where the volumes of tetrahedra are stored.
• -sizingfunctionarray — takes SizingFunctionArrayName (str,1); default VolumeSizingFunction. The name of the array where the sizing function values are stored.
• -surfaceelements — takes OutputSurfaceElements (int,1); default 1. Toggles the output surface elements on/off.
• -volumeelements — takes OutputVolumeElements (int,1); default 1. Toggles the output volume elements on/off.
• -ofile — takes MeshOutputFileName (str,1). The filename for the default Mesh writer.

🌸 Output arguments 🌸

and here's what she gives you back, no cap:

• -id — takes Id (str,1); default 0. The script id.
• -handle — takes Self (self,1). Handle to self.
• -o — takes Mesh (vtkUnstructuredGrid,1). The output mesh, the whole point tbh.
• -entityidsarray — takes CellEntityIdsArrayName (str,1); default CellEntityIds. The name of the array where the cell entity ids are stored.
• -tetravolumearray — takes TetrahedronVolumeArrayName (str,1); default TetrahedronVolume. The name of the array where the volumes of tetrahedra are stored.

fr fr: nearly every meshing knob here just says "see the TetGen documentation" — that's not me being lazy, that's literally what the page says, so go read TetGen's docs for the real tea 🍓

this was vmtktetgen version 1.5, dated April 2026, and she ate that. mwah, go mesh something gorgeous bestie 💜✨