BaseBoundary.h

Go to the documentation of this file.

//Copyright (c) 2013-2014, 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 BaseBoundary_H
#define BaseBoundary_H

#include "WallHandler.h"
#include "ParticleHandler.h"
#include "RNG.h"


class BaseBoundary 
{
    public:
    virtual BaseBoundary* copy() const = 0;
    virtual ~BaseBoundary() {};
    

    virtual int createPeriodicParticles(BaseParticle *P UNUSED, ParticleHandler &pH UNUSED){return 0;};
    
    virtual bool checkBoundaryAfterParticleMoved(BaseParticle *P UNUSED, ParticleHandler &pH UNUSED){return false;};
    
    virtual void checkBoundaryActionsBeforeTimeStep(ParticleHandler &pH UNUSED, WallHandler &wH UNUSED, RNG &random UNUSED){};
    
    void set_Index(int index) {_index=index;}
    void set_Id(int id) {_id=id;}
    void setHandler(BoundaryHandler* handler) {_handler=handler;}
    
    friend inline std::ostream& operator<<(std::ostream& os, const BaseBoundary &b);
    
    friend inline std::istream& operator>>(std::istream& is, BaseBoundary &b);

    virtual void read(std::istream& is UNUSED) = 0;
    
    virtual void print(std::ostream& os UNUSED) const = 0;
    
    virtual void moveInHandler(int newPos){_index=newPos;}
    
    private:
    BoundaryHandler* _handler;
    int _index;
    int _id;
};

inline std::ostream& operator<<(std::ostream& os, const BaseBoundary &b)
{
    b.print(os);
    return os;
}

inline std::istream& operator>>(std::istream& is, BaseBoundary &b)
{
    b.read(is);
    return(is);
}
#endif