geometry.hole — Cut a cylindrical hole into a geometry feature.
feature = geometry.hole(target, radius, depth, axis, origin) returns a geometry.Feature for target with a cylinder of radius and depth removed, starting at origin and running along axis.
Syntax
feature = geometry.hole(target, radius, depth, axis, origin)Inputs
target- Type
Any- Required
- Yes
- Default
- —
- Description
- geometry.Feature to cut.
radius- Type
NumericScalar- Required
- Yes
- Default
- —
- Description
- Positive hole radius in meters.
depth- Type
NumericScalar- Required
- Yes
- Default
- —
- Description
- Positive hole depth along the axis, in meters.
axis- Type
NumericArray- Required
- Yes
- Default
- —
- Description
- Finite nonzero three-element drilling direction.
origin- Type
NumericArray- Required
- Yes
- Default
- —
- Description
- Center of the hole entry circle, in meters.
Returns
feature- Type
Any- Description
- geometry.Feature for target with a cylindrical hole removed.
Errors
RunMat:geometry:hole:InvalidInput- When
- The wrong number of arguments is passed. target is not a geometry.Feature, 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.hole: invalid input
Behavior
The cutting tool is a cylinder whose base circle is centered at origin and which extends depth meters along axis. Put origin on the entry face and point axis into the material; a depth equal to the wall thickness gives a through hole.
When the graph is realized, the tool must overlap the target volume; a hole that misses the part fails with the target and tool bounds rather than producing an unchanged part.
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.
geometry.facesIntroducedBy(holed) selects the bore wall and any hole floor, a common region for bolt loads, pins, or fixed supports.
Errors
RunMat:geometry:hole:InvalidInput reports every failure of the call: the wrong number of arguments, a target that is not a geometry.Feature, a dimension 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
Drill an 8 mm through hole and select its wall
plate = geometry.box(80e-3, 50e-3, 8e-3);
holed = geometry.hole(plate, 4e-3, 8e-3, [0 0 1], [40e-3 25e-3 0]);
boreWall = geometry.facesIntroducedBy(holed);
class(holed)A zero radius is rejected
plate = geometry.box(80e-3, 50e-3, 8e-3);
holed = geometry.hole(plate, 0, 8e-3, [0 0 1], [40e-3 25e-3 0]);Using geometry.hole with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how geometry.hole changes the result.
Run a small geometry.hole example, explain the result, then change one input and compare the output.
FAQ
How is geometry.hole different from subtracting a cylinder?⌄
The cut is the same. geometry.hole records it as one named operation on the target and checks at realization that the tool overlaps the part.
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.
Related Geometry functions
Construction
geometry.box · geometry.chamfer · geometry.cylinder · geometry.edges · geometry.edgesIntroducedBy · geometry.extrude · geometry.faces · geometry.facesIntroducedBy · geometry.fillet · geometry.finish · 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.hole is executed, line by line, in Rust.
- View the source for geometry.hole 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.