API

API#

World

Construct a world with a given cell size.

Grid

Create a Grid instance.

Magnet

A Magnet should never be initialized by the user.

Ferromagnet

Create a ferromagnet instance.

Antiferromagnet

Create an antiferromagnet instance.

NcAfm

Create a non-collinear antiferromagnet instance.

TimeSolver

Evolve the world in time.

ScalarQuantity

Functor representing a physical scalar quantity.

FieldQuantity

A functor representing a physical field quantity.

Variable

Represent a physical variable field, e.g. magnetization.

Parameter

Represent a physical material parameter, e.g. the exchange stiffness.

InterParameter

Represent a physical material parameter which acts between different regions, i.e. inter_exchange.

StrayField

Represent a stray field of a magnet in a specific grid.

PoissonSystem

Poisson System which can be solver for the electrostatic potential.

DmiTensor

Contains the DMI parameters of a ferromagnet.

BoundaryTraction

Contains the traction parameters of a Magnet's boundary at each of the 6 sides of rectangular cells.