FEBasisManager.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, Avirup Sircar
 */
 
#ifndef dftefeFEBasisManager_h
#define dftefeFEBasisManager_h
 
#include <basis/BasisManager.h>
#include <basis/FEBasisDofHandler.h>
namespace dftefe
{
  namespace basis
  {
    template <typename ValueTypeBasisCoeff,
              typename ValueTypeBasisData,
              dftefe::utils::MemorySpace memorySpace,
              size_type                  dim>
    class FEBasisManager : public BasisManager<ValueTypeBasisCoeff, memorySpace>
    {
      //
      // typedefs
      //
    public:
      using SizeTypeVector =
        typename BasisManager<ValueTypeBasisCoeff, memorySpace>::SizeTypeVector;
      using GlobalSizeTypeVector =
        typename BasisManager<ValueTypeBasisCoeff,
                              memorySpace>::GlobalSizeTypeVector;
      using LocalIndexIter       = typename SizeTypeVector::iterator;
      using const_LocalIndexIter = typename SizeTypeVector::const_iterator;
      using GlobalIndexIter      = typename GlobalSizeTypeVector::iterator;
      using const_GlobalIndexIter =
        typename GlobalSizeTypeVector::const_iterator;
 
    public:
      FEBasisManager(std::shared_ptr<const BasisDofHandler> basisDofHandler,
                     std::shared_ptr<const utils::ScalarSpatialFunctionReal>
                       dirichletBoundaryCondition = nullptr);
 
      void
      reinit(std::shared_ptr<const BasisDofHandler> basisDofHandler,
             std::shared_ptr<const utils::ScalarSpatialFunctionReal>
               dirichletBoundaryCondition);
 
      ~FEBasisManager() = default;
 
      const BasisDofHandler &
      getBasisDofHandler() const override;
 
      const ConstraintsLocal<ValueTypeBasisCoeff, memorySpace> &
      getConstraints() const override;
 
      std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
      getMPIPatternP2P() const override;
 
      std::vector<std::pair<global_size_type, global_size_type>>
      getLocallyOwnedRanges() const override;
 
      const GlobalSizeTypeVector &
      getGhostIndices() const override;
 
      size_type
      nLocal() const override;
 
      size_type
      nLocallyOwned() const override;
 
      size_type
      nGhost() const override;
 
      std::pair<bool, size_type>
      inLocallyOwnedRanges(const global_size_type globalId) const override;
 
      std::pair<bool, size_type>
      isGhostEntry(const global_size_type ghostId) const override;
 
      size_type
      globalToLocalIndex(const global_size_type globalId) const override;
 
      global_size_type
      localToGlobalIndex(const size_type localId) const override;
 
      void
      getBasisCenters(const size_type       localId,
                      dftefe::utils::Point &basisCenter) const override;
 
      //
      // FE specific functions
      //
 
      size_type
      nLocallyOwnedCells() const;
 
      size_type
      nLocallyOwnedCellDofs(const size_type cellId) const;
 
      size_type
      nCumulativeLocallyOwnedCellDofs() const;
 
      const_GlobalIndexIter
      locallyOwnedCellGlobalDofIdsBegin() const;
 
      const_GlobalIndexIter
      locallyOwnedCellGlobalDofIdsBegin(const size_type cellId) const;
 
      const_GlobalIndexIter
      locallyOwnedCellGlobalDofIdsEnd(const size_type cellId) const;
 
      const_LocalIndexIter
      locallyOwnedCellLocalDofIdsBegin() const;
 
      const_LocalIndexIter
      locallyOwnedCellLocalDofIdsBegin(const size_type cellId) const;
 
      const_LocalIndexIter
      locallyOwnedCellLocalDofIdsEnd(const size_type cellId) const;
 
      void
      getCellDofsLocalIds(const size_type         cellId,
                          std::vector<size_type> &vecLocalNodeId) const;
 
    private:
      std::shared_ptr<
        const FEBasisDofHandler<ValueTypeBasisCoeff, memorySpace, dim>>
        d_feBDH;
      std::shared_ptr<const ConstraintsLocal<ValueTypeBasisCoeff, memorySpace>>
        d_constraintsLocal;
      std::vector<std::pair<global_size_type, global_size_type>>
                             d_locallyOwnedRanges;
      std::vector<size_type> d_locallyOwnedCellStartIds;
      GlobalSizeTypeVector   d_locallyOwnedCellGlobalIndices;
      std::vector<size_type> d_numLocallyOwnedCellDofs;
 
      // constraints dependent data
      std::shared_ptr<GlobalSizeTypeVector> d_ghostIndices;
      std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
                                               d_mpiPatternP2P;
      std::shared_ptr<SizeTypeVector>          d_locallyOwnedCellLocalIndices;
      std::map<global_size_type, utils::Point> d_supportPoints;
    };
 
  } // end of namespace basis
} // end of namespace dftefe
#include <basis/FEBasisManager.t.cpp>
#endif // dftefeFEBasisManager_h