MatrixFreeWrapper.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (c) 2017-2022  The Regents of the University of Michigan and DFT-FE
// authors.
//
// This file is part of the DFT-FE code.
//
// The DFT-FE code is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the DFT-FE distribution.
//
// ---------------------------------------------------------------------
//
 
#ifndef MatrixFreeWrapper_H_
#define MatrixFreeWrapper_H_
#include <variant>
#include <memory>
#include "MatrixFree.h"
 
namespace dftefe
{
  using MatrixFreeObject = std::variant<
#define MatrixFreeWrapperTemplates(NDOFSPERDIM)                            \
  std::shared_ptr<dftefe::MatrixFree<double,                               \
                                     dftefe::operatorList::Laplace,        \
                                     dftefe::utils::MemorySpace::DEVICE,   \
                                     false,                                \
                                     NDOFSPERDIM,                          \
                                     NDOFSPERDIM,                          \
                                     1,                                    \
                                     1>>,                                  \
    std::shared_ptr<dftefe::MatrixFree<double,                             \
                                       dftefe::operatorList::Helmholtz,    \
                                       dftefe::utils::MemorySpace::DEVICE, \
                                       false,                              \
                                       NDOFSPERDIM,                        \
                                       NDOFSPERDIM,                        \
                                       1,                                  \
                                       1>>,
#define MatrixFreeWrapperTemplatesL(NDOFSPERDIM)                           \
  std::shared_ptr<dftefe::MatrixFree<double,                               \
                                     dftefe::operatorList::Laplace,        \
                                     dftefe::utils::MemorySpace::DEVICE,   \
                                     false,                                \
                                     NDOFSPERDIM,                          \
                                     NDOFSPERDIM,                          \
                                     1,                                    \
                                     1>>,                                  \
    std::shared_ptr<dftefe::MatrixFree<double,                             \
                                       dftefe::operatorList::Helmholtz,    \
                                       dftefe::utils::MemorySpace::DEVICE, \
                                       false,                              \
                                       NDOFSPERDIM,                        \
                                       NDOFSPERDIM,                        \
                                       1,                                  \
                                       1>>
#include "MatrixFreeWrapper.def"
#undef MatrixFreeWrapperTemplates
#undef MatrixFreeWrapperTemplatesL
    >;
 
  template <typename T,
            dftefe::operatorList       operatorID,
            dftefe::utils::MemorySpace memorySpace,
            bool                       isComplex,
            class... Args>
  inline MatrixFreeObject
  createMatrixFreeObject(std::uint32_t nDofsPerDim, Args &&...args)
  {
    switch (nDofsPerDim)
      {
#define MatrixFreeWrapperTemplates(NDOFSPERDIM)        \
  case NDOFSPERDIM:                                    \
    return MatrixFreeObject(                           \
      std::make_shared<dftefe::MatrixFree<T,           \
                                          operatorID,  \
                                          memorySpace, \
                                          isComplex,   \
                                          NDOFSPERDIM, \
                                          NDOFSPERDIM, \
                                          1,           \
                                          1>>(std::forward<Args>(args)...));
#define MatrixFreeWrapperTemplatesL(NDOFSPERDIM)       \
  case NDOFSPERDIM:                                    \
    return MatrixFreeObject(                           \
      std::make_shared<dftefe::MatrixFree<T,           \
                                          operatorID,  \
                                          memorySpace, \
                                          isComplex,   \
                                          NDOFSPERDIM, \
                                          NDOFSPERDIM, \
                                          1,           \
                                          1>>(std::forward<Args>(args)...));
#include "MatrixFreeWrapper.def"
#undef MatrixFreeWrapperTemplates
#undef MatrixFreeWrapperTemplatesL
        default:
          throw std::logic_error{"createMatrixFreeObject dispatch failed"};
      }
  }
 
  template <typename T,
            dftefe::operatorList       operatorID,
            dftefe::utils::MemorySpace memorySpace,
            bool                       isComplex>
  class MatrixFreeWrapperClass
  {
  public:
    MatrixFreeWrapperClass(
      std::uint32_t                            nDofsPerDim,
      const MPI_Comm &                         mpi_comm,
      const dealii::MatrixFree<3, double> *    matrixFreeDataPtr,
      const dealii::AffineConstraints<double> &constraintMatrix,
      const std::uint32_t                      dofHandlerID,
      const std::uint32_t                      quadratureID,
      const dftefe::uInt                       nVectors)
      : d_MatrixFreeObject(
          createMatrixFreeObject<T, operatorID, memorySpace, isComplex>(
            nDofsPerDim,
            mpi_comm,
            matrixFreeDataPtr,
            constraintMatrix,
            dofHandlerID,
            quadratureID,
            nVectors))
    {}
 
    inline void
    init()
    {
      std::visit([&](auto &t) { t->init(); }, d_MatrixFreeObject);
    }
 
    inline void
    initOperatorCoeffs(T coeffHelmholtz)
    {
      std::visit([&](auto &t) { t->initOperatorCoeffs(coeffHelmholtz); },
                 d_MatrixFreeObject);
    }
 
    inline void
    computeAX(T *dst, T *src)
    {
      std::visit([&](auto &t) { t->computeAX(dst, src); }, d_MatrixFreeObject);
    }
 
    inline void
    constraintsDistribute(T *src)
    {
      std::visit([&](auto &t) { t->constraintsDistribute(src); },
                 d_MatrixFreeObject);
    }
 
    inline void
    constraintsDistributeTranspose(T *dst, T *src)
    {
      std::visit([&](auto &t) { t->constraintsDistributeTranspose(dst, src); },
                 d_MatrixFreeObject);
    }
 
  private:
    MatrixFreeObject d_MatrixFreeObject;
  };
 
} // namespace dftefe
#endif // MatrixFreeWrapper_H_