PeriodicBoundary.h

Go to the documentation of this file.

//Copyright (c) 2013-2020, 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 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;

    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;

    void read(std::istream& is) override;
    
    MERCURY_DEPRECATED
    void oldRead(std::istream& is);
    
    void write(std::ostream& os) const override;
    
    std::string getName() const override;
    
    void createPeriodicParticles(ParticleHandler& pH) override;
    
    void createGhostParticle(BaseParticle* pReal);
    
    void createPeriodicParticle(BaseParticle* p, ParticleHandler& pH) override;
    
    void checkBoundaryAfterParticlesMove(ParticleHandler& pH) override;

protected:
    Vec3D normal_;
    Mdouble distanceLeft_;

    Mdouble distanceRight_;

    Mdouble scaleFactor_;

    Vec3D shift_;

};

#endif