RKKY

class micromagneticmodel.RKKY(**kwargs)

RKKY energy term.

This class defines RKKY interaction between two closest (mutually facing) surfaces of subregions defined by passing subregions list.

Parameters:

• sigma (numbers.Real, optional) – Bilinear surface (interfacial) exchange energy constant.

• sigma2 (numbers.Real, optional) – Biquadratic surface (interfacial) exchange energy constant.

• subregions (list, tuple, set) – Length-2 list of strings, which are the names of two interacting regions.

Examples

1. Defining the RKKY energy term between two subregions.

>>> import micromagneticmodel as mm
...
>>> rkky = mm.RKKY(sigma=-1e-4, subregions=['r1', 'r2'])

4. An attempt to define the RKKY energy term using a wrong value.

>>> rkky = mm.RKKY(sigma=-1e-4, subregions='r1')
Traceback (most recent call last):
...
TypeError: ...

---

Methods

__add__	Binary + operator.
__dir__	Default dir() implementation.
__eq__	Relational operator ==.
__iter__	Iterator.
__repr__	Representation string.
density
effective_field
energy

Properties

name	Name.
sigma	Descriptor allowing setting attributes only with scalars (numbers.Real).
sigma2	Descriptor allowing setting attributes only with scalars (numbers.Real).
subregions	Descriptor allowing setting attributes only with values of a certain type.

---