RunMat
  • Pricing
RunMat
GitHub
GitHub
Sign inTry in browser
DesktopRuntimePhysicsCADAdministrationAgent

Get RunMat updates

New releases, guides and examples.

Product+
  • Runtime
  • GPU
  • Parallel
  • Compile
  • Interop and MEX
  • Simulation
  • MCAD
  • ECAD
  • Enterprise
  • AI integrations
  • Pricing
  • Download
Math+
  • Signal processing
  • Linear algebra
  • Statistics
  • Curve fitting
  • Differential equations
  • Control systems
  • Optimization
  • Finance
  • Data and tables
  • Plotting
Physics+
  • Simulation overview
  • Structural
  • Thermal
  • Electromagnetic
  • Joule heating
  • Thermal stress
  • Acoustics
  • Fluid flow
  • Conjugate heat transfer
  • Fluid–structure
  • What is FEA
Industries+
  • Aerospace
  • Automotive and transportation
  • Defense
  • Electronics and semiconductors
  • Energy
  • Industrial machinery
  • Life sciences
  • Quantitative finance
Learn+
  • Guides
  • Docs
  • Function reference
  • Language reference
  • Migration guide
  • Changelog
  • MATLAB Online
  • MATLAB AI agent
  • For students
Compare+
  • RunMat vs MATLAB
  • RunMat vs Ansys
  • RunMat vs SOLIDWORKS
  • RunMat vs Altium
  • RunMat vs Cadence
  • RunMat vs COMSOL
  • RunMat vs Python
  • RunMat vs Julia
  • RunMat vs Physics AI
  • RunMat vs Octave
  • Benchmarks
  • MATLAB alternatives
  • All comparisons
Company+
  • About
  • Blog
  • Contact
  • Source code↗
  • License
  • Privacy
  • Terms

Product

  • Runtime
  • GPU
  • Parallel
  • Compile
  • Interop and MEX
  • Simulation
  • MCAD
  • ECAD
  • Enterprise
  • AI integrations
  • Pricing
  • Download

Math

  • Signal processing
  • Linear algebra
  • Statistics
  • Curve fitting
  • Differential equations
  • Control systems
  • Optimization
  • Finance
  • Data and tables
  • Plotting

Physics

  • Simulation overview
  • Structural
  • Thermal
  • Electromagnetic
  • Joule heating
  • Thermal stress
  • Acoustics
  • Fluid flow
  • Conjugate heat transfer
  • Fluid–structure
  • What is FEA

Industries

  • Aerospace
  • Automotive and transportation
  • Defense
  • Electronics and semiconductors
  • Energy
  • Industrial machinery
  • Life sciences
  • Quantitative finance

Learn

  • Guides
  • Docs
  • Function reference
  • Language reference
  • Migration guide
  • Changelog
  • MATLAB Online
  • MATLAB AI agent
  • For students

Compare

  • RunMat vs MATLAB
  • RunMat vs Ansys
  • RunMat vs SOLIDWORKS
  • RunMat vs Altium
  • RunMat vs Cadence
  • RunMat vs COMSOL
  • RunMat vs Python
  • RunMat vs Julia
  • RunMat vs Physics AI
  • RunMat vs Octave
  • Benchmarks
  • MATLAB alternatives
  • All comparisons

Company

  • About
  • Blog
  • Contact
  • Source code↗
  • License
  • Privacy
  • Terms
GitHubXLinkedIn

© Dystr, Inc. · RunMat v0.7.1, Nov 17, 2026

RunMat® is a registered trademark of Dystr, Inc. MATLAB® is a registered trademark of The MathWorks, Inc. RunMat is not affiliated with, endorsed by, or sponsored by The MathWorks, Inc.

/
See all docs
Builtin Reference
    • geometry.box
    • geometry.chamfer
    • geometry.cylinder
    • 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

geometry.pocket — Cut a pocket by sweeping a face profile into a geometry feature.

feature = geometry.pocket(target, profile, depth, direction) returns a geometry.Feature for target with the linear sweep of profile by depth meters along direction removed.

Syntax

feature = geometry.pocket(target, profile, depth, direction)

Inputs

