Additional comments [no CI]

Author: Martin D. Weinberg

expui/BiorthBasis.cc

@@ -1646,6 +1646,11 @@ namespace BasisClasses
 	// Sanity: check that the DiskType attribute exists
 	//
 	if (!file.hasAttribute("DiskType")) {
+	  // If the DiskType attribute is missing, this may indicate
+	  // an old cache file created before the DiskType metadata
+	  // was added.  We will continue with a warning, but trigger
+	  // cache recomputation to ensure consistency with the
+	  // current DiskType.
 	  if (myid==0) {
 	    std::cout << "---- Cylindrical: DiskType attribute not found in cache file <" << cachename << ">. " << std::endl
 		      << "---- This may indicate an old cache file created before DiskType metadata was added. " << std::endl
@@ -1676,10 +1681,17 @@ namespace BasisClasses
 	  }
 	  else if (disktype == DiskType::python) {
 
+	    // If the DiskType is python, we also need to check that
+	    // the Python module used to create the cache matches the
+	    // current Python module to ensure consistency.  This tag
+	    // should be present in the cache if it was created with a
+	    // recent version of the code, but if it is missing we
+	    // will trigger cache recomputation to ensure consistency
+	    // with the current Python module.
 	    if (file.hasAttribute("pythonDiskType") == false) {
 	      if (myid==0) {
 		std::cout << "---- Cylindrical: pythonDiskType attribute not found in cache file <" << cachename << ">. " << std::endl;
-		std::cout << "---- This may indicate an old cache file created before pythonDiskType metadata was added. " << std::endl;
+		std::cout << "---- Cylindrical: this may be a logic error, trigger recomputation." << std::endl;
 	      }
 	      cache_status = 0;
 	    } else {
@@ -1718,9 +1730,13 @@ namespace BasisClasses
 	  // Get the deproject attribute
 	  //
 	  if (!file.hasAttribute("deproject")) {
+	    // We should not be able to get here since the deproject
+	    // attribute is required for cache creation, but if it is
+	    // missing we will trigger cache recomputation to ensure
+	    // consistency.
 	    if (myid==0) {
 	      std::cout << "---- Cylindrical: deproject attribute not found in cache file <" << cachename << ">. " << std::endl;
-	      std::cout << "---- This may indicate an old cache file created before deproject metadata was added. " << std::endl;
+	      std::cout << "---- Cylindrical: this may be a logic error, trigger recomputation." << std::endl;
 	    }
 	    cache_status = 0;
 	  } else {
@@ -1767,9 +1783,11 @@ namespace BasisClasses
 	      // Get the Python info
 	      //
 	      if (!file.hasAttribute("pythonProjType")) {
+		// We should not be able to get here since the pythonProjType
+		// attribute is required for cache creation with the Python
 		if (myid==0) {
 		  std::cout << "---- Cylindrical: pythonProjType attribute not found in cache file <" << cachename << ">. " << std::endl;
-		  std::cout << "---- This may indicate an old cache file created before pythonProjType metadata was added. " << std::endl;
+		  std::cout << "---- Cylindrical: this may be a logic error, trigger recomputation." << std::endl;
 		}
 
 		cache_status = 0;

src/Cylinder.cc

@@ -2055,19 +2055,27 @@ bool Cylinder::checkDtype()
 		  << cachename << "> is <"
 		  << loaded_dtype << ">," << std::endl
 		  << "which does not match the requested DiskType <"
-		  << dtype << ">, disktype="
-		  << (int)disktype << ", DTYPE="
-		  << (int)DTYPE << std::endl
+		  << dtype << ">" << std::endl
 		  << "---- Cylindrical: forcing cache recomputation"
 		  << std::endl;
       }
       // Force cache recomputation
       cache_status = false;	
     }
     else if (disktype == DiskType::python) {
+      // Sanity check: if DiskType is python, then the pythonDiskType
+      // attribute must exist
+      if (!file.hasAttribute("pythonDiskType")) {
+	if (myid==0) {
+	  std::cout << "---- Cylinder: pythonDiskType attribute not found in cache file <" << cachename << ">. " << std::endl;
+	  std::cout << "---- Cylindier: this may indicate a logic error.  Forcing cache recomputation." << std::endl;
+	}
+	// Force cache recomputation
+	cache_status = false;
+      }
+      auto read_attr = file.getAttribute("pythonDiskType");
       // Get the pyname attribute
       std::vector<std::string> pyinfo;
-      auto read_attr = file.getAttribute("pythonDiskType");
       read_attr.read(pyinfo);
 
       std::string current_md5;
@@ -2101,7 +2109,7 @@ bool Cylinder::checkDtype()
 
 void Cylinder::saveDtype()
 {
-  // Only one process needs to write the dtype metadata
+  // Only one process must write the dtype metadata
   if (myid) return;
 
   std::string dtype = dtstring.at(DTYPE);
@@ -2111,11 +2119,15 @@ void Cylinder::saveDtype()
     //
     HighFive::File file(cachename, HighFive::File::ReadWrite);
 
+    // Write the DiskType attribute (as a string for human readability)
     file.createAttribute<std::string>
       ("DiskType",
        HighFive::DataSpace::From(dtype)).write(dtype);
 
-    // Write the md5sum for the Python module
+    // Write the md5sum for the Python module, if Python disk type is
+    // used.  This will allow us to check for consistency between the
+    // Python module used to create the cache and the current Python
+    // module, and force cache recomputation if they do not match.
     if (DTYPE == DiskType::python) {
       try {
 	std::vector<std::string> pyinfo =