ParticleCell.h

Go to the documentation of this file.

 
#pragma once
 
#include "autopas/options/IteratorBehavior.h"
#include "autopas/particles/OwnershipState.h"
#include "autopas/utils/WrapOpenMP.h"
#include "autopas/utils/inBox.h"
 
namespace autopas {
 
enum class CellType {
  FullParticleCell,
  ReferenceParticleCell,
  ClusterTower,
  SortedCellView,
  IsNoCell
};
 
template <class Particle_T>
class ParticleCell {
 public:
  using ParticleType = Particle_T;
 
  virtual ~ParticleCell() = default;
 
  explicit ParticleCell() = default;
 
  ParticleCell(ParticleCell &&other) noexcept = default;
 
  ParticleCell(const ParticleCell &other) : _cellLock(){};
 
  virtual void addParticle(const Particle_T &p) = 0;
 
  [[nodiscard]] virtual size_t size() const = 0;
 
  [[nodiscard]] virtual size_t getNumberOfParticles(IteratorBehavior behavior = IteratorBehavior::owned) const = 0;
 
  [[nodiscard]] virtual bool isEmpty() const = 0;
 
  virtual void clear() = 0;
 
  virtual void deleteDummyParticles() = 0;
 
  virtual CellType getParticleCellTypeAsEnum() = 0;
 
  virtual void deleteByIndex(size_t index) = 0;
 
  virtual void setCellLength(std::array<double, 3> &cellLength) = 0;
 
  [[nodiscard]] virtual std::array<double, 3> getCellLength() const = 0;
 
  OwnershipState getPossibleParticleOwnerships() const { return _ownershipState; }
 
  void setPossibleParticleOwnerships(OwnershipState state) {
    std::lock_guard<AutoPasLock> guard(this->_cellLock);
    if (_ownershipStateDefined) {
      autopas::utils::ExceptionHandler::exception(
          "ParticleCell::setPossibleParticleOwnerships() can not set OwnershipState of a cell after "
          "it has been set");
    }
    _ownershipState = state;
    _ownershipStateDefined = true;
  }
 
  AutoPasLock &getCellLock() const { return _cellLock; }
 
 protected:
  mutable AutoPasLock _cellLock{};
 
  OwnershipState _ownershipState{autopas::OwnershipState::owned | autopas::OwnershipState::halo};
  bool _ownershipStateDefined{false};
};
 
}  // namespace autopas