# geometry labx.bead

Describes the entry `labx.bead` at version `0.1.0`, registered by `mime_lab_fixture.Bead`.

## At a glance

- geometry `labx.bead`, version `0.1.0`, namespace `labx`
- Derivative: `piecewise_jump`
- Validity: none declared

## What it models, and when not to use it

No hand-written part: this entry's source has not been written (the docs walk counts it).

## Settings

| Setting | Type | Default | Dimension | Role | Default's kind |
|---|---|---|---|---|---|
| `radius` | `Annotated[mime.units.Quantity, Dimension(exponents=(1, 0, 0, 0, 0, 0, 0))]` | `{"required": true}` | length (m) | physical | none |

Each role and default's kind is the entry's `setting_roles` (`mime.registry.SettingRole`); a setting that declares none is required.

## Capabilities

Generated from which of the optional methods of `mime.registry.Geometry` the kind implements; a consumer that needs one it lacks is refused when it plans, naming both.

| Capability | What it gives | Used by | This kind |
|---|---|---|---|
| `samples` | surface samples by named patch, at a resolution the consumer chooses | the MRS; immersed-boundary markers | yes |
| `area` | the area of each patch | the samples' weights | yes |
| `mass_properties` | volume and inertia at a density | the part resolver | yes |
| `radial_reach` | the hull's radial reach about its axis | a body's extent; contact on the hull | yes |
| `family_parameters` | the parameters of the family it is | a surrogate trained on one family | no |
| `tangent` | a tangent it declares at a surface point | a law anisotropic along it | no |
| `native` | its native form, one of USD's own primitives | the stage writer | no |
| `drawing` | a drawing, tessellated at the writer's resolution | the stage writer, for a kind with no native form | no |
| `region_primitive` | its regions as OpenMaterica's primitives: exactly, or (a region with no end along an axis) clipped at the kind's own length, or refused | OpenMaterica's manifest and stage | no |
| `reach` | reach | not stated | yes |
| `sampling` | sampling | not stated | yes |
| `support` | support | not stated | no |

`native`: none, so the stage writes it in MIME's schema with its drawing.

`placement`: none: its own frame is the frame its settings are written in.

Run-time capabilities (signed distance, outward normal, nearest point) are its regions' and surfaces' shapes, listed below.

## Nodes it builds

Builds no node of its own.

## Gradient status

The derivative through this entry is `piecewise_jump`: not the exact derivative of what it computes everywhere.

## Validity

none declared

## References

none declared

## Other declarations

| Class variable | Type | Value |
|---|---|---|
| `directions` | `ClassVar[tuple[str, ...]]` | `[]` |
| `moving` | `ClassVar[bool]` | `false` |
| `patches` | `ClassVar[Mapping[str, str]]` | `{"surface": "solid"}` |
| `reach_envelope` | `ClassVar[float]` | `0.0` |
| `region_shapes` | `ClassVar[Mapping[str, str]]` | `{"solid": "sphere"}` |
| `regions` | `ClassVar[tuple[str, ...]]` | `["solid"]` |
| `support_basis` | `ClassVar[str]` | `` |
| `support_error` | `ClassVar[float]` | `0.0` |
| `surfaces` | `ClassVar[Mapping[str, str]]` | `{}` |