Cleanup, documentation

franzpoeschel · franzpoeschel · commit 1d6430242b65 · 2026-03-12T14:45:51.000+01:00
diff --git a/include/openPMD/Iteration.hpp b/include/openPMD/Iteration.hpp
@@ -466,7 +466,7 @@ class Iteration
     void runDeferredParseAccess();
 
 protected:
-    void defaults_impl(bool write, OpenpmdStandard) override;
+    void scientificDefaults_impl(bool write, OpenpmdStandard) override;
 }; // Iteration
 
 namespace traits
diff --git a/include/openPMD/Mesh.hpp b/include/openPMD/Mesh.hpp
@@ -334,14 +334,9 @@ class Mesh : public BaseRecord<MeshRecordComponent>
     auto retrieveDimensionality() const -> uint64_t;
 
 protected:
-    void defaults_impl(bool write, OpenpmdStandard) override;
+    void scientificDefaults_impl(bool write, OpenpmdStandard) override;
 }; // Mesh
 
-static_assert(internal::IsContainer_v<Mesh>);
-static_assert(std::is_same_v<
-              Container<MeshRecordComponent>,
-              internal::AsContainer_t<Mesh>>);
-
 template <typename T>
 inline std::vector<T> Mesh::gridSpacing() const
 {
diff --git a/include/openPMD/ParticleSpecies.hpp b/include/openPMD/ParticleSpecies.hpp
@@ -66,7 +66,7 @@ class ParticleSpecies
     }
 
 protected:
-    void defaults_impl(bool write, OpenpmdStandard) override;
+    void scientificDefaults_impl(bool write, OpenpmdStandard) override;
 };
 
 namespace traits
diff --git a/include/openPMD/Record.hpp b/include/openPMD/Record.hpp
@@ -59,11 +59,9 @@ class Record : public BaseRecord<RecordComponent>
     [[nodiscard]] internal::HomogenizeExtents read();
 
 protected:
-    void defaults_impl(bool write, OpenpmdStandard) override;
+    void scientificDefaults_impl(bool write, OpenpmdStandard) override;
 }; // Record
 
-static_assert(internal::HasScientificDefaults_v<Record>);
-
 template <typename T>
 inline T Record::timeOffset() const
 {
diff --git a/include/openPMD/RecordComponent.hpp b/include/openPMD/RecordComponent.hpp
@@ -552,7 +552,7 @@ OPENPMD_protected
     void verifyChunk(Datatype, Offset const &, Extent const &) const;
 
 protected:
-    void defaults_impl(bool write, OpenpmdStandard) override;
+    void scientificDefaults_impl(bool write, OpenpmdStandard) override;
 }; // RecordComponent
 
 namespace internal
diff --git a/include/openPMD/backend/BaseRecord.hpp b/include/openPMD/backend/BaseRecord.hpp
@@ -384,7 +384,7 @@ class BaseRecord
     void eraseScalar();
 
 protected:
-    void defaults_impl(bool write, OpenpmdStandard) override;
+    void scientificDefaults_impl(bool write, OpenpmdStandard) override;
 }; // BaseRecord
 
 namespace detail
diff --git a/include/openPMD/backend/Container.hpp b/include/openPMD/backend/Container.hpp
@@ -354,13 +354,5 @@ namespace internal
 
         ~EraseStaleEntries();
     };
-
-    template <typename T>
-    constexpr bool IsContainer_v = auxiliary::IsTemplateBaseOf_v<Container, T>;
-    template <typename T>
-    using AsContainer_t = auxiliary::AsTemplateBase_t<Container, T>;
-
-    static_assert(!IsContainer_v<int>);
-    static_assert(IsContainer_v<Container<Attributable>>);
 } // namespace internal
 } // namespace openPMD
diff --git a/include/openPMD/backend/MeshRecordComponent.hpp b/include/openPMD/backend/MeshRecordComponent.hpp
@@ -101,7 +101,7 @@ class MeshRecordComponent : public RecordComponent
     }
 
 protected:
-    void defaults_impl(bool write, OpenpmdStandard) override;
+    void scientificDefaults_impl(bool write, OpenpmdStandard) override;
 };
 
 template <typename T>
diff --git a/include/openPMD/backend/PatchRecordComponent.hpp b/include/openPMD/backend/PatchRecordComponent.hpp
@@ -113,7 +113,7 @@ OPENPMD_protected
     PatchRecordComponent(NoInit);
 
 protected:
-    void defaults_impl(bool write, OpenpmdStandard) override;
+    void scientificDefaults_impl(bool write, OpenpmdStandard) override;
 }; // PatchRecordComponent
 
 template <typename T>
diff --git a/include/openPMD/backend/scientific_defaults/ConfigAttribute.hpp b/include/openPMD/backend/scientific_defaults/ConfigAttribute.hpp
@@ -28,6 +28,8 @@ struct ConfigAttribute
     ConfigAttribute &operator=(ConfigAttribute const &) = delete;
     ConfigAttribute &operator=(ConfigAttribute &&) = delete;
 
