GranOO  3.0
A robust and versatile workbench to build 3D dynamic simulations based on the Discrete Element Method
NeighbourManager.hpp
Go to the documentation of this file.
1 // This file is part of GranOO, a workbench for DEM simulation.
2 //
3 // Author(s) : - Damien Andre IRCER/UNILIM, Limoges France
4 // <damien.andre@unilim.fr>
5 // - Jean-luc Charles Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
6 // <jean-luc.charles@ensam.eu>
7 // - Jeremie Girardot Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
8 // <jeremie.girardot@ensam.eu>
9 // - Cedric Hubert LAMIH/UPHF, Valenciennes France
10 // <cedric.hubert@uphf.fr>
11 // - Ivan Iordanoff Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
12 // <ivan.iordanoff@ensam.eu>
13 //
14 // Copyright (C) 2008-2019 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff
15 //
16 // This program is free software: you can redistribute it and/or modify
17 // it under the terms of the GNU General Public License as published by
18 // the Free Software Foundation, either version 3 of the License, or
19 // (at your option) any later version.
20 //
21 // This program is distributed in the hope that it will be useful,
22 // but WITHOUT ANY WARRANTY; without even the implied warranty of
23 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 // GNU General Public License for more details.
25 //
26 // You should have received a copy of the GNU General Public License
27 // along with this program. If not, see <http://www.gnu.org/licenses/>.
28 
29 
30 #ifndef _LibDEM_NeighbourManager_H
31 #define _LibDEM_NeighbourManager_H
32 
33 #include "GranOO3/Core/SetOf.hpp"
34 
35 namespace GranOO3
36 {
37  namespace DEM
38  {
39  template<class T>
41  {
42 
43  public:
44  NeighbourManager(T& item);
46 
47  // Neighbour management
48  void add(T& item);
49  void add(T* item_ptr);
50  void erase(T& item);
51  void erase(T* item_ptr);
52  void clear();
53  size_t number() const;
55  const Core::SetOfBase<T>& set() const;
56 
57  private:
58  NeighbourManager() = delete;
61 
62  protected:
63  T& _item;
65  };
66 
67 
68  }
69 }
70 
71 #include "GranOO3/DEM/NeighbourManager.tpp"
72 
73 
74 #endif
75 
a util class for representing neighbouring (mainly DEM::Element) items
Definition: NeighbourManager.hpp:41
size_t number() const
get the number of neighbours
NeighbourManager & operator=(const NeighbourManager &)=delete
void add(T &item)
add the item as a neighbour
void erase(T &item)
erase the passed item from the neighbouring list
NeighbourManager(const NeighbourManager &)=delete
Core::SetOfBase< T > & set()
get the neighbouring list
T & _item
a reference to the main item which the neighbouring list is expected
Definition: NeighbourManager.hpp:63
void clear()
clear the neighouring list
void add(T *item_ptr)
similar as NeighbourManager::add(T& item) with a pointer instead of a reference
void erase(T *item_ptr)
similar as NeighbourManager::erase(T& item) with a pointer instead of a reference
const Core::SetOfBase< T > & set() const
get the neighbouring list
NeighbourManager(T &item)
constructor
Core::SetOfBase< T > _neighbour
the neighbouring list
Definition: NeighbourManager.hpp:64
Definition: Common.hpp:198