VMTKMESHGENERATOR(1)

📦 version 1.5.0, in ubuntu stonking

✨ VMTKMESHGENERATOR ✨

okay so bestie, meet vmtkmeshgenerator — part of the vmtk script family, and it's lowkey iconic. It shows up in section 1 of the manual, aka User Commands, so you already know it's a real one. 🫶

🌸 NAME 🌸

vmtkmeshgenerator — a vmtk script. yes queen, that's literally the whole name section, it's giving minimalism 💅

🎀 DESCRIPTION 🎀

Automatic piping, babe. vmtkmeshgenerator parses its options, then pipes everything along like it's passing notes in the group chat. 📨

Here's the real tea: vmtkmeshgenerator generates a mesh suitable for CFD from a surface. that's the whole assignment. CFD-ready mesh, out of a surface, no cap. 🔥

📥 Input arguments:

  • -id Id (str,1); default=0 — the script id. it's the little name tag everyone wears at the party. 🎀
  • -handle Self (self,1) — a handle to self. yes, it's holding its own hand. self-care fr. 🫶
  • -disabled Disabled (bool,1); default=0 — turn this on and execution and piping get switched off entirely. like airplane mode but for your script. ✈️
  • -i Surface (vtkPolyData,1) — the input surface. the main character of this whole saga. 👑
  • -ifile SurfaceInputFileName (str,1) — filename for the default Surface reader. so it knows what to read, bestie.
  • -edgelength TargetEdgeLength (float,1) >= 0.0; default=1.0 — how long you want your target edges, in numbers.
  • -edgelengtharray TargetEdgeLengthArrayName (str,1) — the name of the array holding your target edge lengths.
  • -edgelengthfactor TargetEdgeLengthFactor (float,1) >= 0.0; default=1.0 — a factor. applied to the target edge length. it's a multiplier, that's it, that's the vibe. ✨
  • -trianglesplitfactor TriangleSplitFactor (float,1) >= 0.0; default=5.0 — the factor for splitting triangles. five whole split. 😌
  • -endcapsedgelengthfactor EndcapsEdgeLengthFactor (float,1) >= 0.0; default=1.0 — edge length factor, but make it endcaps. 🧢
  • -maxedgelength MaxEdgeLength (float,1) >= 0.0; default=1e+16 — the biggest your edges are allowed to get. and yes, 1e+16 is enormous, it's basically letting them be free. 🌈
  • -minedgelength MinEdgeLength (float,1) >= 0.0; default=0.0 — the smallest your edges are allowed to get. zero floor, tiny king.
  • -entityidsarray CellEntityIdsArrayName (str,1); default=CellEntityIds — the array name for cell entity ids.
  • -elementsizemode ElementSizeMode (str,1) in ['edgelength', 'edgelengtharray']; default=edgelength — pick your fighter: edgelength or edgelengtharray. choose wisely bestie. 🦋
  • -cappingmethod CappingMethod (str,1) in ['simple', 'annular', 'concaveannular']; default=simple — three flavors of capping: simple, annular, concaveannular. simple is the default because simple ate. 💅
  • -skipcapping SkipCapping (bool,1); default=0 — set it and capping just… doesn't happen. we're skipping that step, bye. 🙈
  • -skipremeshing SkipRemeshing (bool,1); default=0 — same energy, but for remeshing. we simply will not be remeshing today. 💀
  • -volumeelementfactor VolumeElementScaleFactor (float,1) >= 0.0; default=0.8 — the scale factor for volume elements. point eight. periodt.
  • -boundarylayer BoundaryLayer (bool,1); default=0 — do you want a boundary layer? default is no. flip it to 1 if yes. 🌊
  • -sublayers NumberOfSubLayers (int,1) >= 0; default=2 — how many sublayers. two of them, by default.
  • -substeps NumberOfSubsteps (int,1) >= 0; default=2000 — two thousand substeps. yes, two THOUSAND. that's commitment. 🔥
  • -relaxation Relaxation (float,1) >= 0.0; default=0.01 — the relaxation value. breathe in, breathe out, 0.01. 🧘
  • -localcorrection LocalCorrectionFactor (float,1) >= 0.0; default=0.45 — the local correction factor. fixing things locally, like a girlboss.
  • -sublayerratio SubLayerRatio (float,1) >= 0.0; default=0.5 — the sublayer ratio. exactly half, aesthetically pleasing.
  • -thicknessfactor BoundaryLayerThicknessFactor (float,1) >= 0.0; default=0.25 — how thick your boundary layer gets. a quarter, cute.
  • -remeshcapsonly RemeshCapsOnly (bool,1); default=0 — only remesh the caps, nothing else. caps get the spotlight. 🧢✨
  • -boundarylayeroncaps BoundaryLayerOnCaps (bool,1); default=1 — boundary layer on the caps. this one is ON by default, unlike its sibling up there. 🧢
  • -tetrahedralize Tetrahedralize (bool,1); default=0 — want tetrahedra? default says no, but you can say yes. 🔺
  • -ofile MeshOutputFileName (str,1) — filename for the default Mesh writer. where your mesh goes to live. 🏡
  • -remeshedsurfacefile RemeshedSurfaceOutputFileName (str,1) — filename for the default RemeshedSurface writer. the remeshed surface needs a home too, bestie. 🏠

📤 Output arguments:

  • -id Id (str,1); default=0 — yep, the script id again. it's in both lists, it contains multitudes. 🎀
  • -handle Self (self,1) — and the handle to self, also back for round two. self-love twice. 🫶
  • -o Mesh (vtkUnstructuredGrid,1) — THE output mesh. the whole point. the moment. the payoff. 👑
  • -entityidsarray CellEntityIdsArrayName (str,1); default=CellEntityIds — the cell entity ids array name, appearing on the output side too.
  • -remeshedsurface RemeshedSurface (vtkPolyData,1) — the output surface, post-remesh. she's been through something. 🦋
real talk: this is vmtk's automatic piping machinery, so the -id, -handle, -disabled trio and the various *FileName options are how scripts get chained together and how readers/writers get picked. don't skip them, they're load-bearing. 💖

💜 vmtkmeshgenerator 1.5

that's the version, bestie — 1.5 — dated April 2026. go make a mesh, you're gonna slay. 🎀✨🦋

📦 where this page comes from