BasePeriodicBoundary.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 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