HysteresisDriver

class oommfc.HysteresisDriver(**kwargs)

Hysteresis 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 mc
...
>>> hd = mc.HysteresisDriver(stopping_mxHxm=0.01)

2. Passing an argument which is not allowed.

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

3. Getting the list of allowed attributes.

>>> import oommfc as mc
...
>>> hd = mc.HysteresisDriver()
>>> hd._allowed_attributes
[...]

4. How to define multiple steps with this driver. >>> import micromagneticmodel as mm >>> import oommfc as oc >>> system = mm.examples.macrospin() >>> sd = oc.HysteresisDriver() >>> H = 1 / mm.consts.mu0 >>> sd.drive(system, Hsteps=[ … [(0, 0, 0), (0, 0, H), 10], … [(0, 0, H), (0, 0, -H), 10], … [(0, 0, -H), (0, 0, 0), 10], … ]) Running OOMMF …

---

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.

---