CGEvolver

class oommfc.CGEvolver(**kwargs)

Conjugate-Gradient evolver.

Only attributes in _allowed_attributes can be defined. For details on possible values for individual attributes and their default values, please refer to Oxs_CGEvolver documentation (https://math.nist.gov/oommf/).

Examples

1. Defining evolver with a keyword argument.

>>> import oommfc as oc
...
>>> evolver = oc.CGEvolver(method='Polak-Ribiere')

2. Passing an argument which is not allowed.

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

3. Getting the list of allowed attributes.

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

---

Methods

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

Properties

name

Name.

---