ChuteWithHopper.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 CHUTEWITHHOPPER_H
#define CHUTEWITHHOPPER_H
 
#include "Chute.h"
 
class ChuteWithHopper : public Chute
{
public:
 
//Constructors:
    explicit ChuteWithHopper(const Chute& other);
    
    explicit ChuteWithHopper(const Mercury3D& other);
    
    explicit ChuteWithHopper(const MercuryBase& other);
    
    explicit ChuteWithHopper(const DPMBase& other);
    
    ChuteWithHopper();
 
//Setters and getters:
    
    void setHopperFillingPercentage(Mdouble hopperFillingPercentage);
    
    void setHopperLowestPoint(Mdouble hopperLowestPoint);
    
    Mdouble getHopperLowestPoint() const;
    
    Mdouble getChuteLength() const;
    
    void setChuteLength(Mdouble chuteLength) override;
    
    void setIsHopperCentred(bool isHopperCentred);
    
    void setHopperLowerFillingHeight(Mdouble hopperLowerFillingHeight);
    
    void setHopperShift(Mdouble hopperShift);
    
    void setHopperLift(Mdouble hopperLift);
    
    Mdouble getHopperLift() const;
    
    Mdouble getHopperShift() const;
    
    void setHopperDimension(unsigned int hopperDimension);
    
    void setIsHopperAlignedWithBottom(bool isHopperAlignedWithBottom);
    
    Mdouble getHopperAngle() const;
    
    Mdouble getHopperLength() const;
    
    Mdouble getHopperExitLength() const;
    
    Mdouble getHopperHeight() const;
    
    Mdouble getHopperExitHeight() const;
    
    bool getIsHopperCentred() const;
    
    Mdouble getHopperFillingPercentage() const;
    
    unsigned int getHopperDimension() const;
 
//Other member functions:
    
    void setupInitialConditions() override;
    
    void setHopper(Mdouble exitLength, Mdouble exitHeight, Mdouble angle, Mdouble length, Mdouble height);
    
    Mdouble getMaximumVelocityInducedByGravity() const;
    
    Mdouble getTimeStepRatio() const;
    
    void read(std::istream& is, ReadOptions opt = ReadOptions::ReadAll) override;
    
    void write(std::ostream& os, bool writeAllParticles = true) const override;
    
    bool readNextArgument(int& i, int argc, char* argv[]) override;
 
protected:
    void addHopper();
 
private:
    
    void constructor();
 
//protected:
    Mdouble hopperLength_;
    Mdouble hopperHeight_;
    Mdouble hopperAngle_;
    Mdouble hopperExitLength_;
    Mdouble hopperExitHeight_;
    Mdouble hopperShift_;
    Mdouble hopperLowerFillingHeight_;
    bool isHopperCentred_;
    
    Mdouble hopperLift_;
    unsigned int hopperDimension_;
    bool isHopperAlignedWithBottom_;
    Mdouble hopperFillingPercentage_;
    Mdouble hopperLowestPoint_;
};
 
#endif