DiscontiguousDataOperations.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2021.                                                        *
 * The Regents of the University of Michigan and DFT-EFE developers.          *
 *                                                                            *
 * This file is part of the DFT-EFE code.                                     *
 *                                                                            *
 * DFT-EFE is free software: you can redistribute it and/or modify            *
 *   it under the terms of the Lesser GNU General Public License as           *
 *   published by the Free Software Foundation, either version 3 of           *
 *   the License, or (at your option) any later version.                      *
 *                                                                            *
 * DFT-EFE is distributed in the hope that it will be useful, but             *
 *   WITHOUT ANY WARRANTY; without even the implied warranty                  *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
 *   See the Lesser GNU General Public License for more details.              *
 *                                                                            *
 * You should have received a copy of the GNU Lesser General Public           *
 *   License at the top level of DFT-EFE distribution.  If not, see           *
 *   <https://www.gnu.org/licenses/>.                                         *
 ******************************************************************************/
 
/*
 * @author Bikash Kanungo
 */
 
#ifndef dftefeDiscontiguousDataOperations_h
#define dftefeDiscontiguousDataOperations_h
 
#include <utils/MemorySpaceType.h>
#include <utils/MemoryStorage.h>
#include <utils/TypeConfig.h>
 
namespace dftefe
{
  namespace utils
  {
    template <typename ValueType, dftefe::utils::MemorySpace memorySpace>
    class DiscontiguousDataOperations
    {
    public:
      using SizeTypeVector = utils::MemoryStorage<size_type, memorySpace>;
 
      static void
      copyFromDiscontiguousMemory(const ValueType *src,
                                  ValueType *      dst,
                                  const size_type *discontIds,
                                  const size_type  N,
                                  const size_type  nComponents);
 
      static void
      copyToDiscontiguousMemory(const ValueType *src,
                                ValueType *      dst,
                                const size_type *discontIds,
                                const size_type  N,
                                const size_type  nComponents);
 
      static void
      addToDiscontiguousMemory(const ValueType *src,
                               ValueType *      dst,
                               const size_type *discontIds,
                               const size_type  N,
                               const size_type  nComponents);
    }; // end of class DiscontiguousDataOperations
 
 
// partial template specialization for DEVICE
#ifdef DFTEFE_WITH_DEVICE
    template <typename ValueType>
    class DiscontiguousDataOperations<ValueType, utils::MemorySpace::DEVICE>
    {
    public:
      using SizeTypeVector =
        utils::MemoryStorage<size_type, MemorySpace::DEVICE>;
 
      static void
      copyFromDiscontiguousMemory(const ValueType *src,
                                  ValueType *      dst,
                                  const size_type *discontIds,
                                  const size_type  N,
                                  const size_type  nComponents);
 
      static void
      copyToDiscontiguosMemory(const ValueType *src,
                               ValueType *      dst,
                               const size_type *discontIds,
                               const size_type  N,
                               const size_type  nComponents);
 
      static void
      addToDiscontiguosMemory(const ValueType *src,
                              ValueType *      dst,
                              const size_type *discontIds,
                              const size_type  N,
                              const size_type  nComponents);
    }; // end of class DiscontiguousDataOperations for DEVICE
#endif // DFTEFE_WITH_DEVICE
 
  } // end of namespace utils
} // namespace dftefe
#endif // dftefeDiscontiguousDataOperations_h