BasisManager.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 dftefeBasisManager_h
#define dftefeBasisManager_h
 
#include <basis/ConstraintsLocal.h>
#include <utils/Point.h>
#include <utils/ScalarSpatialFunction.h>
#include <utils/ScalarZeroFunctionReal.h>
#include <basis/BasisDofHandler.h>
#include "DealiiConversions.h"
#include <utils/TypeConfig.h>
#include <utils/MemoryStorage.h>
#include <utils/MPIPatternP2P.h>
#include <string>
namespace dftefe
{
  namespace basis
  {
    template <typename ValueTypeBasisCoeff,
              dftefe::utils::MemorySpace memorySpace>
    class BasisManager
    {
      //
      // typedefs
      //
    public:
      using SizeTypeVector = utils::MemoryStorage<size_type, memorySpace>;
      using GlobalSizeTypeVector =
        utils::MemoryStorage<global_size_type, memorySpace>;
      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:
      ~BasisManager() = default;
 
      virtual const BasisDofHandler &
      getBasisDofHandler() const = 0;
 
      virtual const ConstraintsLocal<ValueTypeBasisCoeff, memorySpace> &
      getConstraints() const = 0;
 
      virtual std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
      getMPIPatternP2P() const = 0;
 
      virtual std::vector<std::pair<global_size_type, global_size_type>>
      getLocallyOwnedRanges() const = 0;
 
      virtual const GlobalSizeTypeVector &
      getGhostIndices() const = 0;
 
      virtual size_type
      nLocal() const = 0;
 
      virtual size_type
      nLocallyOwned() const = 0;
 
      virtual size_type
      nGhost() const = 0;
 
      virtual std::pair<bool, size_type>
      inLocallyOwnedRanges(const global_size_type globalId) const = 0;
 
      virtual std::pair<bool, size_type>
      isGhostEntry(const global_size_type ghostId) const = 0;
 
      virtual size_type
      globalToLocalIndex(const global_size_type globalId) const = 0;
 
      virtual global_size_type
      localToGlobalIndex(const size_type localId) const = 0;
 
      virtual void
      getBasisCenters(const size_type       localId,
                      dftefe::utils::Point &basisCenter) const = 0;
    };
 
  } // end of namespace basis
} // end of namespace dftefe
#endif // dftefeBasisManager_h