VMTKMESHVORTICITYHELICITY(1)

✨ NAME ✨

okay so bestie, welcome to vmtkmeshvorticityhelicity — she's a vmtk script, and yes her full government name is literally vmtkmeshvorticityhelicity 💅

🌸 DESCRIPTION 🌸

So here's the vibe: vmtkmeshvorticityhelicity does automatic piping, parses her options, and then goes to work. That's the whole personality. 💖

vmtkmeshvorticityhelicity : compute vorticity and helicity from a velocity field ✨🔥

No cap, that's the entire point of her existence. Let's get into the receipts.

🫶 Input arguments:

• -id Id (str,1); default=0 — this is the script id, bestie. everyone needs an id. iconic behavior.
• -handle Self (self,1) — a handle to self. she's holding her own hand, we love a self-sufficient queen 🎀
• -disabled Disabled (bool,1); default=0 — if you turn this on, execution and piping just… stop. like she's on do-not-disturb 💀
• -i Mesh (vtkUnstructuredGrid,1) — the input mesh. this is what you're feeding her.
• -ifile MeshInputFileName (str,1) — the filename for the default Mesh reader, so she knows where to look 👀
• -helicity ComputeHelicity (bool,1); default=True — should she compute helicity? default says yes, and honestly, slay.
• -velocityarray VelocityArrayName (str,1); default=None — the name of your velocity array. no default, so you gotta tell her yourself fr fr
• -vorticityarray VorticityArrayName (str,1); default=Vorticity — where the vorticity array lives / what it's called. default is literally just Vorticity.
• -helicityarray HelicityArrayName (str,1); default=Helicity — same energy, but for helicity. default = Helicity.
• -tolerance ConvergenceTolerance (float,1); default=1e-06 — the convergence tolerance, and yes it's tiny. she is precise ✨
• -quadratureorder QuadratureOrder (int,1); default=3 — quadrature order, a cute little integer, defaulting to 3.
• -ofile MeshOutputFileName (str,1) — the filename for the default Mesh writer. this is where the results go, no mystery box 🙈

🦋 Output arguments:

• -id Id (str,1); default=0 — yep, the script id again. she shows up in outputs too, main character energy 👑
• -handle Self (self,1) — and a handle to self again. consistency is a flex.
• -o Mesh (vtkUnstructuredGrid,1) — the output mesh!! the whole reason we're here. your glow-up mesh, hand-delivered 💖

lowkey real talk: -velocityarray defaults to None, so don't just vibe and hope — set your velocity array name yourself, bestie. 🫶

aaaand that's the whole page, periodt. 💅✨ this was vmtkmeshvorticityhelicity version 1.5, from April 2026 — catch you in the next man page, mwah 🎀🌈💜