oommfc.oommf.overhead

oommfc.oommf.overhead()

Run a macrospin example for 1 ps through oommfc and directly and return the difference in run times.

Returns:

The time difference (overhead) between running OOMMF though oommfc and directly.

Return type:

float

Examples

1. Getting the overhead time.

>>> import oommfc as oc
...
>>> isinstance(oc.oommf.overhead(), float)
Running OOMMF...
True