PeriodicBoundary.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 PeriodicBoundary_H
#define PeriodicBoundary_H
 
#include "BasePeriodicBoundary.h"
#include "ParticleHandler.h"
#include "Math/Vector.h"
#include "MpiDataClass.h"
 
class PeriodicBoundary : public BasePeriodicBoundary
{
public:
 
    PeriodicBoundary();
 
    ~PeriodicBoundary() override;
 
    PeriodicBoundary* copy() const override;
 
    PeriodicBoundary(const PeriodicBoundary& other);
 
    void set(Vec3D normal, Mdouble distanceLeft, Mdouble distanceRight);
 
    void set(Vec3D normal, Vec3D positionLeft, Vec3D positionRight);
 
    void set(Vec3D normal, Mdouble distanceLeft, Mdouble distanceRight, Vec3D shiftDirection);
 
    void setPlanewiseShift(Vec3D planewiseShift);
 
    Vec3D getNormal() const;
 
    Mdouble getDistanceLeft() const;
    
    Mdouble getDistanceRight() const;
 
    Vec3D getShift() const;
 
    void moveLeft(Mdouble distanceLeft);
 
    void moveRight(Mdouble distanceRight);
    
    Mdouble getDistance(const BaseParticle& p) const override;
 
    Mdouble getDistance(const Vec3D& position) const override;
 
    virtual void shiftPosition(BaseParticle* p) const override;
    void shiftPosition(Vec3D& p) const;
 
    virtual void shiftPositions(Vec3D& postition1, Vec3D& postion2) const;
 
    virtual bool isClosestToLeftBoundary(const BaseParticle& p) const;
 
    bool isClosestToLeftBoundary(const Vec3D& p) const override;
 
    virtual void createPeriodicParticles(ParticleHandler &pH) override;
 
    void createGhostParticle(BaseParticle *pReal);
 
    void createPeriodicParticle(BaseParticle* p, ParticleHandler &pH) override;
 
    virtual void checkBoundaryAfterParticlesMove(ParticleHandler& pH) override;
 
    virtual void read(std::istream& is) override;
    MERCURYDPM_DEPRECATED
    void oldRead(std::istream& is);
    
    void write(std::ostream& os) const override;
    
    std::string getName() const override;
 
 
protected:
    Vec3D normal_;
    Mdouble distanceLeft_;
 
    Mdouble distanceRight_;
 
    Mdouble scaleFactor_;
 
    Vec3D shift_;
 
};
 
#endif