RelaxDriver

class mumax3c.RelaxDriver(**kwargs)

Energy minimisation driver.

Only attributes in _allowed_attributes can be defined. For details on possible values for individual attributes and their default values, please refer to Mumax3 documentation (https://mumax.github.io).

Examples

1. Defining driver with a keyword argument.

>>> import mumax3c as mc
...
>>> rd = mc.RelaxDriver(DemagAccuracy=6)

2. Passing an argument which is not allowed.

>>> import mumax3c as mc
...
>>> rd = mc.RelaxDriver(myarg=1)
Traceback (most recent call last):
   ...
AttributeError: ...

3. Getting the list of allowed attributes.

>>> import mumax3c as mc
...
>>> rd = mc.RelaxDriver()
>>> rd._allowed_attributes
[...]

---

Methods

__dir__	Default dir() implementation.
__eq__	Return self==value.
__iter__	Iterator.
__repr__	Representation string.
drive	Drives the system in phase space.
drive_kwargs_setup	Additional keyword arguments allowed for drive.
schedule	Schedule drive of the system in phase space.
schedule_kwargs_setup	Additional keyword arguments allowed for schedule.
write_mx3	Write the mx3 file and related files.

Properties

name

Name.

---