Archive.h

Go to the documentation of this file.

//
// Class Archive
//   Class to (de-)serialize in MPI communication.
//
//   When data is exchanged between MPI ranks, it is stored in one dimensional
//   arrays. These have the type detail::Archive, which are wrappers around
//   one dimensional Kokkos views of type char. The data is then transferred using
//   MPI send/recv calls. Note that the archive type differs from other buffers in
//   that they have type char and thus contain raw bytes, unlike other typed buffers
//   such as detail::FieldBufferData used by HaloCells.
//
#ifndef IPPL_ARCHIVE_H
#define IPPL_ARCHIVE_H
 
#include "Types/IpplTypes.h"
#include "Types/ViewTypes.h"
 
#include "Types/Vector.h"
 
namespace ippl {
    namespace detail {
        template <class... Properties>
        class Archive {
        public:
            using buffer_type  = typename ViewType<char, 1, Properties...>::view_type;
            using pointer_type = typename buffer_type::pointer_type;
 
            Archive(size_type size = 0);
 
            template <typename T, class... ViewArgs>
            void serialize(const Kokkos::View<T*, ViewArgs...>& view, size_type nsends);
 
            template <typename T, unsigned Dim, class... ViewArgs>
            void serialize(const Kokkos::View<Vector<T, Dim>*, ViewArgs...>& view,
                           size_type nsends);
 
            template <typename T, class... ViewArgs>
            void deserialize(Kokkos::View<T*, ViewArgs...>& view, size_type nrecvs);
 
            template <typename T, unsigned Dim, class... ViewArgs>
            void deserialize(Kokkos::View<Vector<T, Dim>*, ViewArgs...>& view, size_type nrecvs);
 
            pointer_type getBuffer() { return buffer_m.data(); }
 
            size_type getSize() const { return writepos_m; }
 
            size_type getBufferSize() const { return buffer_m.size(); }
 
            void resizeBuffer(size_type size) { Kokkos::resize(buffer_m, size); }
 
            void reallocBuffer(size_type size) { Kokkos::realloc(buffer_m, size); }
 
            void resetWritePos() { writepos_m = 0; }
            void resetReadPos() { readpos_m = 0; }
 
            ~Archive() = default;
 
        private:
            size_type writepos_m;
            size_type readpos_m;
            buffer_type buffer_m;
        };
    }  // namespace detail
}  // namespace ippl
 
#include "Archive.hpp"
 
#endif