Term#

class micromagneticmodel.abstract.Term(**kwargs)#

Abstract class for deriving energy and dynamics terms.

This class is derived from micromagneticmodel.abstract.Abstract.

Methods

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

Properties

name

Name.

__add__(other)#

Binary + operator.

It can be applied only between two micromagneticmodel.abstract.Term objects.

Parameters:: other (micromagneticmodel.abstract.Term) – Second operand.
Returns:: Resulting sum.
Return type:: micromagneticmodel.abstract.Container

Examples

Adding energy terms.

>>> import micromagneticmodel as mm
...
>>> exchange = mm.Exchange(A=1e-12)
>>> demag = mm.Demag()
...
>>> container = exchange + demag
>>> type(container)
<class 'micromagneticmodel.energy.energy.Energy'>

Adding dynamics terms.

>>> precession = mm.Precession(gamma0=mm.consts.gamma0)
>>> damping = mm.Damping(alpha=0.01)
...
>>> container = precession + damping
>>> type(container)
<class 'micromagneticmodel.dynamics.dynamics.Dynamics'>

__eq__(other)#

Relational operator ==.

Two terms are considered to be equal if they are instances of the same class.

Parameters:: other (micromagneticmodel.Term) – Second operand.
Returns:: True if two terms are instances of the same class and False otherwise.
Return type:: bool

Examples

Comparing terms.

>>> import micromagneticmodel as mm
...
>>> exchange = mm.Exchange(A=1e-12)
>>> zeeman = mm.Zeeman(H=(0, 0, 1e6))
>>> damping = mm.Damping(alpha=0.1)
>>> demag = mm.Demag()
...
>>> exchange == exchange
True
>>> exchange == mm.Exchange(A=5e-11)
False
>>> zeeman != exchange
True
>>> zeeman == exchange
False
>>> damping == damping
True
>>> damping != exchange
True
>>> demag == exchange
False

__hash__ = None#