add annotation in ModuleIO::read/write_cube_core()

deepmodeling · Sep 20, 2024 · f422399 · f422399
1 parent 4a4dc26
commit f422399
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/source/module_io/cube_io.h b/source/module_io/cube_io.h
@@ -49,6 +49,10 @@ extern void write_cube(
     const int out_fermi = 1); // mohan add 2007-10-17
 
 
+// when MPI:
+//      read file as order (ixy,iz) to data[ixy*nz+iz]
+// when serial:
+//      read file as order (ixy,iz) to data[iz*nxy+ixy]
 extern void read_cube_core_match(
     std::ifstream &ifs,
 #ifdef __MPI
@@ -73,6 +77,10 @@ extern void read_cube_core_mismatch(
     const int ny_read,
     const int nz_read);
 
+// when MPI:
+//      write data[ixy*nplane+iz] to file as order (ixy,iz)
+// when serial:
+//      write data[iz*nxy+ixy] to file as order (ixy,iz)
 extern void write_cube_core(
     std::ofstream &ofs_cube,
 #ifdef __MPI