Write defaults upon flush, thats good enough actually

Author: franzpoeschel

include/openPMD/backend/Attributable.hpp

@@ -428,6 +428,10 @@ OPENPMD_protected
 
     void flushAttributes(internal::FlushParams const &);
 
+    void populateDefaults(
+        internal::ScientificDefaults *self,
+        internal::FlushParams const &params);
+
     enum ReadMode
     {
         /**

include/openPMD/backend/BaseRecord.hpp

@@ -180,7 +180,7 @@ template <typename T_elem>
 class BaseRecord
     : public Container<T_elem>
     , public T_elem // T_RecordComponent
-// ScientificDefaults already inherited via Container
+// ScientificDefaults already inherited via RecordComponent
 // , internal::ScientificDefaults
 {
 public:

include/openPMD/backend/scientific_defaults/ScientificDefaults.hpp

@@ -3,6 +3,11 @@
 #include "openPMD/backend/Attributable.hpp"
 #include "openPMD/backend/scientific_defaults/ConfigAttribute.hpp"
 
+namespace openPMD
+{
+class Attributable;
+}
+
 namespace openPMD::internal
 {
 /*
@@ -15,6 +20,8 @@ namespace openPMD::internal
  */
 class ScientificDefaults
 {
+    friend class ::openPMD::Attributable;
+
 protected:
     [[nodiscard]] auto defaultAttribute(Attributable &, char const *attrName)
         -> ConfigAttribute;

src/Iteration.cpp

@@ -125,10 +125,10 @@ Iteration &Iteration::close(bool _flush)
         break;
     }
 
-    if (access::write(IOHandler()->m_frontendAccess))
-    {
-        populateDefaultMetadata();
-    }
+    // if (access::write(IOHandler()->m_frontendAccess))
+    // {
+    //     populateDefaultMetadata();
+    // }
 
     if (_flush)
     {
@@ -459,6 +459,7 @@ void Iteration::flush(internal::FlushParams const &flushParams)
             particles.setDirty(false);
         }
 
+        populateDefaults(this, flushParams);
         flushAttributes(flushParams);
     }
     if (flushParams.flushLevel != FlushLevel::SkeletonOnly)

src/ParticleSpecies.cpp

@@ -176,6 +176,7 @@ void ParticleSpecies::flush(
     }
     else
     {
+        populateDefaults(this, flushParams);
         Container<Record>::flush(path, flushParams);
 
         for (auto &record : *this)

src/RecordComponent.cpp

@@ -516,6 +516,7 @@ void RecordComponent::flush(
             rc.m_chunks.pop();
         }
 
+        populateDefaults(this, flushParams);
         flushAttributes(flushParams);
     }
     if (flushParams.flushLevel != FlushLevel::SkeletonOnly)

src/backend/Attributable.cpp

@@ -340,6 +340,16 @@ void Attributable::flushAttributes(internal::FlushParams const &flushParams)
     }
 }
 
+void Attributable::populateDefaults(
+    internal::ScientificDefaults *self, internal::FlushParams const &params)
+{
+    if (params.flushLevel != FlushLevel::UserFlush)
+    {
+        return;
+    }
+    self->writeDefaults(IOHandler()->m_standard);
+}
+
 void Attributable::readAttributes(ReadMode mode)
 {
     auto &attri = get();

src/backend/BaseRecord.cpp

@@ -792,6 +792,10 @@ inline void BaseRecord<T_elem>::flush(
             "one or more regular components.");
     }
 
+    if (access::write(this->IOHandler()->m_backendAccess))
+    {
+        this->populateDefaults(this, flushParams);
+    }
     this->flush_impl(name, flushParams);
     if (flushParams.flushLevel != FlushLevel::SkeletonOnly)
     {

test/python/unittest/API/APITest.py

@@ -2383,7 +2383,6 @@ def get_component_only():
             mesh.axis_labels = ["x", "y"]
             component.reset_dataset(io.Dataset(np.dtype("float"), [10, 10]))
 
-            iteration.populate_default_metadata()
             del iteration
             del mesh
             del series
@@ -2431,7 +2430,6 @@ def get_component_only():
             position.reset_dataset(
                 io.Dataset(np.dtype("float"), [num_particles]))
 
-            iteration.populate_default_metadata()
             del iteration
             del particles
             del series
@@ -2483,7 +2481,6 @@ def get_component_only():
             num_particles_comp.store(0, np.uint64(10))
             num_particles_comp.store(1, np.uint64(20))
 
-            iteration.populate_default_metadata()
             del iteration
             del particles
             del series