# dynamics toy.relaxation

Describes the entry `toy.relaxation` at version `0.1.0`, registered by `mime.testing.toys._entries.ToyRelaxation`.

## At a glance

- dynamics `toy.relaxation`, version `0.1.0`, namespace `toy`
- Nodes: [`ToyMediumNode`](../../nodes/ToyMediumNode.md)
- Undocumented, so with no equations to link: [`ToyMediumNode`](../../nodes/ToyMediumNode.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 |
|---|---|---|---|---|---|
| `coupling` | `Annotated[Quantity, Length ** (-1)]` | `{"unit": "m^-1", "value": 1.9}` | m^-1 | none declared | none: required |
| `drag_gain` | `Annotated[Quantity, Force]` | `{"unit": "N", "value": 0.61}` | force (N) | none declared | none: required |
| `rate` | `Quantity \| None` | `null` | none | numerical | convention |
| `relax_rate` | `Annotated[Quantity, Frequency]` | `{"unit": "Hz", "value": 2.1}` | frequency (Hz) | none declared | none: required |
| `value` | `tuple[float, float, float]` | `[0.1, 0.2, -0.1]` | none | none declared | none: required |

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:

- `rate` (convention): the setting's written default; a node steps every base step unless the experiment chooses a slower rate

## Roles, reads and deliveries

Publishes:

| Interface | Output |
|---|---|
| [`toy.medium.value`](../../vocabulary.md#namespace-toy) | `u` |

## Nodes it builds

- [`ToyMediumNode`](../../nodes/ToyMediumNode.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 |
|---|---|---|
| `accepts` | `ClassVar[Mapping[str, Port]]` | `{"toy.medium.registration": {"field": "registrations", "node": ""}}` |
| `applies_to` | `ClassVar[frozenset[ThingKind]]` | `["medium"]` |
| `flags` | `ClassVar[frozenset[Capability]]` | `[]` |
| `initial_state` | `ClassVar[Mapping[str, Dimension]]` | `{}` |
| `limits` | `ClassVar[tuple[str, ...]]` | `[]` |
| `moving` | `ClassVar[bool]` | `false` |
| `nodes` | `ClassVar[tuple[str, ...]]` | `[""]` |
| `registration_kinds` | `ClassVar[frozenset[str]]` | `["toy.coupled_body"]` |