Xf_ThermHeunEvolver

class oommfc.Xf_ThermHeunEvolver(**kwargs)

Xf_ThermHeun evolver (combines Runge-Kutta and UHH_ThetaEvolve).

Only attributes in _allowed_attributes can be defined. For details on possible values for individual attributes and their default values, please refer to Xf_ThermHeunEvolver documentation (https://kelvinxyfong.wordpress.com/research/research-interests/oommf-extensions/xf_thermheunevolve/).

Examples

1. Defining evolver with a keyword argument.

>>> import oommfc as oc
...
>>> evolver = oc.Xf_ThermHeunEvolver(method='rk4')

2. Passing an argument which is not allowed.

>>> import oommfc as oc
...
>>> evolver = oc.Xf_ThermHeunEvolver(myarg=3)
Traceback (most recent call last):
   ...
AttributeError: ...

3. Getting the list of allowed attributes.

>>> import oommfc as oc
...
>>> evolver = oc.Xf_ThermHeunEvolver()
>>> evolver._allowed_attributes
[...]

---

Methods

__dir__	Default dir() implementation.
__eq__	Return self==value.
__iter__	Iterator.
__repr__	Representation string.

Properties

name

Name.

---