ParticleInsertion.h

// Copyright (C) 2015 Technische Universitaet Muenchen
// This file is part of the Mamico project. For conditions of distribution
// and use, please see the copyright notice in Mamico's main folder, or at
// www5.in.tum.de/mamico
#ifndef _MOLECULARDYNAMICS_COUPLING_PARTICLEINSERTION_H_
#define _MOLECULARDYNAMICS_COUPLING_PARTICLEINSERTION_H_
 
#include "coupling/BoundaryForceController.h"
#include <cstdlib>
#include <iostream>
 
namespace coupling {
template <class LinkedCell, unsigned int dim> class ParticleInsertion;
}

template <class LinkedCell, unsigned int dim> class coupling::ParticleInsertion {
public:
  enum Action {
    NoAction = 0,  
    Insertion = 1, 
    Deletion = 2   
  };

  virtual typename coupling::ParticleInsertion<LinkedCell, dim>::Action
  insertDeleteMass(coupling::datastructures::CouplingCellWithLinkedCells<LinkedCell, dim>& cell, const tarch::la::Vector<dim, double>& couplingCellPosition,
                   const tarch::la::Vector<dim, double>& couplingCellSize, const tarch::la::Vector<dim, double>& meanVelocity, const double& temperature,
                   const coupling::BoundaryForceController<LinkedCell, dim>& boundaryForceController) = 0;

  virtual bool requiresPotentialEnergyLandscape() = 0;

  ParticleInsertion(unsigned int insertDeleteMassEveryTimestep) : _insertDeleteMassEveryTimestep(insertDeleteMassEveryTimestep) {
    if (_insertDeleteMassEveryTimestep == 0) {
      std::cout << "ERROR ParticleInsertion::ParticleInsertion(..): "
                   "_insertDeleteMassEveryTimestep=0!"
                << std::endl;
      exit(EXIT_FAILURE);
    }
  }

  virtual ~ParticleInsertion() {}

  bool insertDeleteMassAtTimestep(unsigned int t) const { return (t % _insertDeleteMassEveryTimestep == 0); }
 
private:
  const unsigned int _insertDeleteMassEveryTimestep;
};
#endif // _MOLECULARDYNAMICS_COUPLING_PARTICLEINSERTION_H_