geometry.withRegion — Publish a typed selection under a name on a generated-geometry part.
part = geometry.withRegion(part, name, output) returns a new geometry.Generated product with the region output output published as name.
Syntax
part = geometry.withRegion(part, name, output)Inputs
part- Type
Any- Required
- Yes
- Default
- —
- Description
- geometry.Generated product from geometry.finish.
name- Type
StringScalar- Required
- Yes
- Default
- —
- Description
- Unique region-output name.
output- Type
Any- Required
- Yes
- Default
- —
- Description
- geometry.RegionOutput from a selection builtin.
Returns
part- Type
Any- Description
- geometry.Generated product with one additional named region output.
Errors
RunMat:geometry:withRegion:InvalidInput- When
- The wrong number of arguments is passed. part is not a geometry.Generated value, output is not a geometry.RegionOutput or names a feature outside the part, or name is not scalar text, is blank, longer than 256 bytes, contains a control character, or is already declared. A value violates the feature-graph contract.
- Message
geometry.withRegion: invalid input
Behavior
name must be nonblank, at most 256 bytes, free of control characters, and not already published on the part. output comes from geometry.solid, geometry.faces, geometry.edges, geometry.facesIntroducedBy, or geometry.edgesIntroducedBy, and it must name a feature in the part's graph. The input part is unchanged; assign the result to keep the region.
The role (solid, face, or edge) and cardinality (exactly one or one or more) travel with the output, so the .fea region that references it is checked against them when the part is realized.
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.
Each published name becomes output.region.<name> in the .fea geometry declaration, for example region bore : face { select output.region.bore; expect one_or_more }.
Errors
RunMat:geometry:withRegion:InvalidInput reports the wrong number of arguments, a part that is not geometry.Generated, an output that is not geometry.RegionOutput or that names a feature outside the part's graph, a name that is not scalar text or is invalid, or a name that is already published.
Examples
Publish body and bore regions
stock = geometry.box(80e-3, 50e-3, 8e-3);
body = geometry.hole(stock, 5e-3, 8e-3, [0 0 1], [40e-3 25e-3 0]);
part = geometry.finish(body);
part = geometry.withRegion(part, "body", geometry.solid(body));
part = geometry.withRegion(part, "bore", geometry.facesIntroducedBy(body));
class(part)A name can be published only once
block = geometry.box(40e-3, 40e-3, 20e-3);
part = geometry.withRegion(geometry.finish(block), "body", geometry.solid(block));
part = geometry.withRegion(part, "body", geometry.solid(block));Using geometry.withRegion with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how geometry.withRegion changes the result.
Run a small geometry.withRegion example, explain the result, then change one input and compare the output.
FAQ
Can I rename or remove a region?⌄
No. Products are immutable and names are unique; rebuild the part from geometry.finish with the regions you want.
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.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
Related guides
Source you can read
Every RunMat function's source is public. Read exactly how geometry.withRegion is executed, line by line, in Rust.
- View the source for geometry.withRegion 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.