+    // Specify a custom function for setting the default attribute,
+    // instead of just using setAttribute().
     template <typename RecordType, typename S = void, typename GetDefaultValue>
     [[nodiscard]] auto withSetter(
         GetDefaultValue &&getDefaultVal,
@@ -38,10 +40,12 @@ struct ConfigAttribute
                 auxiliary::CallResult_t<GetDefaultValue>,
                 S>> setDefaultVal) -> ConfigAttribute &;
 
+    // Generically use setAttribute() for initializing
     template <typename DefaultValue>
     [[nodiscard]] auto withGenericSetter(DefaultValue &&defaultVal)
         -> ConfigAttribute &;
 
+    // Add readers for attribute parsing
     [[nodiscard]] auto withReader(
         std::deque<Datatype> eligibleDatatypes,
         std::optional<std::shared_ptr<ProcessParsedAttribute>>
diff --git a/include/openPMD/backend/scientific_defaults/ProcessParsedAttribute.hpp b/include/openPMD/backend/scientific_defaults/ProcessParsedAttribute.hpp
@@ -1,14 +1,18 @@
 #pragma once
 
 #include "openPMD/Error.hpp"
-#include "openPMD/Mesh.hpp"
 #include "openPMD/backend/Attributable.hpp"
 #include "openPMD/backend/Attribute.hpp"
 
 #include <optional>
 #include <string>
 #include <type_traits>
 
+namespace openPMD
+{
+class Mesh;
+}
+
 namespace openPMD::internal
 {
 /*
diff --git a/include/openPMD/backend/scientific_defaults/ScientificDefaults.hpp b/include/openPMD/backend/scientific_defaults/ScientificDefaults.hpp
@@ -1,13 +1,10 @@
 #pragma once
 
-#include "openPMD/IO/AbstractIOHandler.hpp"
-
-#include <type_traits>
+#include "openPMD/backend/Attributable.hpp"
+#include "openPMD/backend/scientific_defaults/ConfigAttribute.hpp"
 
 namespace openPMD::internal
 {
-struct ConfigAttribute;
-
 /*
  * This is the interface for implementing required scientific attributes defined
  * by the openPMD standard (writing and reading). The interface is inherited by
@@ -31,8 +28,9 @@ class ScientificDefaults
     //
     // Used both by writeDefaults() and readDefaults().
     //
-    // Use helpers from ConfigAttribute.hpp for writing implementations.
-    virtual void defaults_impl(bool write, OpenpmdStandard) = 0;
+    // Use defaultAttribute() for creating an attribute, use helpers inside
+    // ConfigAttribute for defining it.
+    virtual void scientificDefaults_impl(bool write, OpenpmdStandard) = 0;
 
     // Called upon Iteration::close(), will fill in defaults below Iteration
     // level. If the Iteration is not explicitly closed, will be called upon
@@ -43,8 +41,4 @@ class ScientificDefaults
     // Called at appropriate places during parsing.
     void readDefaults(OpenpmdStandard);
 };
-
-template <typename Child>
-constexpr bool HasScientificDefaults_v =
-    std::is_base_of_v<ScientificDefaults, Child>;
 } // namespace openPMD::internal
diff --git a/src/Iteration.cpp b/src/Iteration.cpp
@@ -982,7 +982,7 @@ void Iteration::runDeferredParseAccess()
     }
 }
 
-void Iteration::defaults_impl(bool write, OpenpmdStandard)
+void Iteration::scientificDefaults_impl(bool write, OpenpmdStandard)
 {
     using namespace internal;
     auto float_types = get_float_types();
diff --git a/src/Mesh.cpp b/src/Mesh.cpp
@@ -215,7 +215,7 @@ auto Mesh::retrieveDimensionality() const -> uint64_t
     return 1;
 }
 
-void Mesh::defaults_impl(bool write, OpenpmdStandard standard)
+void Mesh::scientificDefaults_impl(bool write, OpenpmdStandard standard)
 {
     using namespace internal;
     auto float_types = get_float_types();
@@ -279,7 +279,7 @@ void Mesh::defaults_impl(bool write, OpenpmdStandard standard)
             .withReader(float_types, require_type<std::vector<double>>())(wor);
     }
 
-    BaseRecord<MeshRecordComponent>::defaults_impl(write, standard);
+    BaseRecord<MeshRecordComponent>::scientificDefaults_impl(write, standard);
 }
 std::vector<double> Mesh::gridUnitSIPerDimension() const
 {
diff --git a/src/ParticleSpecies.cpp b/src/ParticleSpecies.cpp
@@ -194,7 +194,7 @@ void ParticleSpecies::flush(
         setDirty(false);
     }
 }
-void ParticleSpecies::defaults_impl(bool /* write */, OpenpmdStandard)
+void ParticleSpecies::scientificDefaults_impl(bool /* write */, OpenpmdStandard)
 {
     // no-op
 }
diff --git a/src/Record.cpp b/src/Record.cpp
@@ -199,7 +199,7 @@ auto Record::read() -> internal::HomogenizeExtents
     return res;
 }
 
