superParticleSystem3D.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2016 Thomas Henn, Mathias J. Krause, Davide Dapelo
 *  E-mail contact: info@openlb.net
 *  The most recent release of OpenLB can be downloaded at
 *  <http://www.openlb.net/>
 *
 *  This program 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 2
 *  of the License, or (at your option) any later version.
 *
 *  This program 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 this program; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
 */
 
#ifndef SUPERPARTICLESYSTEM_3D_H
#define SUPERPARTICLESYSTEM_3D_H
 
#define shadows
 
#include <set>
#include <vector>
#include <list>
#include <deque>
#include <memory>
#include "boundary/boundary3D.h"
#include "communication/loadBalancer.h"
#include "communication/mpiManager.h"
 
#include "forces/force3D.h"
#include "functors/analytical/indicator/indicatorBaseF3D.h"
#include "functors/analytical/analyticalF.h"
#include "geometry/cuboidGeometry3D.h"
#include "geometry/superGeometry.h"
#include "particleSystem3D.h"
#include "superParticleSysVTUout.h"
#include "functors/lattice/latticeInterpPhysVelocity3D.h"
#include "twoWayCouplings/twoWayCouplings3D.h"
 
namespace olb {
 
template<typename T, template<typename U> class PARTICLETYPE>
class SuperParticleSysVtuWriter;
 
template<typename T>
class SuperParticleSysVtuWriterMag;
 
template<typename T, template<typename U> class PARTICLETYPE>
class Force3D;
 
template<typename T, template<typename U> class PARTICLETYPE>
class Boundary3D;
 
template <typename T, typename DESCRIPTOR>
class SuperLatticeInterpVelocity3D;
 
template<typename T, template<typename U> class PARTICLETYPE>
class SuperParticleSystem3D :  public SuperStructure<T,3> {
 
public:
  time_t _stopSorting;
 
  SuperParticleSystem3D(CuboidGeometry3D<T>& cuboidGeometry,
                        LoadBalancer<T>& loadBalancer, SuperGeometry<T,3>&);
  SuperParticleSystem3D(SuperGeometry<T,3>&);
 
  SuperParticleSystem3D(SuperParticleSystem3D<T, PARTICLETYPE>& spSys);
  SuperParticleSystem3D(SuperParticleSystem3D<T, PARTICLETYPE> const& spSys);
 
  SuperParticleSystem3D(SuperParticleSystem3D<T, PARTICLETYPE> && spSys);
  ~SuperParticleSystem3D() override {
    while(!_pSystems.empty()) delete _pSystems.back(), _pSystems.pop_back();
  };
 
  void addParticle(PARTICLETYPE<T> &p);
 
  void addParticle(IndicatorF3D<T>& ind, T mas, T rad, int no = 1, std::vector<T> vel = {0., 0., 0.});
  void addParticle(IndicatorF3D<T>& ind, T mas, T rad, int no, int id,
                   std::vector<T> vel, std::vector<T> dMoment, std::vector<T> aVel,
                   std::vector<T> torque, T magnetisation, int sActivity)
  {
    addParticle(ind, mas, rad, no, vel);
  };
 
  void addParticle(IndicatorF3D<T>& ind, std::set<int>  material, T mas, T rad, int no = 1,
                   std::vector<T> vel = {0., 0., 0.});
 void addHL3DParticle(IndicatorF3D<T>& ind, std::set<int>  material, T mas, T rad, int no = 1,
                   std::vector<T> vel = {0., 0., 0.}, T surface=1., T volume=1.);
  void addParticle(IndicatorF3D<T>& ind,  std::set<int>  material, T mas, T rad, int no, int id,
                   std::vector<T> vel, std::vector<T> dMoment, std::vector<T> aVel,
                   std::vector<T> torque, T magnetisation, int sActivity)
  {
    addParticle(ind, material, mas, rad, no, vel);
  };
 
  void addParticle(std::set<int>  material, int no, T mas, T rad, std::vector<T> vel = {0., 0., 0.});
 
  void addParticleEquallyDistributed(IndicatorCuboid3D<T>& cuboid, T pMass,
                                     T pRad,/* number of particles on x, y, z axis*/
                                     int nox, int noy, int noz, std::vector<T> vel = {0., 0., 0.});
 
  void addParticleEquallyDistributed(IndicatorCuboid3D<T>& cuboid, int nox, int noy, int noz, PARTICLETYPE<T>& p);
 
  template<typename DESCRIPTOR>
  void generateParticlesCircleInletMassConcentration(
    IndicatorCircle3D<T>& indicatorCircle, T particleMassConcentration, T charPhysVelocity,
    T conversionFactorTime, SuperLatticeInterpPhysVelocity3D<T, DESCRIPTOR>& getVel,
    PARTICLETYPE<T>& p, std::set<int> material, int iT, T& particlesPerPhyTimeStep,
    std::vector<T>& inletVec, std::deque<std::vector<T>>& posDeq, int deqSize);
 
