Short mode in default in openPMD >= 2.

openPMD · Nov 27, 2023 · 914aaaa · 914aaaa
1 parent 3a6dbe1
commit 914aaaa
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 5 deletions.
diff --git a/include/openPMD/IO/IOTask.hpp b/include/openPMD/IO/IOTask.hpp
@@ -142,6 +142,7 @@ struct OPENPMDAPI_EXPORT Parameter<Operation::CREATE_FILE>
 
     std::string name = "";
     IterationEncoding encoding = IterationEncoding::groupBased;
+    std::string openPMDversion;
 };
 
 template <>

diff --git a/include/openPMD/RecordComponent.tpp b/include/openPMD/RecordComponent.tpp
@@ -21,6 +21,8 @@
 
 #pragma once
 
+#include "openPMD/Datatype.hpp"
+#include "openPMD/Error.hpp"
 #include "openPMD/RecordComponent.hpp"
 #include "openPMD/Span.hpp"
 #include "openPMD/auxiliary/Memory.hpp"
@@ -29,6 +31,7 @@
 #include "openPMD/auxiliary/UniquePtr.hpp"
 
 #include <memory>
+#include <type_traits>
 
 namespace openPMD
 {
@@ -92,12 +95,38 @@ inline std::shared_ptr<T> RecordComponent::loadChunk(Offset o, Extent e)
 #endif
 }
 
+namespace detail
+{
+    template <typename To>
+    struct do_convert
+    {
+        template <typename From>
+        static std::optional<To> call(Attribute &attr)
+        {
+            if constexpr (std::is_convertible_v<From, To>)
+            {
+                return std::make_optional<To>(attr.get<From>());
+            }
+            else
+            {
+                return std::nullopt;
+            }
+        }
+
+        static constexpr char const *errorMsg = "is_conversible";
+    };
+} // namespace detail
+
 template <typename T>
 inline void
 RecordComponent::loadChunk(std::shared_ptr<T> data, Offset o, Extent e)
 {
     Datatype dtype = determineDatatype(data);
-    if (dtype != getDatatype())
+    /*
+     * For constant components, we implement type conversion, so there is
+     * a separate check further below.
+     */
+    if (dtype != getDatatype() && !constant())
         if (!isSameInteger<T>(getDatatype()) &&
             !isSameFloatingPoint<T>(getDatatype()) &&
             !isSameComplexFloatingPoint<T>(getDatatype()) &&
@@ -159,10 +188,25 @@ RecordComponent::loadChunk(std::shared_ptr<T> data, Offset o, Extent e)
         for (auto const &dimensionSize : extent)
             numPoints *= dimensionSize;
 
-        T value = rc.m_constantValue.get<T>();
+        std::optional<T> val =
+            switchNonVectorType<detail::do_convert</* To = */ T>>(
+                /* from = */ getDatatype(), rc.m_constantValue);
 
-        T *raw_ptr = data.get();
-        std::fill(raw_ptr, raw_ptr + numPoints, value);
+        if (val.has_value())
+        {
+            T *raw_ptr = data.get();
+            std::fill(raw_ptr, raw_ptr + numPoints, *val);
+        }
+        else
+        {
+            std::string const data_type_str = datatypeToString(getDatatype());
+            std::string const requ_type_str =
+                datatypeToString(determineDatatype<T>());
+            std::string err_msg =
+                "Type conversion during chunk loading not possible! ";
+            err_msg += "Data: " + data_type_str + "; Load as: " + requ_type_str;
+            throw error::WrongAPIUsage(err_msg);
+        }
     }
     else
     {
@@ -250,7 +294,7 @@ void RecordComponent::storeChunkRaw(T *ptr, Offset offset, Extent extent)
 
 template <typename T_ContiguousContainer>
 inline typename std::enable_if_t<
-    auxiliary::IsContiguousContainer_v<T_ContiguousContainer> >
+    auxiliary::IsContiguousContainer_v<T_ContiguousContainer>>
 RecordComponent::storeChunk(T_ContiguousContainer &data, Offset o, Extent e)
 {
     uint8_t dim = getDimensionality();

diff --git a/src/IO/JSON/JSONIOHandlerImpl.cpp b/src/IO/JSON/JSONIOHandlerImpl.cpp
@@ -455,6 +455,13 @@ void JSONIOHandlerImpl::createFile(
         access::write(m_handler->m_backendAccess),
         "[JSON] Creating a file in read-only mode is not possible.");
 
+    if (m_attributeModeSpecificationVia == SpecificationVia::DefaultValue)
+    {
+        m_attributeMode = parameters.openPMDversion >= "2."
+            ? AttributeMode::Short
+            : AttributeMode::Long;
+    }
+
     if (!writable->written)
     {
         std::string name = parameters.name + m_originalExtension;

diff --git a/src/Iteration.cpp b/src/Iteration.cpp
@@ -206,6 +206,7 @@ void Iteration::flushFileBased(
         /* create file */
         Parameter<Operation::CREATE_FILE> fCreate;
         fCreate.name = filename;
+        fCreate.openPMDversion = s.openPMD();
         IOHandler()->enqueue(IOTask(&s.writable(), fCreate));
 
         /* create basePath */

diff --git a/src/Series.cpp b/src/Series.cpp
@@ -926,6 +926,7 @@ void Series::flushGorVBased(
             Parameter<Operation::CREATE_FILE> fCreate;
             fCreate.name = series.m_name;
             fCreate.encoding = iterationEncoding();
+            fCreate.openPMDversion = openPMD();
             IOHandler()->enqueue(IOTask(this, fCreate));
         }