interaction toy.lift#

Describes the entry toy.lift at version 0.1.0, registered by mime.testing.toys._entries.ToyLift.

At a glance#

  • interaction toy.lift, version 0.1.0, namespace toy

  • Nodes: ToyLiftNode

  • Undocumented, so with no equations to link: ToyLiftNode

  • 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

a

Annotated[Quantity, Force]

{"unit": "N", "value": 0.83}

force (N)

none declared

none: required

max_iterations

int

50

none

none declared

none: required

solve_together

bool

false

none

none declared

none: required

tolerance

float

1e-12

none

none declared

none: required

w

tuple[float, float, float]

[1.0, -0.7, 0.45]

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.

Roles, reads and deliveries#

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

Reads:

Label

Reads

u

medium toy.medium.value

Delivers:

Label

Role

Into the target

load

body

toy.body.load

Reads, values and deliveries that its plan adds for a particular construction are not in these tables: they list what the class declares, and plan is code the build runs when the entry is attached.

Nodes it builds#

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