BaseBoundary.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 BaseBoundary_H
#define BaseBoundary_H
 
#include <set>
#include "BaseObject.h"
#include "Math/ExtendedMath.h"
 
class BoundaryHandler;
 
class PeriodicBoundaryHandler;
 
class ParticleHandler;
 
class BaseParticle;
 
class DPMBase;
 
class BaseBoundary : public BaseObject
{
public:
    BaseBoundary();
    
    BaseBoundary(const BaseBoundary& b);
    
    ~BaseBoundary() override;
    
    virtual BaseBoundary* copy() const = 0;
    
    void read(std::istream& is) override = 0;
    
    void write(std::ostream& os) const override = 0;
    
    
    virtual void createPeriodicParticle(BaseParticle* p UNUSED, ParticleHandler& pH UNUSED);
    
    virtual void createPeriodicParticles(ParticleHandler& pH UNUSED);
    
    virtual void checkBoundaryAfterParticlesMove(ParticleHandler& pH);
    
    virtual void checkBoundaryBeforeTimeStep(DPMBase* md);
    
    virtual void actionsBeforeTimeLoop();
    
    virtual void modifyGhostAfterCreation(BaseParticle* particle, int i);
 
    virtual void writeVTK(std::fstream& file) {}
 
    void setHandler(BoundaryHandler* handler);
    
    BoundaryHandler* getHandler() const;
 
#ifdef MERCURYDPM_USE_MPI
    std::set<BaseParticle*>& getParticlesToBeDeleted();
#endif
 
protected:
#ifdef MERCURYDPM_USE_MPI
    std::set<BaseParticle*> particlesToBeDeleted_;
 
#endif
 
private:
    
    BoundaryHandler* handler_;
    
};
 
#endif