HorizontalScrew.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 HorizontalScrew_H
#define HorizontalScrew_H
 
#include "Walls/BaseWall.h"
#include "Math/Vector.h"
 
class HorizontalScrew : public BaseWall
{
public:
    
    HorizontalScrew();
    
    HorizontalScrew(const HorizontalScrew& other);
 
    HorizontalScrew(Vec3D start, Mdouble l, Mdouble minR, Mdouble lowerR, Mdouble diffR, Mdouble n, Mdouble omega, Mdouble thickness, const ParticleSpecies* s);
 
    ~HorizontalScrew();
 
    HorizontalScrew* copy() const final;
 
    bool getDistanceAndNormal(const BaseParticle& P, Mdouble& distance, Vec3D& normal_return) const final;
 
    Mdouble getLength() const;
 
    Vec3D getStart() const;
 
    void move_time(Mdouble dt);
 
    void read(std::istream& is) override;
 
    void write(std::ostream& os) const override;
 
    std::string getName() const final;
 
    void writeVTK (VTKContainer& vtk) const override;
 
    void setBlades(const Mdouble bladeWidth, const Mdouble bladeLength,const std::vector<Mdouble> bladeMounts);
 
private:
    Vec3D start_;
    Mdouble l_;
    Mdouble minR_;   // min max radius
    Mdouble lowerR_; // max Radius at the base
    Mdouble diffR_; // max radius at the top
    Mdouble n_;
    Mdouble omega_;
    Mdouble offset_;
    Mdouble thickness_;
    Mdouble bladeWidth_;
    Mdouble bladeLength_;
    std::vector<Mdouble> bladeMounts_;
};
 
#endif