VampireHysteresisLoopSimulation

class VampireHysteresisLoopSimulation(temperature=None, maximum_applied_field_strength=None, applied_field_strength_increment=None, applied_field_angle_phi=None, equilibration_time_steps=None, time_steps_increment=None, loop_time_steps=None, time_step=None, atoms_output_rate=None)

Parameters:

• temperature (PhysicalQuantity of type temperature) – The temperature
  Default: 5 Kelvin

• maximum_applied_field_strength (PhysicalQuantity of type Tesla) – The maximum strength of the applied external field acting on the system. In this simulation, this maximum is the maximum magnitude, and dictates both the maximum and minimum (+/-) magnetisation in the target direction.
  Default: 2.0 T

• applied_field_strength_increment (PhysicalQuantity of type Tesla) – The increment in the strength of the applied external field acting on the system.
  Default: 0.01 T

• applied_field_angle_phi – The angle rotated away from z-axis
  Default: 0.1*Degrees

• equilibration_time_steps (int) – Number of time steps used for equilibration.
  Default: 10,000

• time_steps_increment (int) – Statistics are calculated once every time_steps_increment number of time steps.
  Default: 1

• loop_time_steps (int) – The number of time steps that statistics are taken over. This takes place after equilibration.
  Default: 10,000

• time_step (PhysicalQuantity of type time.) – The time step used in the simulations
  Default: 1 fs

• atoms_output_rate (int) – Determines the rate configuration files are outputted as a multiple of time_steps_increment. If 0, output of configuration data is disabled.
  Default: 1

appliedFieldAnglePhi()

Returns:

The angle of the applied fiels away from the z-axis.

Return type:

PhysicalQuantity of type Degrees.

appliedFieldStrengthIncrement()

Returns:

The increment in the strength of the applied external field.

Return type:

PhysicalQuantity of type Tesla.

atomsOutputRate()

Returns:

The rate at which configuration files are outputted as a multiple of time_steps_increment.

Return type:

int

equilibrationTimeSteps()

Returns:

The number of equilibration time steps

Return type:

int

integrator()

Returns:

The integrator

Return type:

str

loopTimeSteps()

Returns:

The number of time steps used for statistics.

Return type:

int

maximumAppliedFieldStrength()

Returns:

The maximum strength of the applied external field.

Return type:

PhysicalQuantity of type Tesla.

temperature()

Returns:

The temperature

Return type:

PhysicalQuantity of type temperature.

timeStep()

Returns:

The time step.

Return type:

PhysicalQuantity of type time

timeStepsIncrement()

Returns:

The time step increment.

Return type:

int

writeToFile(fd)

Write simulation parameters.

Parameters:

fd (File object.) – File object to write to.