MultiVector.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 Sambit Das, Bikash Kanungo
 */
 
 
#ifndef dftefeMultiVector_h
#define dftefeMultiVector_h
 
#include <utils/TypeConfig.h>
#include <utils/Defaults.h>
#include <utils/MemoryStorage.h>
#include <utils/MPITypes.h>
#include <utils/MPIPatternP2P.h>
#include <utils/MPICommunicatorP2P.h>
#include <linearAlgebra/VectorAttributes.h>
#include <linearAlgebra/LinAlgOpContext.h>
#include <linearAlgebra/BlasLapackTypedef.h>
#include <memory>
namespace dftefe
{
  namespace linearAlgebra
  {
    template <typename ValueType, dftefe::utils::MemorySpace memorySpace>
    class MultiVector
    {
    public:
      //
      // typedefs
      //
      using Storage    = dftefe::utils::MemoryStorage<ValueType, memorySpace>;
      using value_type = typename Storage::value_type;
      using pointer    = typename Storage::pointer;
      using reference  = typename Storage::reference;
      using const_reference = typename Storage::const_reference;
      using iterator        = typename Storage::iterator;
      using const_iterator  = typename Storage::const_iterator;
 
    public:
      MultiVector() = default;
 
      ~MultiVector() = default;
 
      MultiVector(const size_type                               size,
                  const size_type                               numVectors,
                  std::shared_ptr<LinAlgOpContext<memorySpace>> linAlgOpContext,
                  const ValueType initVal = utils::Types<ValueType>::zero);
 
      MultiVector(
        std::unique_ptr<typename MultiVector<ValueType, memorySpace>::Storage>
                                                      storage,
        size_type                                     numVectors,
        std::shared_ptr<LinAlgOpContext<memorySpace>> linAlgOpContext);
 
      MultiVector(std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
                                                                mpiPatternP2P,
                  std::shared_ptr<LinAlgOpContext<memorySpace>> linAlgOpContext,
                  const size_type                               numVectors,
                  const ValueType initVal = utils::Types<ValueType>::zero);
 
      MultiVector(std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
                                                                mpiPatternP2P,
                  std::shared_ptr<LinAlgOpContext<memorySpace>> linAlgOpContext,
                  const size_type                               numVectors,
                  const ValueType                               min,
                  const ValueType                               max);
 
      MultiVector(
        std::unique_ptr<typename MultiVector<ValueType, memorySpace>::Storage>
          &storage,
        std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
                                                      mpiPatternP2P,
        std::shared_ptr<LinAlgOpContext<memorySpace>> linAlgOpContext,
        const size_type                               numVectors);
 
      MultiVector(
        const std::pair<global_size_type, global_size_type> locallyOwnedRange,
        const std::vector<global_size_type> &               ghostIndices,
        const utils::mpi::MPIComm &                         mpiComm,
        std::shared_ptr<LinAlgOpContext<memorySpace>>       linAlgOpContext,
        const size_type                                     numVectors,
        ValueType initVal = utils::Types<ValueType>::zero);
 
      MultiVector(
        const std::pair<global_size_type, global_size_type> locallyOwnedRange,
        const utils::mpi::MPIComm &                         mpiComm,
        std::shared_ptr<LinAlgOpContext<memorySpace>>       linAlgOpContext,
        const size_type                                     numVectors,
        const ValueType initVal = utils::Types<ValueType>::zero);
 
 
      MultiVector(const global_size_type                        globalSize,
                  const utils::mpi::MPIComm &                   mpiComm,
                  std::shared_ptr<LinAlgOpContext<memorySpace>> linAlgOpContext,
                  const size_type                               numVectors,
                  const ValueType initVal = utils::Types<ValueType>::zero);
 
      MultiVector(const MultiVector &u);
 
      MultiVector(const MultiVector &u,
                  const ValueType    initVal = utils::Types<ValueType>::zero);
 
      MultiVector(MultiVector &&u) noexcept;
 
      MultiVector &
      operator=(const MultiVector &u);
 
      MultiVector &
      operator=(MultiVector &&u);
 
      iterator
      begin();
 
      const_iterator
      begin() const;
 
      iterator
      end();
 
      const_iterator
      end() const;
 
      ValueType *
      data();
 
      const ValueType *
      data() const;
 
 
      void
      setValue(const ValueType val);
 
