MinDriver

class oommfc.MinDriver(**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 Oxs_MinDriver documentation (https://math.nist.gov/oommf/).

Examples

1. Defining driver with a keyword argument.

>>> import oommfc as oc
...
>>> md = oc.MinDriver(stopping_mxHxm=0.01)

2. Passing an argument which is not allowed.

>>> import oommfc as oc
...
>>> md = oc.MinDriver(myarg=1)
Traceback (most recent call last):
   ...
AttributeError: ...

3. Getting the list of allowed attributes.

>>> import oommfc as oc
...
>>> md = oc.MinDriver()
>>> md._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_mif	Write the mif file and related files.

Properties

name

Name.

---