Screw.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 SCREW_H
#define SCREW_H
 
#include "BaseWall.h"
#include "Math/Vector.h"
 
enum class ScrewType {singleHelix = 1, doubleHelix = 2};
 
class Screw : public BaseWall
{
public:
    
    Screw();
    
    Screw(const Screw& other);
    
    Screw(Vec3D start, Mdouble l, Mdouble r, Mdouble n, Mdouble omega, Mdouble thickness, ScrewType screwType = ScrewType::doubleHelix);
    
    ~Screw() override;
    
    Screw* copy() const final;
    
    bool getDistanceAndNormal(const BaseParticle& P, Mdouble& distance, Vec3D& normal_return) const final;
    
    bool getDistanceAndNormalLabCoordinates(Vec3D position, Mdouble wallInteractionRadius, Mdouble& distance,
                                            Vec3D& normal_return) const;
    
    void move_time(Mdouble dt);
    
    //MERCURYDPM_DEPRECATED
    void rotate(const Vec3D& angularVelocityDt) override;
    
    void read(std::istream& is) override;
    
    void oldRead(std::istream& is);
    
    void write(std::ostream& os) const override;
    
    std::string getName() const final;
    
    void writeVTK(VTKContainer& vtk) const override;
    
    void writeVTK(std::string filename) const;
 
private:
    Vec3D start_;
    Mdouble l_;
    Mdouble maxR_;
    Mdouble n_;
    Mdouble omega_;
    Mdouble offset_;
    Mdouble thickness_;
    ScrewType screwType_;
};
 
#endif