OOMMFRunner#

class oommfc.oommf.OOMMFRunner#

Abstract class for running OOMMF.


Methods

__dir__

Default dir() implementation.

__eq__

Return self==value.

__repr__

Return repr(self).

call

Call an external simulation package by passing argstr to it.

errors

Returns the content of boxsii.errors OOMMF file.

Properties

package_name

Simulation package name.

platform

Return platform seen by OOMMF.

status

Run a macrospin example for 1 ps through oommfc and print the OOMMF status.

version

Return the OOMMF version.


abstract __repr__()#

Return repr(self).

abstract errors()#

Returns the content of boxsii.errors OOMMF file.

Returns:

boxsii.errors OOMMF file.

Return type:

str

property package_name#

Simulation package name.

property platform#

Return platform seen by OOMMF.

Returns:

Platform.

Return type:

str

Examples

  1. Getting platform.

>>> import oommfc as oc
...
>>> runner = oc.runner.runner
>>> runner.platform
'...'
property status#

Run a macrospin example for 1 ps through oommfc and print the OOMMF status.

Returns:

If 0, then OOMMF is found and running. Otherwise, 1 is returned.

Return type:

int

Examples

  1. Checking the OOMMF status.

>>> import oommfc as oc
...
>>> oc.runner.runner.status
Running OOMMF...
OOMMF found and running.
0
property version#

Return the OOMMF version.

Returns:

OOMMF version.

Return type:

str

Examples

  1. Getting OOMMF version.

>>> import oommfc as oc
...
>>> runner = oc.runner.runner
>>> runner.version
'...'