# interaction labx.nudge

Describes the entry `labx.nudge` at version `0.1.0`, registered by `mime_lab_fixture.Nudge`.

## At a glance

- interaction `labx.nudge`, version `0.1.0`, namespace `labx`
- Nodes: [`NudgeNode`](../../nodes/NudgeNode.md)
- Undocumented, so with no equations to link: [`NudgeNode`](../../nodes/NudgeNode.md)
- Derivative: `exact`
- 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 |
|---|---|---|---|---|---|
| `force` | `Annotated[mime.units.Quantity, Dimension(exponents=(1, 1, -2, 0, 0, 0, 0))]` | `{"unit": "N", "value": [0.0, 0.0, -0.05]}` | force (N) | design | convention |

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

Each default is a claim (`mime.registry.DefaultKind`): a determined default is resolved in every profile, a convention taken in every profile, a numerical default taken in exploratory only and stamped pending. Their rules and bases:

- `force` (convention): the setting's written default; the fixture's nudge: a made-up constant load for the tests

## Roles, reads and deliveries

Roles, bound by keyword when the entry is attached: `body` (body).

Delivers:

| Label | Role | Into the target |
|---|---|---|
| `load` | body | [`toy.body.load`](../../mechanisms/load.md) |

## Nodes it builds

- [`NudgeNode`](../../nodes/NudgeNode.md)

Declared in `builds`; the node walk compares it with what a round-trip case builds.

## Gradient status

The derivative through this entry is `exact`, the derivative of what it computes.

## Validity

none declared

## References

none declared

## Other declarations

| Class variable | Type | Value |
|---|---|---|
| `holds_off` | `ClassVar[str \| None]` | `null` |
| `id_roles` | `ClassVar[tuple[str, ...] \| None]` | `null` |
| `moving` | `ClassVar[bool]` | `false` |