Ramp

class hoomd.variant.Ramp(A, B, t_start, t_ramp)

Bases: Variant

A linear ramp.

Parameters:

  • A (float) – The start value.

  • B (float) – The end value.

  • t_start (int) – The start time step.

  • t_ramp (int) – The length of the ramp.

Ramp holds the value A until time t_start. Then it ramps linearly from A to B over t_ramp steps and holds the value B.

Example plot of a ramp variant.

Example:

variant = hoomd.variant.Ramp(
    A=1.0, B=2.0, t_start=10_000, t_ramp=100_000
)

Members inherited from Variant:

__call__()

Evaluate the function. Read more...

property max

Maximum value of the variant. Read more...

property min

Minimum value of the variant. Read more...

Members defined in Ramp:

A

The start value.

Type:

float

B

The end value.

Type:

float

t_start

The start time step.

Type:

int

t_ramp

The length of the ramp.

Type:

int