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.instance — Place one or more transformed copies of a geometry feature.

feature = geometry.instance(source, T1, T2, ...) returns a geometry.Feature whose result contains one copy of source per 4-by-4 homogeneous affine transform.

Syntax

feature = geometry.instance(source, transform1, transform2, ...)

Inputs

source
Type
Any
Required
Yes
Default
—
Description
geometry.Feature to place.
transform
Type
NumericArray
Required
Variadic
Default
—
Description
One or more 4-by-4 homogeneous affine transforms; translation in T(1:3,4), in meters.
NameTypeRequiredDefaultDescription
sourceAnyYes—geometry.Feature to place.
transformNumericArrayVariadic—One or more 4-by-4 homogeneous affine transforms; translation in T(1:3,4), in meters.

Returns

feature
Type
Any
Description
geometry.Feature containing one transformed occurrence of source per transform.
NameTypeDescription
featureAnygeometry.Feature containing one transformed occurrence of source per transform.

Errors

RunMat:geometry:instance:InvalidInput
When
The wrong number of arguments is passed. source is not a geometry.Feature, no transform is given, or a transform is not a finite real 4-by-4 matrix whose final row is [0 0 0 1]. A value violates the feature-graph contract.
Message
geometry.instance: invalid input
IdentifierWhenMessage
RunMat:geometry:instance:InvalidInputThe wrong number of arguments is passed. source is not a geometry.Feature, no transform is given, or a transform is not a finite real 4-by-4 matrix whose final row is [0 0 0 1]. A value violates the feature-graph contract.geometry.instance: invalid input

Behavior

Each transform follows the geometry.transform convention: T(1:3,1:3) is the linear part, T(1:3,4) is the translation in meters, and the final row must be [0 0 0 1]; every transform is checked when the call is made. At least one transform is required, and the transforms are kept in call order.

The result holds only the transformed copies. The untransformed source is not included unless one of the transforms is eye(4). Combine the copies with other bodies using geometry.union or geometry.subtract, for example to cut a hole pattern.

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.

Patterned features keep one feature identity, so geometry.facesIntroducedBy on a subtraction that uses the pattern selects every patterned bore wall at once.

Errors

RunMat:geometry:instance:InvalidInput reports every failure of the call: the wrong number of arguments, a source that is not a geometry.Feature, a call with no transform, or a transform that is not a finite real 4-by-4 matrix with final row [0 0 0 1], 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 two-hole pattern

plate = geometry.box(80e-3, 50e-3, 8e-3);
pin = geometry.cylinder(3e-3, 8e-3, [0 0 1], [0 0 0]);
T1 = eye(4); T1(1:3, 4) = [10e-3; 25e-3; 0];
T2 = eye(4); T2(1:3, 4) = [70e-3; 25e-3; 0];
pins = geometry.instance(pin, T1, T2);
body = geometry.subtract(plate, pins);
class(pins)

At least one transform is required

pin = geometry.cylinder(3e-3, 8e-3, [0 0 1], [0 0 0]);
pins = geometry.instance(pin);

Using geometry.instance with coding agents

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

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

FAQ

Is the original feature part of the result?⌄

No. Only the transformed copies are. Include eye(4) as one of the transforms to keep a copy in place.

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.intersect · geometry.pocket · 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.instance is executed, line by line, in Rust.

  • View the source for geometry.instance 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
  • Cut a two-hole pattern
  • At least one transform is required
  • Using geometry.instance with coding agents
  • FAQ
  • Related Geometry functions
  • Construction
  • Triangulation
  • Assets
  • Related guides
  • Source you can read
  • About RunMat