TimeDependentPeriodicBoundary.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 TimeDependentPeriodicBoundary_H
#define TimeDependentPeriodicBoundary_H
 
#include "BasePeriodicBoundary.h"
#include "ParticleHandler.h"
#include "Math/Vector.h"
#include "MpiDataClass.h"
#include <functional>
 
class TimeDependentPeriodicBoundary : public BasePeriodicBoundary
{
public:
 
    TimeDependentPeriodicBoundary();
 
    ~TimeDependentPeriodicBoundary();
 
    TimeDependentPeriodicBoundary* copy() const override;
 
    TimeDependentPeriodicBoundary(const TimeDependentPeriodicBoundary& other);
    
    void set(Vec3D normal, Mdouble distanceLeft, Mdouble distanceRight,
             std::function<Vec3D(Mdouble)> planewiseShift, std::function<Vec3D(Mdouble)> boost);
 
    void set(Vec3D normal, Vec3D positionLeft, Vec3D positionRight,
             std::function<Vec3D(Mdouble)> shift, std::function<Vec3D(Mdouble)> boost);
    
    void setPlanewiseShiftAndBoost(
            std::function<Vec3D(Mdouble)> shift, std::function<Vec3D(Mdouble)> boost);
 
    void setMaxShift(Mdouble maxShift);
 
    Vec3D getNormal() const;
 
    Mdouble getDistanceLeft() const;
    
    Mdouble getDistanceRight() const;
 
    Vec3D getShift(Mdouble time) const;
 
    Vec3D getPlanewiseShift(Mdouble time) const;
 
    Vec3D getBoost(Mdouble time) 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;
 
    virtual void shiftAndBoostParticle(BaseParticle* p, Mdouble time) const;
 
    virtual void shiftPositions(Vec3D &position1, Vec3D &position2) const;
 
    virtual bool isClosestToLeftBoundary(const BaseParticle& p) const;
 
    virtual 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;
 
    virtual void write(std::ostream& os) const override;
 
    virtual std::string getName() const override;
    
protected:
    Vec3D normal_;
 
    Mdouble distanceLeft_;
 
    Mdouble distanceRight_; 
 
    std::function<Vec3D (Mdouble)> planewiseShift_;
 
    std::function<Vec3D (Mdouble)> boost_; 
 
    Mdouble maxShift_;
 
};
#endif