torchgpe.utils.potentials.quench

torchgpe.utils.potentials.quench(v0=1, v1=0, quench_time=1)

Implements a quench from \(v_0\) to \(v_1\) at \(t=quench_time\). The value is constant outside of the interval.

Parameters:

• v0 (float, optional) – The initial value. Defaults to \(1\).

• v1 (float, optional) – The final value. Defaults to \(0\).

• quench_time (float, optional) – The time at which the quench occurs. Defaults to \(1\).

Returns:

The value of the quench at time \(t\)

Return type:

float