AuxDensityMatrix.h

Go to the documentation of this file.

//
// Created by Arghadwip Paul.
//
 
#ifndef DFTFE_AUXDM_AUXDENSITYMATRIX_H
#define DFTFE_AUXDM_AUXDENSITYMATRIX_H
 
#include <vector>
#include <utility>
#include <map>
#include <string>
#include <unordered_map>
#include <mpi.h>
#include <dftUtils.h>
 
namespace dftfe
{
  enum class DensityDescriptorDataAttributes
  {
    valuesTotal,
    valuesSpinUp,
    valuesSpinDown,
    gradValuesSpinUp,
    gradValuesSpinDown,
    hessianSpinUp,
    hessianSpinDown,
    laplacianSpinUp,
    laplacianSpinDown
  };
 
  enum class WfcDescriptorDataAttributes
  {
    tauTotal,
    tauSpinUp,
    tauSpinDown
  };
 
  template <dftfe::utils::MemorySpace memorySpace>
  class AuxDensityMatrix
  {
  public:
    /**
     * @brief compute local descriptors of the aux basis electron-density
     * representation at the supplied range of Quadrature index range
     */
    virtual void
    applyLocalOperations(
      const std::pair<dftfe::uInt, dftfe::uInt> &quadIndexRange,
      std::unordered_map<
        DensityDescriptorDataAttributes,
        dftfe::utils::MemoryStorage<double, dftfe::utils::MemorySpace::HOST>>
        &densityData) = 0;
 
 
 
    virtual void
    applyLocalOperations(
      const std::pair<dftfe::uInt, dftfe::uInt> &quadIndexRange,
      std::unordered_map<
        WfcDescriptorDataAttributes,
        dftfe::utils::MemoryStorage<double, dftfe::utils::MemorySpace::HOST>>
        &wfcData) = 0;
 
    /**
     * @brief Compute aux basis overlap matrix batchwise contribution from
     * supplied set of quadrature points and their associated weights
     */
    virtual void
    evalOverlapMatrixStart(
      const dftfe::utils::MemoryStorage<double, dftfe::utils::MemorySpace::HOST>
        &quadpts,
      const dftfe::utils::MemoryStorage<double, dftfe::utils::MemorySpace::HOST>
        &quadWt) = 0;
 
    /**
     * @brief for MPI accumulation
     */
    virtual void
    evalOverlapMatrixEnd(const MPI_Comm &mpiComm) = 0;
 
    // FIXME: to be extended to memoryspace
    /**
     * @brief Projects the KS density matrix to aux basis (L2 projection) batch wise
     */
    virtual void
    projectDensityMatrixStart(
      const std::unordered_map<std::string, std::vector<dataTypes::number>>
        &projectionInputsDataType,
      const std::unordered_map<
        std::string,
        dftfe::utils::MemoryStorage<double, dftfe::utils::MemorySpace::HOST>>
                      &projectionInputsReal,
      const dftfe::Int iSpin) = 0;
 
    /**
     * @brief for MPI accumulation
     */
    virtual void
    projectDensityMatrixEnd(const MPI_Comm &mpiComm) = 0;
 
 
    /**
     * @brief Projects the quadrature density to aux basis (L2 projection) batch wise
     */
    virtual void
    projectDensityStart(
      const std::unordered_map<
        std::string,
        dftfe::utils::MemoryStorage<double, dftfe::utils::MemorySpace::HOST>>
        &projectionInputs) = 0;
 
    /**
     * @brief for MPI accumulation
     */
    virtual void
    projectDensityEnd(const MPI_Comm &mpiComm) = 0;
  };
} // namespace dftfe
 
#endif // DFTFE_AUXDM_AUXDENSITYMATRIX_H