ChuteWithHopper.h

Go to the documentation of this file.

// This file is part of the MercuryDPM project (https://www.mercurydpm.org).
// Copyright (c), The MercuryDPM Developers Team. All rights reserved.
// License: BSD 3-Clause License; see the LICENSE file in the root directory.
 
#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