  void addParticlesFromFile(std::string name, T mass, T radius);
 
 
  void addParticlesFromParaviewFile(std::string name);
 
  void addTracerParticle(IndicatorF3D<T>& ind, int idTP, T mas, T rad, int noTP = 1, std::vector<T> vel = {0., 0., 0.});
 
  void addParticleBoxMuller(IndicatorF3D<T>& ind, T partRho, T mu, T sigma, int no = 1, T appProb = 1., std::vector<T> vel
                            = {0., 0., 0.});
 
  void clearParticles();
 
  void addParticleWithDistance(IndicatorCuboid3D<T>& ind,
                               T pMass, T pRad, std::vector<T> vel,
                               T conc, // volume concentration of particles, noP*vol_1p/volF = conc
                               T minDist, // minimum distance between each particle
                               bool checkDist // check whether minDist is chosen too large
                              );
 
  void simulate(T dT, bool scale = false);
  // multiple collision models
  void simulate(T dT, std::set<int> sActivityOfFreeParticle, bool scale = false)
  {
    simulate(dT, scale);
  };
  void simulateWithTwoWayCoupling_Mathias ( T dT,
      ForwardCouplingModel<T,PARTICLETYPE>& forwardCoupling,
      BackCouplingModel<T,PARTICLETYPE>& backCoupling,
      int material, int subSteps = 1, bool resetExternalField = true, bool scale = false );
  void simulateWithTwoWayCoupling_Davide ( T dT,
      ForwardCouplingModel<T,PARTICLETYPE>& forwardCoupling,
      BackCouplingModel<T,PARTICLETYPE>& backCoupling,
      int material, int subSteps = 1, bool resetExternalField = true, bool scale = false );
 
  void setParticlesVelRandom(T velFactor);
  void setParticlesPosRandom(T posFactor);
  void setParticlesPosRandom(T posFactorX, T posFactorY, T posFactorZ);
  void setMagneticParticlesdMomRandom() {};
  void setMagneticParticles(std::vector<T> dMoment, std::vector<T> vel, std::vector<T> aVel, std::vector<T> torque,
                            T magnetisation) {};
  void setMagneticParticles(std::vector<T> dMoment, std::vector<T> vel, std::vector<T> aVel, std::vector<T> torque,
                            T magnetisation, int sActivity) {};
 
  void prepareAgglomerates() {};
  void initAggloParticles() {};
  void findAgglomerates(int iT, int itVtkOutputMagParticles) {};
 
  bool particleSActivityTest(int sActivity)
  {
    return 0;
  };
 
  void setOverlap(T);
  T getOverlap();
 
  void saveToFile(std::string name);
 
  int globalNumOfParticles();
  int globalNumOfShadowParticles();
  int globalNumOfActiveParticles();
  int rankNumOfParticles();
  int rankNumOfShadowParticles();
  int rankNumOfActiveParticles();
  int rankNumOfTracerParticles();
  int globalNumOfTracerParticles();
 
  std::vector<ParticleSystem3D<T, PARTICLETYPE>*> getParticleSystems();
  std::vector<ParticleSystem3D<T, PARTICLETYPE>*>& getPSystems();
  ParticleSystem3D<T, PARTICLETYPE>& operator[](int i);
  std::vector<int> numOfForces();
 
  int numOfPSystems();
 
  int countMaterial(int mat);
 
  void addForce(std::shared_ptr<Force3D<T, PARTICLETYPE> > f);
  void addBoundary(std::shared_ptr<Boundary3D<T, PARTICLETYPE> > b);
  void addParticleOperation(std::shared_ptr<ParticleOperation3D<T, PARTICLETYPE> > o);
 
  template<typename DESCRIPTOR>
  void setVelToFluidVel(SuperLatticeInterpPhysVelocity3D<T, DESCRIPTOR>&);
 
  void setVelToAnalyticalVel(AnalyticalConst3D<T, T>&);
 
  void setContactDetection(ContactDetection<T, PARTICLETYPE>& contactDetection);
  void setContactDetectionForPSys(ContactDetection<T, PARTICLETYPE>& contactDetection, int pSysNr);
 
  void print();
 
  void printDeep(std::string message="");
 
  void print(std::list<int> mat);
 
  void captureEscapeRate(std::list<int> mat);
 
