DistributedInfos.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 <array>
 
#include "common/containers/LocalGlobalMapping.hpp"
 
class DistributedFactory;
 
template <class _Tp>
void
setGlobalIndexFunction (_Tp *&obj, CepsGlobalIndex idx)
{
  obj->setGlobalIndex (idx);
  return;
}
 
template <class _Type, class _Hash=CepsHash>
class DistributedInfos
{
  public:
 
    DistributedInfos();
 
    DistributedInfos(const DistributedInfos &);
 
    DistributedInfos&
    operator=(const DistributedInfos &);
 
    ~DistributedInfos();
 
    // -----------------------------------------------------------------
 
    LocalGlobalMapping<_Type,_Hash>*
    getOwnedMapping();
 
    LocalGlobalMapping<_Type,_Hash>*
    getHaloMapping();
 
    // -----------------------------------------------------------------
 
    CepsBool
    hasHash(const _Hash &hashValue, const CepsUInt &pId) const;
 
    _Type &
    atHash(const _Hash &hashValue, const CepsUInt &pId, const _Type &def);
 
    const _Type &
    atHash(const _Hash &hashValue, const CepsUInt &pId, const _Type &def) const;
 
    CepsBool
    hasLocal(const CepsLocalIndex &localId, const CepsUInt &pId) const;
 
    _Type &
    atLocal(const CepsLocalIndex &localId, const CepsUInt &pId, const _Type &def);
 
    const _Type &
    atLocal(const CepsLocalIndex &localId, const CepsUInt &pId, const _Type &def) const;
 
    CepsBool
    hasGlobal(const CepsGlobalIndex &globalId, const CepsUInt &pId) const;
 
    _Type &
    atGlobal(const CepsGlobalIndex &globalId, const CepsUInt &pId);
 
    const _Type &
    atGlobal(const CepsGlobalIndex &globalId, const CepsUInt &pId) const;
 
    _Type &
    atGlobal(const CepsGlobalIndex &globalId, const CepsUInt &pId, const _Type &def);
 
    const _Type &
    atGlobal(const CepsGlobalIndex &globalId, const CepsUInt &pId, const _Type &def) const;
 
    const CepsVector<_Type> &
    getOwned() const;
 
    CepsVector<_Type> &
    getOwned();
 
    const _Type &
    getOwned(CepsUInt i) const;
 
    _Type &
    getOwned(CepsUInt i);
 
    const CepsVector<_Type> &
    getHalo() const;
 
    CepsVector<_Type> &
    getHalo();
 
    const _Type &
    getHalo(CepsUInt i) const;
 
    _Type &
    getHalo(CepsUInt i);
 
    // -----------------------------------------------------------------
 
    void
    add(const _Type& x, const _Hash& hashValue, const CepsGlobalIndex& globalId,
        const CepsUInt& pId);
 
    void
    addOwned(const _Type &x, const _Hash &hashValue, const CepsGlobalIndex &globalId);
    
 
    void
    addHalo(
      const _Type&           x,
      const _Hash&           hashValue,
      const CepsGlobalIndex& globalId,
      const CepsUInt&        fromProcId
    );
 
    // -----------------------------------------------------------------
 
    void
    add(const _Type &x, const _Hash &hashValue, const CepsUInt &pId);
 
    void
    addOwned(const _Type &x, const _Hash &hashValue);
 
    void
    addHalo(const _Type &x, const _Hash &hashValue, const CepsUInt &fromProcId);
 
    // -----------------------------------------------------------------
 
    void
    destroyObjects();
 
    void
    reset();
 
    void
    synchronize(
      CepsBool setGlobalIndicesFromLocals,
      std::function<void (_Type &, CepsGlobalIndex)> update = nullptr
    );
 
    void
    synchronizeTotalSize();
 
    CepsUInt
    getNumberOfOwned() const;
 
    CepsUInt
    getNumberOfHalo() const;
 
    CepsUInt
    getTotalNumberOfEntities() const;
 
    CepsUInt
    getGlobalIndexOffset(CepsProcId pId) const;
 
  protected:
 
    LocalGlobalMapping<_Type,_Hash>* m_owned   = nullptr;  
    LocalGlobalMapping<_Type,_Hash>* m_halo    = nullptr;  
    CepsVector<CepsVector<_Hash>>    m_toReceiveFrom = {}; 
    CepsUInt m_nbGlobalOwned = 0U;         
    CepsUInt m_nbGlobalHalo  = 0U;         
    CepsVector<CepsUInt> m_elementsOffset; 
};
 
#include "common/containers/DistributedInfos.tpp"