Window#

class Window#

Bases: object

Simulation window of the world.

Each world already has its own Window. This Window can be accessed through the world.window property.

Windows should not be initialized by the end user.

__init__(impl)#
insert_magnetization(boundary, value=(0, 0, 0))#

Set magnetization value at a given boundary. If set to zero (default), the current edge value is used.

For multi-sublattice magnets, the magnetization value of sub1 should be provided.

Parameters:
  • boundary (int) – Boundary index: 0 = Left/Bottom, 1 = Right/Top

  • value (tuple of 3 floats) – Magnetization vector (x, y, z)

disable_motion()#

Disable the motion of the simulation window.

property position#

Returns the current position of the simulation window (m). The origin of the window coincides (when unmoved) with the origin of a Grid instance, i.e. it is determined by the coordinate of the lower left cell.

property velocity#

Returns the current velocity of the simulation window (m/s).

property total_shift#

Returns the total amount shifted by the simulation window (m).