Added information to batch omf2vtk

davidcortesortuno · Jan 10, 2020 · a388d76 · a388d76
1 parent 249b5d5
commit a388d76
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/oommfpy/tools/omf2vtk.py b/oommfpy/tools/omf2vtk.py
@@ -48,7 +48,10 @@ def omf2vtk_batch(input_omfs,
     Convert all OMF files (or with a different extension) into VTK files
     according to the input path, which can be a directory or a path with a
     wildcard expression. Progress of the conversion is printed on every
-    iteration
+    iteration.
+    IMPORTANT: this function assumes the OMF files in the folder come from
+    the SAME simulation, since the mesh grid is not updated. The loop only
+    updates the magnetisation field.
 
     input_omfs    :: a directory, or path with a wildcard, e.g. 'omfs/m_*.ovf'
     output_format :: only binary