HysteresisLoop

class HysteresisLoop(temperature, magnetic_field_strengths, magnetic_field_direction, total_magnetic_moments, max_total_magnetic_moment)

An object containing the data from a spin dynamics simulation of a hysteresis loop.

Parameters:

• temperature (PhysicalQuantity of type temperature) – The temperature at which the simulation was run.

• magnetic_field_strengths (PhysicalQuantity of type magnetic field) – The applied magnetic field at each step of the simulation.

• magnetic_field_direction (numpy.ndarray) – The direction of the applied magnetic field.

• total_magnetic_moments (PhysicalQuantity of type energy / magnetic field) – The total magnetic moment at each step of the simulation.

• max_total_magnetic_moment (PhysicalQuantity of type energy / magnetic field) – The maximum total magnetic moment.

coercivity()

Get the coercivity, which is the field one has to apply in the opposite direction of the initial magnetization it takes to demagnetize the system.

Returns:

The coerciticity

Return type:

PhysicalQuantity of type magnetic field

magneticFieldDirection()

Get the direction of the applied magnetic field. :return: The direction of the applied magnetic field. :rtype: numpy.ndarray

magneticFieldStrengths()

Get the applied magnetic field strengths. :return: The applied magnetic fields. :rtype: PhysicalQuantity of type magnetic field.

maxTotalMagneticMoment()

Get the maximum total magnetic moments. :return: The maximum total magnetic moments. :rtype: PhysicalQuantity of type energy / magnetic field

metatext()

Returns:

The metatext of the object or None if no metatext is present.

Return type:

str | None

nlinfo()

Returns:

Structured information about the data.

Return type:

dict

nlprint(stream)

Print report with the data and results to a given stream.

Parameters:

stream (stream) – The stream that the report should be written to.

projectedMagneticMoments()

Get the total magnetic moments projected on the direction of the applied magnetic field. :return: The projected total magnetic moments. :rtype: PhysicalQuantity of type energy / magnetic field

relativeMagnetizations()

Calculate the relative magnetizations. :return: The relative magnetizations. :retype: ndarray

remanence()

Get the remanence, i.e. the magnetic moment when there is no applied magnetic field.

Returns:

The remanence.

Return type:

PhysicalQuantity of type energy / magnetic field

setMetatext(metatext)

Set a given metatext string on the object.

Parameters:

metatext (str | None) – The metatext string that should be set. A value of “None” can be given to remove the current metatext.

temperature()

Get the temperature at which the simulation was run. :return: The temperature. :rttype: PhysicalQuantity of type temperature.

totalMagneticMoments()

Get the total magnetic moments. :return: The total magnetic moments. :rtype: PhysicalQuantity of type energy / magnetic field

uniqueString()

Return a unique string representing the state of the object.