Skip to content

Agitation

agit(...) represents mixing or agitation applied to an existing sample, container, or carrier-like target.

It is separate from transfer. Use << for material movement and agit(...) for actions such as vortexing, inversion, shaking, or stirring. It still belongs near material mutation because it changes how a material state is physically handled without creating readout data or an environment scope.

Examples

text
agit(sample = tube, mode = vortex, duration = 30s, rate = 2000rpm);
text
agit(sample = tube, mode = invert, cycles = 10);
text
agit(sample = tube, mode = stir, duration = 60s, rate = 500rpm);

Arguments

ArgumentRequiredMeaning
sampleyesContainer or group being agitated.
modeyesvortex, invert, shake, or stir.
durationmode-dependentTime duration.
ratemode-dependentAgitation intensity, commonly rpm.
cyclesmode-dependentCount for inversion-style agitation.

Mode Rules

ModeAllowed fieldsNot allowed
vortexduration, ratecycles
invertcyclesduration, rate
shakeduration, ratecycles
stirduration, ratecycles

cycles is not combined with duration or rate.

Environment Interaction

agit.duration and env.duration are different.

  • agit.duration is how long the agitation action lasts.
  • env.duration is the duration of the environmental condition.

When an agitation step is inside an environment block, the action duration must fit within the environment duration.

Released under the Apache-2.0 license.