Program Listing for File t8_data_handler.hxx

↰ Return to documentation for file (src/t8_data/t8_data_handler.hxx)

/*
  This file is part of t8code.
  t8code is a C library to manage a collection (a forest) of multiple
  connected adaptive space-trees of general element classes in parallel.

  Copyright (C) 2025 the developers

  t8code is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  t8code is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with t8code; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/

#ifndef T8_DATA_HANDLER_HXX
#define T8_DATA_HANDLER_HXX

#include <t8.h>
#include <t8_types/t8_data_handler_type.hxx>

constexpr bool
is_internal_data (const t8_data_handler_type type)
{
  switch (type.get ()) {
  // Placeholder for future internal data, which is handled here.
  default:
    return false;
  }
};

template <typename TType>
struct t8_data_handler
{
 public:
  t8_data_handler () {};

  int
  size (const TType &data, sc_MPI_Comm comm);

  void
  pack (const TType &data, int &pos, void *buffer, const int num_bytes, sc_MPI_Comm comm);

  void
  unpack (const void *buffer, const int num_bytes, int &pos, TType &data, sc_MPI_Comm comm);

  t8_data_handler_type
  type ();

  ~t8_data_handler () {};
};

#endif /* T8_DATA_HANDLER_HXX */