BasePeriodicBoundary.h

Go to the documentation of this file.

// This file is part of the MercuryDPM project (https://www.mercurydpm.org).
// Copyright (c), The MercuryDPM Developers Team. All rights reserved.
// License: BSD 3-Clause License; see the LICENSE file in the root directory.
 
#ifndef BasePeriodicBoundary_H
#define BasePeriodicBoundary_H
 
#include "BaseBoundary.h"
#include "Math/ExtendedMath.h"
#include "Side.h"
 
class PeriodicBoundaryHandler;
 
class BasePeriodicBoundary : public BaseBoundary
{
public:
    BasePeriodicBoundary();
    
    BasePeriodicBoundary(const BasePeriodicBoundary& b);
    
    ~BasePeriodicBoundary() override;
    
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
    
    BasePeriodicBoundary* copy() const override = 0;
    
    void setPeriodicHandler(PeriodicBoundaryHandler* periodicHandler);
    
    PeriodicBoundaryHandler* getPeriodicHandler() const;
    
    virtual Mdouble getDistance(const BaseParticle& particle) const = 0;
    
    virtual Mdouble getDistance(const Vec3D& position) const = 0;
    
    virtual bool isClosestToLeftBoundary(const Vec3D& position) const = 0;
    
    virtual void shiftPosition(BaseParticle* particle) const = 0;
    
    void createPeriodicParticles(ParticleHandler& pH) override;
    
    void checkBoundaryAfterParticlesMove(ParticleHandler& pH) override;
    
    virtual void modifyPeriodicComplexity(std::vector<int>& complexity, int& totalPeriodicComplexity,
                                          BaseParticle* particle, int i) const;
    
    virtual void performActionsBeforeAddingParticles();
 
private:
    PeriodicBoundaryHandler* periodicHandler_;
};
 
#endif