DistributedHaloVector.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
 
#include "linearAlgebra/DistributedVector.hpp"
 
class DistributedHaloVector : public DistributedVector
{
 
  public:
 
    DistributedHaloVector();
  
    DistributedHaloVector(DistributedHaloVector &v);
  
    DistributedHaloVector(CepsIndex M, CepsIndex m, CepsIndex nbHaloRows, CepsIndex *haloRows);
  
    ~DistributedHaloVector() override;
  
    void
    getLocalData() override;
  
    void
    releaseLocalData() override;
  
    void
    getStripe(DistributedHaloVector &u, CepsInt component, CepsUInt pbDim);
  
    void
    getValues(CepsReal *values, CepsIndex n, const CepsIndex *indices) override;
  
    CepsInt
    getNbHalo();
  
    CepsReal &
    operator[](CepsIndex globalIndex) override;
  
    CepsReal
    operator[](CepsIndex globalIndex) const override;
  
    DistributedHaloVector &
    operator=(DistributedHaloVector &v);
  
    DistributedHaloVector &
    operator=(DistributedVector &v);
  
    void
    getStripeFromNonHalo(DistributedVector &src, CepsInt component, CepsUInt pbDim);
  
    void
    scale(CepsMathScalar alpha) override;
  
    void
    abs() override;
 
 
  private:
 
    void
    initialize();
 
 
  protected:
 
    std::map<CepsIndex, CepsIndex> m_globalToLocalMapping;  
    CepsIndex                      m_nbHaloRows;            
  
  private:
 
    PetscVector m_localV;  
 
};
 
using DHVecPtr = std::shared_ptr<DistributedHaloVector>;