target
Type
Any
Required
Yes
Default
—
Description
geometry.Feature to cut.
profile
Type
Any
Required
Yes
Default
—
Description
geometry.Feature whose result is a face or sheet.
depth
Type
NumericScalar
Required
Yes
Default
—
Description
Positive sweep length in meters.
direction
Type
NumericArray
Required
Yes
Default
—
Description
Finite nonzero three-element sweep direction.
NameTypeRequiredDefaultDescription
targetAnyYes—geometry.Feature to cut.
profileAnyYes—geometry.Feature whose result is a face or sheet.
depthNumericScalarYes—Positive sweep length in meters.
directionNumericArrayYes—Finite nonzero three-element sweep direction.

Returns

feature
Type
Any
Description
geometry.Feature for target with the swept profile removed.
NameTypeDescription
featureAnygeometry.Feature for target with the swept profile removed.

Errors

RunMat:geometry:pocket:InvalidInput
When
The wrong number of arguments is passed. target or profile is not a geometry.Feature, depth is not a real numeric scalar, direction is not a finite three-element real vector, or the operand graphs define one feature identity differently. A value violates the feature-graph contract.
Message
geometry.pocket: invalid input
IdentifierWhenMessage
RunMat:geometry:pocket:InvalidInputThe wrong number of arguments is passed. target or profile is not a geometry.Feature, depth is not a real numeric scalar, direction is not a finite three-element real vector, or the operand graphs define one feature identity differently. A value violates the feature-graph contract.geometry.pocket: invalid input

Behavior

The profile is swept like geometry.extrude to form a cutting tool, which is subtracted from target. The profile must realize as a face or sheet so that the sweep is a solid; at realization the tool must also overlap the target volume.

The feature graphs of target and profile are merged; features they share are kept once. Two graphs that define the same feature identity differently are rejected.

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(pocketed) selects the pocket walls and floor.

Errors

RunMat:geometry:pocket:InvalidInput reports every failure of the call: the wrong number of arguments, a target or profile that is not a geometry.Feature, conflicting feature definitions, a depth that cannot be converted, or a direction 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

Record a 3 mm deep pocket

plate = geometry.box(80e-3, 50e-3, 8e-3);
profile = geometry.box(20e-3, 10e-3, 1e-3);
pocketed = geometry.pocket(plate, profile, 3e-3, [0 0 1]);
class(pocketed)

A zero depth is rejected

plate = geometry.box(80e-3, 50e-3, 8e-3);
profile = geometry.box(20e-3, 10e-3, 1e-3);
pocketed = geometry.pocket(plate, profile, 0, [0 0 1]);

Using geometry.pocket with coding agents

Open a RunMat example with live inputs, then ask the agent to explain how geometry.pocket changes the result.

Run a small geometry.pocket example, explain the result, then change one input and compare the output.

FAQ

Can the profile be a solid?⌄

No. The sweep of the profile must be a solid tool, so the profile must be a face or sheet. Use geometry.subtract to remove a solid tool directly.

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.hole · geometry.instance · geometry.intersect · geometry.revolve · geometry.solid · geometry.sphere · geometry.subtract · geometry.transform · geometry.union · geometry.withRegion

Triangulation

DelaunayTri · DelaunayTri.freeBoundary · DelaunayTri.nearestNeighbor · DelaunayTri.pointLocation · freeBoundary · nearestNeighbor · pointLocation

Assets

geometry.inspect · geometry.listRegions · geometry.load · geometry.meshes · geometry.region

Related guides

  • Geometry
  • Geometry, models, and assignments
  • RunMat function integration

Source you can read

Every RunMat function's source is public. Read exactly how geometry.pocket is executed, line by line, in Rust.

  • View the source for geometry.pocket 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.

Getting started · Benchmarks · Pricing

Download RunMat

Download RunMat for full performance, or use RunMat in your browser for zero setup.

Download RunMatOpen Sandbox
On this page
  • Syntax
  • Inputs
  • Returns
  • Errors
  • Behavior
  • Use in a study
  • Errors
  • Examples
  • Record a 3 mm deep pocket
  • A zero depth is rejected
  • Using geometry.pocket with coding agents
  • FAQ
  • Related Geometry functions
  • Construction
  • Triangulation
  • Assets
  • Related guides
  • Source you can read
  • About RunMat