LeesEdwardsBoundary.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 LEESEDWARDSBOUNDARY_H
#define LEESEDWARDSBOUNDARY_H
 
#include "BaseBoundary.h"
 
#include <functional>
 
class ParticleHandler;
 
class LeesEdwardsBoundary : public BaseBoundary
{
public:
    
    LeesEdwardsBoundary()
    {
#ifdef MERCURYDPM_USE_MPI
        MPIContainer& communicator = MPIContainer::Instance();
        if (communicator.getNumberOfProcessors() > 1)
        {
            logger(WARN,"LeesEdwardsBoundaries are currently not implemented in parallel MercuryDPM");
        }
#endif
    }
 
    LeesEdwardsBoundary(const LeesEdwardsBoundary& other);
    
    void
    set(std::function<Mdouble(Mdouble)> shift, std::function<Mdouble(Mdouble)> velocity, Mdouble left, Mdouble right,
        Mdouble down, Mdouble up);
    
    void updateBoundaries(Mdouble left, Mdouble right, Mdouble down, Mdouble up);
    
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
    
    std::string getName() const override;
    
    LeesEdwardsBoundary* copy() const override;
    
    Mdouble getHorizontalDistance(BaseParticle& p, bool& positive);
    
    Mdouble getVerticalDistance(BaseParticle& p, bool& positive);
    
    void shiftHorizontalPosition(BaseParticle* p, bool positive);
    
    void shiftVerticalPosition(BaseParticle* p, bool positive);
    
    void checkBoundaryAfterParticleMoved(BaseParticle* p);
    
    void checkBoundaryAfterParticlesMove(ParticleHandler& pH) override;
    
    void createPeriodicParticle(BaseParticle* p, ParticleHandler& pH) override;
    
    void createPeriodicParticles(ParticleHandler& pH) override;
    
    void createHorizontalPeriodicParticle(BaseParticle* p, ParticleHandler& pH);
    
    void createVerticalPeriodicParticle(BaseParticle* p, ParticleHandler& pH);
    
    Mdouble getCurrentShift();
    
    Mdouble getCurrentVelocity();
    
    void setShift(std::function<Mdouble(Mdouble)>);
    
    void setVelocity(std::function<Mdouble(Mdouble)>);
 
private:
    Mdouble left_;      
    Mdouble right_;     
    Mdouble down_;      
    Mdouble up_;        
    std::function<Mdouble(Mdouble)> shift_;
    std::function<Mdouble(Mdouble)> velocity_;  
};
 
#endif