  void diffEscapeRate(std::list<int> mat, int& globalPSum, int& pSumOutlet, T& diffEscapeRate, T& maxDiffEscapeRate,
                      int iT, int iTConsole, T genPartPerTimeStep = 0);
  void diffEscapeRate(std::list<int> mat, int& globalPSum, int& pSumOutlet, T& diffEscapeRate, T& maxDiffEscapeRate,
                      int iT, int iTConsole, T genPartPerTimeStep,
                      T& avDiffEscapeRate, T latticeTimeStart, T latticeTimeEnd);
 
  void getOutput(std::string filename, int iT, T conversionFactorTime,
                 unsigned short particleProperties);
 
  template<typename DESCRIPTOR>
  T getStokes(UnitConverter<T, DESCRIPTOR>& conv, T pRho, T rad)
  {
    return pRho * util::pow(2.*rad, 2) * conv.getCharPhysVelocity() / (18.*conv.getCharPhysLength() *
           (conv.getPhysViscosity() * conv.getPhysDensity()));
  };
 
  friend class SuperParticleSysVtuWriter<T, PARTICLETYPE> ;
  friend class SuperParticleSysVtuWriterMag<T> ;
 
  enum particleProperties
    : unsigned short {position = 1, velocity = 2, radius = 4, mass = 8,
                    force = 16, storeForce = 32
                   };
 
protected:
  mutable OstreamManager clout;
 
  void init();
  void updateParticleDistribution();
public:
  bool findCuboid(PARTICLETYPE<T>&, int overlap);
  bool findCuboid(PARTICLETYPE<T>&);
  // TODO overlap caste to int
  bool checkCuboid(PARTICLETYPE<T>& p, T overlap);
  bool checkCuboid(PARTICLETYPE<T>& p, T overlap, int iC);
  // Get Rank of neighbours
  std::list<int>& getRankNeighbours()
  {
    return _rankNeighbours;
  }
protected:
  int countLocMaterial(int mat);
 
  void addShadowParticle(PARTICLETYPE<T> &p);
 
  std::vector<ParticleSystem3D<T, PARTICLETYPE>*> _pSystems;
  SuperGeometry<T,3>& _superGeometry;
  std::list<int> _rankNeighbours;
  std::vector<std::vector<int> > _cuboidNeighbours;
  // TODO: !attention! here T _overlap; class SuperStructure<T,3> has int _overlap
  // but superParticleSystem<T, PARTICLETYPE<T>> overlap is of type T
  T _overlap;
  std::map<int, std::vector<double> > _send_buffer;
  std::multimap<int, PARTICLETYPE<T> > _relocate;
  std::multimap<int, PARTICLETYPE<T> > _relocateShadow;
};
 
// Magnetic particle type
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::addParticle(IndicatorF3D<double>& ind, double mas,
    double rad, int no, int id,
    std::vector<double> vel, std::vector<double> dMoment, std::vector<double> aVel,
    std::vector<double> torque, double magnetisation, int sActivity);
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::addParticle(IndicatorF3D<double>& ind, double mas,
    double rad, int no, int id,
    std::vector<double> vel, std::vector<double> dMoment, std::vector<double> aVel,
    std::vector<double> torque, double magnetisation, int sActivity);
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::addParticle(IndicatorF3D<double>& ind,
    std::set<int>  material, double mas, double rad, int no, int id,
    std::vector<double> vel, std::vector<double> dMoment, std::vector<double> aVel,
    std::vector<double> torque, double magnetisation, int sActivity);
 
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::setMagneticParticlesdMomRandom();
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::setMagneticParticles(std::vector<double> dMoment,
    std::vector<double> vel, std::vector<double> aVel,
    std::vector<double> torque, double magnetisation, int sActivity);
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::prepareAgglomerates();
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::initAggloParticles();
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::findAgglomerates(int iT, int itVtkOutputMagParticles);
template<>
bool SuperParticleSystem3D<double, MagneticParticle3D>::particleSActivityTest(int sActivity);
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::simulate(double dT, std::set<int> sActivityOfFreeParticle, bool scale) ;
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::simulateWithTwoWayCoupling_Mathias ( double dT,
    ForwardCouplingModel<double,MagneticParticle3D>& forwardCoupling,
    BackCouplingModel<double,MagneticParticle3D>& backCoupling,
    int material, int subSteps, bool resetExternalField, bool scale );
template<>
void SuperParticleSystem3D<double, MagneticParticle3D>::simulateWithTwoWayCoupling_Davide ( double dT,
    ForwardCouplingModel<double,MagneticParticle3D>& forwardCoupling,
    BackCouplingModel<double,MagneticParticle3D>& backCoupling,
    int material, int subSteps, bool resetExternalField, bool scale );
 
 
}  //namespace olb
 
#endif /* SUPERPARTICLESYSTEM_3D_H */