-void Record::defaults_impl(bool write, OpenpmdStandard standard)
+void Record::scientificDefaults_impl(bool write, OpenpmdStandard standard)
 {
     using namespace internal;
     auto float_types = get_float_types();
@@ -224,7 +224,7 @@ void Record::defaults_impl(bool write, OpenpmdStandard standard)
         .template withSetter<Record>(0.f, &Record::setTimeOffset)
         .withReader(float_types, require_scalar)(wor);
 
-    BaseRecord<RecordComponent>::defaults_impl(write, standard);
+    BaseRecord<RecordComponent>::scientificDefaults_impl(write, standard);
 }
 template class BaseRecord<RecordComponent>;
 } // namespace openPMD
diff --git a/src/RecordComponent.cpp b/src/RecordComponent.cpp
@@ -693,7 +693,7 @@ void RecordComponent::verifyChunk(
     }
 }
 
-void RecordComponent::defaults_impl(bool write, OpenpmdStandard)
+void RecordComponent::scientificDefaults_impl(bool write, OpenpmdStandard)
 {
     using namespace internal;
     auto float_types = get_float_types();
diff --git a/src/backend/BaseRecord.cpp b/src/backend/BaseRecord.cpp
@@ -817,7 +817,7 @@ void BaseRecord<T_elem>::eraseScalar()
 }
 
 template <typename T_elem>
-void BaseRecord<T_elem>::defaults_impl(bool write, OpenpmdStandard)
+void BaseRecord<T_elem>::scientificDefaults_impl(bool write, OpenpmdStandard)
 {
     using namespace internal;
     auto float_types = get_float_types();
diff --git a/src/backend/MeshRecordComponent.cpp b/src/backend/MeshRecordComponent.cpp
@@ -66,7 +66,8 @@ MeshRecordComponent &MeshRecordComponent::setPosition(std::vector<T> pos)
     return *this;
 }
 
-void MeshRecordComponent::defaults_impl(bool write, OpenpmdStandard standard)
+void MeshRecordComponent::scientificDefaults_impl(
+    bool write, OpenpmdStandard standard)
 {
     using namespace internal;
     auto float_types = get_float_types();
@@ -82,7 +83,7 @@ void MeshRecordComponent::defaults_impl(bool write, OpenpmdStandard standard)
             &MeshRecordComponent::setPosition)
         .withReader(float_types, require_vector)(wor);
 
-    RecordComponent::defaults_impl(write, standard);
+    RecordComponent::scientificDefaults_impl(write, standard);
 }
 template MeshRecordComponent &
 MeshRecordComponent::setPosition(std::vector<float> pos);
diff --git a/src/backend/PatchRecordComponent.cpp b/src/backend/PatchRecordComponent.cpp
@@ -75,7 +75,7 @@ PatchRecordComponent::PatchRecordComponent() : RecordComponent(NoInit())
 PatchRecordComponent::PatchRecordComponent(NoInit) : RecordComponent(NoInit())
 {}
 
-void PatchRecordComponent::defaults_impl(bool write, OpenpmdStandard)
+void PatchRecordComponent::scientificDefaults_impl(bool write, OpenpmdStandard)
 {
     using namespace internal;
     auto const wor = write ? WriteOrRead::Write : WriteOrRead::Read;
diff --git a/src/backend/scientific_defaults/ScientificDefaults.cpp b/src/backend/scientific_defaults/ScientificDefaults.cpp
@@ -16,11 +16,11 @@ ScientificDefaults::defaultAttribute(Attributable &attr, char const *attrName)
 
 void ScientificDefaults::writeDefaults(OpenpmdStandard standard)
 {
-    defaults_impl(/* write = */ true, standard);
+    scientificDefaults_impl(/* write = */ true, standard);
 }
 
 void ScientificDefaults::readDefaults(OpenpmdStandard standard)
 {
-    defaults_impl(/* write = */ false, standard);
+    scientificDefaults_impl(/* write = */ false, standard);
 }
 } // namespace openPMD::internal

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ class ParticleSpecies`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`protected:`
`69`		`- void defaults_impl(bool write, OpenpmdStandard) override;`
	`69`	`+ void scientificDefaults_impl(bool write, OpenpmdStandard) override;`
`70`	`70`	`};`
`71`	`71`
`72`	`72`	`namespace traits`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ class MeshRecordComponent : public RecordComponent`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`protected:`
`104`		`- void defaults_impl(bool write, OpenpmdStandard) override;`
	`104`	`+ void scientificDefaults_impl(bool write, OpenpmdStandard) override;`
`105`	`105`	`};`
`106`	`106`
`107`	`107`	`template <typename T>`