geometry.cylinder — Create an exact right circular cylinder feature from SI dimensions, an axis, and a base center.
feature = geometry.cylinder(radius, height, axis, origin) returns a geometry.Feature for a solid cylinder whose base circle is centered at origin and which extends height meters along axis.
Syntax
feature = geometry.cylinder(radius, height, axis, origin)Inputs
radius- Type
NumericScalar- Required
- Yes
- Default
- —
- Description
- Positive radius in meters.
height- Type
NumericScalar- Required
- Yes
- Default
- —
- Description
- Positive length along the axis, in meters.
axis- Type
NumericArray- Required
- Yes
- Default
- —
- Description
- Finite nonzero three-element axis direction.
origin- Type
NumericArray- Required
- Yes
- Default
- —
- Description
- Center of the base circle, in meters.
Returns
feature- Type
Any- Description
- geometry.Feature for a right circular cylinder.
Errors
RunMat:geometry:cylinder:InvalidInput- When
- The wrong number of arguments is passed. A dimension is not a real numeric scalar, or axis or origin is not a finite three-element real vector. A value violates the feature-graph contract.
- Message
geometry.cylinder: invalid input
Behavior
radius and height are positive lengths in meters. axis is a three-element direction; only its direction is used, so [0 0 1] and [0 0 5] give the same cylinder, but an all-zero axis is rejected. origin is the center of the base circle in meters; the opposite face is at origin + height * axis / norm(axis).
Use the cylinder as a boss with geometry.union, or as a cutting tool with geometry.subtract. For a drilled bore, geometry.hole records the same cylindrical cut as one named operation and checks at realization that it overlaps the target.
The call records construction intent only. It appends one operation to an immutable, content-addressed feature graph and returns a new geometry.Feature; it does not run a CAD kernel, tessellate, or touch the filesystem. The graph is realized as exact B-rep topology when a .fea geometry declaration that imports the generating function is materialized for meshing or analysis.
All lengths are meters and all angles are radians; there is no unit option. Scalars accept double, single, or an exactly representable integer-class scalar. Vector arguments must be real, finite, non-integer-class numeric arrays with the stated element count; row and column orientation are both accepted.
Every failure, including the wrong number of arguments, a value of the wrong kind, and a value that violates the feature-graph contract (a nonpositive or non-finite length, radius, depth, distance, or angle, or an all-zero direction), raises the builtin's own RunMat:geometry:<name>:InvalidInput identifier, and no value is returned. Feature identities are derived from a digest of each operation, so repeating the same construction yields the same feature identity.
Use in a study
Return the finished part from a pure .m function: geometry.finish(feature) turns the final feature into a geometry.Generated product, and geometry.withRegion publishes typed selections under names. A .fea geometry declaration written as generated by function.<name> calls that function, realizes the exact geometry, and exposes each named selection as output.region.<name> for meshing, material assignment, constraints, and loads.
When the cylinder is a cutting tool, geometry.facesIntroducedBy on the subtraction selects the new bore wall, a typical bolt-load or fixed-support region.
Errors
RunMat:geometry:cylinder:InvalidInput reports every failure of the call: the wrong number of arguments, a scalar that cannot be converted, or an axis or origin that is not a finite three-element real vector, or a value that violates the feature-graph contract, such as a zero or negative dimension, a non-finite value, or an all-zero direction. A failed call returns nothing, and earlier values are unchanged because builder values are immutable.
Examples
Cut a 10 mm bore through a plate
plate = geometry.box(80e-3, 50e-3, 8e-3);
% 5 mm radius, through the 8 mm thickness, centered on the plate
bore = geometry.cylinder(5e-3, 8e-3, [0 0 1], [40e-3 25e-3 0]);
body = geometry.subtract(plate, bore);
class(body)An all-zero axis is rejected
pin = geometry.cylinder(3e-3, 12e-3, [0 0 0], [0 0 0]);Using geometry.cylinder with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how geometry.cylinder changes the result.
Run a small geometry.cylinder example, explain the result, then change one input and compare the output.
FAQ
Is origin the center of the cylinder?⌄
No. It is the center of the base circle. The cylinder extends height from there along axis.
How do I enter millimeter dimensions?⌄
Convert to meters before the call, for example geometry.box(80e-3, 50e-3, 8e-3). When the function is called from a .fea declaration, length inputs already arrive in meters.
Can I display or mesh a feature directly in a script?⌄
Not yet. geometry.Feature and geometry.Generated are construction values; mesh and meshing.generate accept a loaded geometry.Asset. Realization happens when a .fea geometry declaration imports the generating function.
Related Geometry functions
Construction
geometry.box · geometry.chamfer · geometry.edges · geometry.edgesIntroducedBy · geometry.extrude · geometry.faces · geometry.facesIntroducedBy · geometry.fillet · geometry.finish · geometry.hole · geometry.instance · geometry.intersect · geometry.pocket · geometry.revolve · geometry.solid · geometry.sphere · geometry.subtract · geometry.transform · geometry.union · geometry.withRegion
Related guides
Source you can read
Every RunMat function's source is public. Read exactly how geometry.cylinder is executed, line by line, in Rust.
- View the source for geometry.cylinder in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.