From f422399683d130fa5d82043539bc2e0e343846fe Mon Sep 17 00:00:00 2001
From: linpz <linpz@mail.ustc.edu.cn>
Date: Fri, 20 Sep 2024 22:38:29 +0800
Subject: [PATCH] add annotation in ModuleIO::read/write_cube_core()

---
 source/module_io/cube_io.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/source/module_io/cube_io.h b/source/module_io/cube_io.h
index b9c33dfcf4..b49aab9908 100644
--- 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