      std::vector<double>
      l2Norms() const;
 
      std::vector<double>
      lInfNorms() const;
 
      size_type
      getNumberComponents() const;
 
      void
      updateGhostValues(const size_type communicationChannel = 0);
 
      void
      accumulateAddLocallyOwned(const size_type communicationChannel = 0);
 
      void
      updateGhostValuesBegin(const size_type communicationChannel = 0);
 
      void
      updateGhostValuesEnd();
 
      void
      accumulateAddLocallyOwnedBegin(const size_type communicationChannel = 0);
 
      void
      accumulateAddLocallyOwnedEnd();
 
      bool
      isCompatible(const MultiVector<ValueType, memorySpace> &rhs) const;
 
      std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
      getMPIPatternP2P() const;
 
      std::shared_ptr<LinAlgOpContext<memorySpace>>
      getLinAlgOpContext() const;
 
      global_size_type
      globalSize() const;
 
      size_type
      localSize() const;
 
      size_type
      locallyOwnedSize() const;
 
      size_type
      ghostSize() const;
 
      size_type
      numVectors() const;
 
    protected:
      std::unique_ptr<Storage>                      d_storage;
      std::shared_ptr<LinAlgOpContext<memorySpace>> d_linAlgOpContext;
      VectorAttributes                              d_vectorAttributes;
      size_type                                     d_localSize;
      global_size_type                              d_globalSize;
      size_type                                     d_locallyOwnedSize;
      size_type                                     d_ghostSize;
      size_type                                     d_numVectors;
      std::unique_ptr<utils::mpi::MPICommunicatorP2P<ValueType, memorySpace>>
        d_mpiCommunicatorP2P;
      std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
        d_mpiPatternP2P;
    };
 
    //
    // helper functions
    //
 
    template <typename ValueType, dftefe::utils::MemorySpace memorySpace>
    void
    swap(MultiVector<ValueType, memorySpace> &X,
         MultiVector<ValueType, memorySpace> &Y);
 
    template <typename ValueType1,
              typename ValueType2,
              utils::MemorySpace memorySpace>
    void
    add(blasLapack::scalar_type<ValueType1, ValueType2> a,
        const MultiVector<ValueType1, memorySpace> &    u,
        blasLapack::scalar_type<ValueType1, ValueType2> b,
        const MultiVector<ValueType2, memorySpace> &    v,
        MultiVector<blasLapack::scalar_type<ValueType1, ValueType2>,
                    memorySpace> &                      w);
 
 
    template <typename ValueType1,
              typename ValueType2,
              utils::MemorySpace memorySpace>
    void
    add(const std::vector<blasLapack::scalar_type<ValueType1, ValueType2>> &a,
        const MultiVector<ValueType1, memorySpace> &                        u,
        const std::vector<blasLapack::scalar_type<ValueType1, ValueType2>> &b,
        const MultiVector<ValueType2, memorySpace> &                        v,
        MultiVector<blasLapack::scalar_type<ValueType1, ValueType2>,
                    memorySpace> &                                          w);
 
 
 
    template <typename ValueType1,
              typename ValueType2,
              utils::MemorySpace memorySpace>
    void
    dot(const MultiVector<ValueType1, memorySpace> &                  u,
        const MultiVector<ValueType2, memorySpace> &                  v,
        std::vector<blasLapack::scalar_type<ValueType1, ValueType2>> &dotProds,
        const blasLapack::ScalarOp &opU = blasLapack::ScalarOp::Identity,
        const blasLapack::ScalarOp &opV = blasLapack::ScalarOp::Identity);
 
    template <typename ValueType1,
              typename ValueType2,
              utils::MemorySpace memorySpace>
    void
    dot(const MultiVector<ValueType1, memorySpace> &     u,
        const MultiVector<ValueType2, memorySpace> &     v,
        blasLapack::scalar_type<ValueType1, ValueType2> *dotProd,
        const blasLapack::ScalarOp &opU = blasLapack::ScalarOp::Identity,
        const blasLapack::ScalarOp &opV = blasLapack::ScalarOp::Identity);
 
 
  } // end of namespace linearAlgebra
} // end of namespace dftefe
#include <linearAlgebra/MultiVector.t.cpp>
#endif // dftefeMultiVector_h