Chute.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 CHUTE_H
#define CHUTE_H
 
#include "Mercury3D.h"
 
class InsertionBoundary;
 
 
enum RoughBottomType
{
    MONOLAYER_ORDERED, MONOLAYER_DISORDERED, MULTILAYER, FLAT, MONOLAYER_TRIANGULAR
};
 
class Chute : public Mercury3D
{
public:
    Chute();
    
    explicit Chute(const DPMBase& other);
    
    explicit Chute(const MercuryBase& other);
    
    explicit Chute(const Mercury3D& other);
    
    Chute(const Chute& other);
    
    void constructor();
    
    bool readNextArgument(int& i, int argc, char* argv[]) override;
    
    void setupSideWalls();
    
    void makeChutePeriodic();
    
    bool getIsPeriodic() const;
    
    void setupInitialConditions() override;
    
    void read(std::istream& is, ReadOptions opt = ReadOptions::ReadAll) override;
    
    void write(std::ostream& os, bool writeAllParticles = true) const override;
 
//setters and getters
    
    void setFixedParticleRadius(Mdouble fixedParticleRadius);
    
    Mdouble getFixedParticleRadius() const;
 
    void setFixedParticleSpacing(Mdouble fixedParticleSpacing);
 
    Mdouble getFixedParticleSpacing() const;
 
    void setRoughBottomType(RoughBottomType roughBottomType);
    
    void setRoughBottomType(std::string roughBottomTypeString);
    
    RoughBottomType getRoughBottomType() const;
    
    void setChuteAngle(Mdouble chuteAngle);
    
    void setChuteAngleAndMagnitudeOfGravity(Mdouble chuteAngle, Mdouble gravity);
    
    //void setChuteAngle(Mdouble new_, Mdouble gravity){if (new_>=0.0&&new_<=90.0) {ChuteAngle = new_; setGravity(Vec3D(sin(ChuteAngle*pi/180.0), 0.0, -cos(ChuteAngle*pi/180.0))*gravity);} else std::cerr << "WARNING : Chute angle must be within [0,90]" << std::endl;}
    
    Mdouble getChuteAngle() const;
    
    Mdouble getChuteAngleDegrees() const;
    
    void setMaxFailed(unsigned int maxFailed);
    
    unsigned int getMaxFailed() const;
    
    void setInflowParticleRadius(Mdouble inflowParticleRadius);
    
    void setInflowParticleRadius(Mdouble minInflowParticleRadius, Mdouble maxInflowParticleRadius);
    
    void setMinInflowParticleRadius(Mdouble minInflowParticleRadius);
    
    void setMaxInflowParticleRadius(Mdouble maxInflowParticleRadius);
    
    Mdouble getInflowParticleRadius() const;
    
    Mdouble getMinInflowParticleRadius() const;
    
    Mdouble getMaxInflowParticleRadius() const;
    
    void setInflowHeight(Mdouble inflowHeight);
    
    Mdouble getInflowHeight() const;
    
    void setInflowVelocity(Mdouble inflowVelocity);
    
    Mdouble getInflowVelocity() const;
    
    void setInflowVelocityVariance(Mdouble inflowVelocityVariance);
    
    Mdouble getInflowVelocityVariance() const;
    
    void setChuteWidth(Mdouble chuteWidth);
    
    Mdouble getChuteWidth() const;
    
    virtual void setChuteLength(Mdouble chuteLength);
    
    Mdouble getChuteLength() const;
    
    void setInsertionBoundary(InsertionBoundary* insertionBoundary);
 
protected:
    void actionsBeforeTimeStep() override;
    
    void cleanChute();
    
    virtual void createBottom();
    
    virtual void addFlowParticlesCompactly();
    
    virtual SphericalParticle createFlowParticle();
    
    void printTime() const override;
 
private:
    
    Mdouble chuteAngle_;
    Mdouble fixedParticleRadius_;
    Mdouble fixedParticleSpacing_;
    Mdouble minInflowParticleRadius_;
    Mdouble maxInflowParticleRadius_;
    Mdouble inflowVelocity_;
    Mdouble inflowVelocityVariance_;
    Mdouble inflowHeight_;
    RoughBottomType roughBottomType_;
    unsigned int maxFailed_;
    InsertionBoundary* insertionBoundary_;
    bool isChutePeriodic_;
    
};
 
#endif