HopperInsertionBoundary.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_HOPPERINSERTIONBOUNDARY_H
#define BOUNDARIES_HOPPERINSERTIONBOUNDARY_H

#include "InsertionBoundary.h"

class BaseParticle;
class RNG;

class HopperInsertionBoundary : public InsertionBoundary
{
public:
        
    HopperInsertionBoundary();
    
    HopperInsertionBoundary(const HopperInsertionBoundary &other);
    
    virtual HopperInsertionBoundary* copy() const;

    void set(BaseParticle* particleToCopy, int maxFailed, double yMin, double yMax, double radMin, double radMax,
            double chuteAngle, double fixedParticleRadius, bool isHopperCentred_, int hopperDim, double hopperAngle, double hopperLength, double hopperExitLength,
            double hopperHeight, double lift, double fillPercent);

    virtual BaseParticle* generateParticle(RNG &random);

    void read(std::istream& is);
 
    MERCURY_DEPRECATED
    void oldRead(std::istream& is);
    
    void write(std::ostream& os) const;
    
    virtual std::string getName() const;

    
    double yMin_, yMax_;

    double radMin_, radMax_;
    double chuteAngle_; 
    
    double hopperAngle_;
    
    double fixedParticleRadius_;
    
    double hopperLength_;
    
    double hopperExitLength_;
    
    double hopperHeight_;
    
    bool isHopperCentred__;

    double fillPercent_;
    
    double lift_;

    int hopperDim_;
    
};

#endif