InsertionBoundary.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 BOUNDARIES_INSERTIONBOUNDARY_H
#define BOUNDARIES_INSERTIONBOUNDARY_H

#include "BaseBoundary.h"

class MD;
class RNG;

class InsertionBoundary : public BaseBoundary
{
public:
    InsertionBoundary();
    
    InsertionBoundary(const InsertionBoundary& other);
    
    virtual ~InsertionBoundary();
    
    void set(BaseParticle* particleToCopy, unsigned int maxFailed);
    
    virtual BaseParticle* generateParticle(RNG &random)=0;

    virtual void checkBoundaryBeforeTimeStep(DPMBase* md);

    unsigned int getNumberOfParticlesInserted() const;
    
    void setMaxFailed(unsigned int maxFailed);
    
    unsigned int getMaxFailed() const;
    
    void setParticleToCopy(BaseParticle* particleToCopy);
    
    BaseParticle* getParticleToCopy() const;
    
    void read(std::istream& is);
    
    void write(std::ostream& os) const;

protected:
    BaseParticle* particleToCopy_;
    
    unsigned int maxFailed_;
    
    unsigned int numberOfParticlesInserted_;
};

#endif