PeriodicBoundaryHandler.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
//DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
#ifndef PERIODICBOUNDARYHANDLER_H
#define PERIODICBOUNDARYHANDLER_H
 
#include "BaseHandler.h"
#include "Boundaries/BasePeriodicBoundary.h"
#include "MpiDataClass.h"
#include <set>
 
 
typedef std::vector<MpiPeriodicParticleID*> PeriodicList;
typedef std::vector<MpiPeriodicGhostParticleID*> PeriodicGhostList;
 
class PeriodicBoundaryHandler final : public BaseHandler<BasePeriodicBoundary>
{
public:
    PeriodicBoundaryHandler();
    
    PeriodicBoundaryHandler(const PeriodicBoundaryHandler& BH);
    
    PeriodicBoundaryHandler operator=(const PeriodicBoundaryHandler& rhs);
    
    ~PeriodicBoundaryHandler() override;
    
    void addObject(BasePeriodicBoundary* P) override;
    
    void readAndAddObject(std::istream& is) override;
    
    std::string getName() const override;
    
    void setInteractionDistance(Mdouble interactionDistance);
    
    Mdouble getInteractionDistance();
    
    void updateStatus(std::set<BaseParticle*>& ghostParticlesToBeDeleted);
    
    void shiftParticle(BaseParticle* particle);
    
    void shiftParticle(BaseParticle* particle, const std::vector<int>& complexity);
    
    std::vector<int> computePeriodicComplexity(Vec3D position);
    
    void computePeriodicComplexity(std::vector<int>& periodicComplexity, int& totalPeriodicComplexity, Vec3D position);
    
    void addNewParticles();
    
    void addNewParticle(BaseParticle* particle);
    
    unsigned int getNumberOfPeriodicGhostParticles();
    
    Mdouble getNumberOfTruePeriodicGhostParticles();
    
    void getMPIFlags(BaseParticle* particle, bool& isInMPIDomain, bool& isMPIParticle);
    
    void setMPIFlags(BaseParticle* particle);
    
    void generateGhosts(std::vector<std::vector<int> >& list, std::vector<int> periodicComplexity,
                        std::vector<int>& complexity, int level);
    
    void collectGhostParticleData();
    
    void collectInteractionData();
    
    void processReceivedGhostParticleData(int targetIndex, std::vector<BaseParticle*>& newParticles);
    
    void processReceivedInteractionData(int targetIndex, std::vector<BaseParticle*>& newParticles);
    
    void processLocalInteractionData(std::vector<BaseParticle*>& newParticles);
    
    void processPeriodicParticles();
    
    void processLocalGhostParticles(std::vector<BaseParticle*>& newParticles);
    
    void updateParticles();
    
    bool checkIsReal(std::vector<int> complexity);
    
    bool checkChanged(std::vector<int> previousComplexity, std::vector<int> complexity);
    
    void updateParticleStatus(std::set<BaseParticle*>& particlesToBeDeleted);
    
    int findTargetProcessor(const std::vector<int>& complexity);
    
    void findNewParticle(BaseParticle* particle);
    
    bool checkIfAddNewParticle(BaseParticle* particle);
    
    void findNewParticles();
    
    void findNewInteractions();
    
    void communicateTargetDomains();
    
    void communicateNumberOfNewParticlesAndInteractions();
    
    void prepareNewParticleTransmission();
    
    void performNewParticleTransmission();
    
    void finaliseNewParticleTransmission();
    
    void preparePositionAndVelocityUpdate();
    
    void finalisePositionAndVelocityUpdate();
    
    void flushParticles(std::set<BaseParticle*>& particlesToBeFlushed);
    
    void cleanCommunicationList(std::vector<MpiPeriodicParticleIDBase*>& list);
    
    void cleanCommunicationLists();
    
    void clearCommunicationLists();
    
    void initialise();
    
    void flushPeriodicParticles(std::set<BaseParticle*>& particlesToBeDeleted);
    
    void performActionsBeforeAddingParticles();
    
    void updateMaserParticle(BaseParticle* particle);
    
    void
    findBoundariesToIgnore(BaseParticle* particle, std::vector<int>& periodicComplexity, int& totalPeriodicComplexity);
 
 
private:
    Mdouble interactionDistance_;
    
    std::vector<int> receiveTargetList_;
    
    std::vector<int> sendTargetList_;
    
    std::vector<int> numberOfNewPeriodicGhostParticlesReceive_;
    
    std::vector<int> numberOfNewPeriodicGhostParticlesSend_;
    
    std::vector<int> numberOfNewInteractionsSend_;
    
    std::vector<int> numberOfNewInteractionsReceive_;
    
    std::vector<std::vector<MPIParticle> > periodicGhostParticleReceive_;
    
    std::vector<std::vector<MPIParticle> > periodicGhostParticleSend_;
    
    std::vector<std::vector<int> > periodicGhostComplexityReceive_;
    
    std::vector<std::vector<int> > periodicGhostComplexitySend_;
    
    std::vector<std::vector<MPIParticlePosition> > updatePositionDataReceive_;
    
    std::vector<std::vector<MPIParticlePosition> > updatePositionDataSend_;
    
    std::vector<std::vector<MPIParticleVelocity> > updateVelocityDataReceive_;
    
    std::vector<std::vector<MPIParticleVelocity> > updateVelocityDataSend_;
    
    std::vector<void*> interactionDataSend_;
    
    std::vector<void*> interactionDataReceive_;
    
    std::vector<PeriodicList> newPeriodicParticleList_;
    
    std::vector<std::vector<BaseInteraction*> > newInteractionList_;
    
    std::vector<PeriodicList> periodicParticleList_;
    
    std::vector<PeriodicGhostList> periodicGhostList_;
};
 
#endif