ReversibleScalingThermodynamicIntegrationHook

class ReversibleScalingThermodynamicIntegrationHook(total_steps, temperature=None, equilibration_steps=None, lambda_min=None, measurement_call_interval=None)

Post step hook for calculating the temperature dependence of the free energy using reversible scaling

Parameters:
  • total_steps (int) – The total number of simulation steps.

  • temperature (float) – The temperature of the system

  • equilibration_steps (int) – The number of steps to equilibrate at the reference state.

  • lambda_min (float) – Minimum value of the switching parameter used during the simulation.

  • measurement_call_interval (int) – The interval between calculating measurement data

callInterval()
Returns:

The call interval of this hook function.

Return type:

int

reference()

Returns the reference system.

Returns:

The reference system

Return type:

BaseReference

referenceFreeEnergy()

Returns the free energy of the reference system.

Returns:

The enegy of the reference system

Return type:

PhysicalQuantity of type energy

uniqueString()

Return a unique string representing the state of the object.