Cleanup

Author: franzpoeschel

include/openPMD/backend/ScientificDefaults.hpp

@@ -28,8 +28,17 @@ class ScientificDefaults
     void defaults_impl(OpenpmdStandard);
 
 protected:
-    void addDefaultsRecursively(OpenpmdStandard);
-    void addDefaults(OpenpmdStandard);
+    // Called upon Iteration::close(), will fill in defaults below Iteration
+    // level. If the Iteration is not explicitly closed, will be called upon
+    // Series::close().
+    void writeDefaultsRecursively(OpenpmdStandard);
+    // Currently called internally only from writeDefaultsRecursively
+    void writeDefaults(OpenpmdStandard);
+    // Convention: This is called for each openPMD object (group, dataset)
+    // exactly once and only upon its most derived object (e.g. upon
+    // RecordComponent, not BaseRecordComponent). The readDefaults() method will
+    // deal with parent class definitions. This is necessary since the derived
+    // class may override standard attribute definitions from a base class.
     void readDefaults(OpenpmdStandard);
 };
 

src/Iteration.cpp

@@ -113,7 +113,7 @@ Iteration &Iteration::close(bool _flush)
 
     if (access::write(IOHandler()->m_frontendAccess))
     {
-        addDefaultsRecursively(IOHandler()->m_standard);
+        writeDefaultsRecursively(IOHandler()->m_standard);
     }
 
     if (_flush)

src/backend/MeshRecordComponent.cpp

@@ -39,10 +39,9 @@ MeshRecordComponent::MeshRecordComponent(
 
 void MeshRecordComponent::read()
 {
+    readBase();
     internal::ScientificDefaults<MeshRecordComponent>::readDefaults(
         IOHandler()->m_standard);
-
-    readBase();
 }
 
 void MeshRecordComponent::flush(

src/backend/ScientificDefaults.cpp

@@ -569,7 +569,7 @@ void ScientificDefaults<Child>::addParentDefaults(OpenpmdStandard standard)
     // Cannot directly call read_impl as it is private
     if constexpr (write)
     {
-        asChild().ScientificDefaults<Parent>::addDefaults(standard);
+        asChild().ScientificDefaults<Parent>::writeDefaults(standard);
     }
     else
     {
@@ -578,9 +578,10 @@ void ScientificDefaults<Child>::addParentDefaults(OpenpmdStandard standard)
 }
 
 template <typename Child>
-void ScientificDefaults<Child>::addDefaultsRecursively(OpenpmdStandard standard)
+void ScientificDefaults<Child>::writeDefaultsRecursively(
+    OpenpmdStandard standard)
 {
-    addDefaults(standard);
+    writeDefaults(standard);
     if constexpr (IsContainer_v<Child>)
     {
         using Container_t = AsContainer_t<Child>;
@@ -602,12 +603,12 @@ void ScientificDefaults<Child>::addDefaultsRecursively(OpenpmdStandard standard)
         for (auto &[_, right] : asChild().meshes)
         {
             (void)_;
-            right.ScientificDefaults<Mesh>::addDefaultsRecursively(standard);
+            right.ScientificDefaults<Mesh>::writeDefaultsRecursively(standard);
         }
         for (auto &[_, right] : asChild().particles)
         {
             (void)_;
-            right.ScientificDefaults<ParticleSpecies>::addDefaultsRecursively(
+            right.ScientificDefaults<ParticleSpecies>::writeDefaultsRecursively(
                 standard);
         }
     }
@@ -616,7 +617,7 @@ void ScientificDefaults<Child>::addDefaultsRecursively(OpenpmdStandard standard)
         for (auto &[_, right] : asChild().particlePatches)
         {
             (void)_;
-            right.ScientificDefaults<PatchRecord>::addDefaultsRecursively(
+            right.ScientificDefaults<PatchRecord>::writeDefaultsRecursively(
                 standard);
         }
     }
@@ -803,7 +804,7 @@ void ScientificDefaults<Child>::defaults_impl(OpenpmdStandard standard)
 }
 
 template <typename Child>
-void ScientificDefaults<Child>::addDefaults(OpenpmdStandard standard)
+void ScientificDefaults<Child>::writeDefaults(OpenpmdStandard standard)
 {
     defaults_impl</* write = */ true>(standard);
 }