CylinderInsertionBoundary.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 BOUNDARIES_CYLINDERINSERTIONBOUNDARY_H
#define BOUNDARIES_CYLINDERINSERTIONBOUNDARY_H
 
#include "InsertionBoundary.h"
#include "Math/Vector.h"
 
class BaseParticle;
 
class RNG;
 
class CylinderInsertionBoundary : public InsertionBoundary
{
public:
 
    CylinderInsertionBoundary();
 
    CylinderInsertionBoundary(const CylinderInsertionBoundary &other);
 
    ~CylinderInsertionBoundary() override;
 
    CylinderInsertionBoundary *copy() const override;
 
    void set(BaseParticle *particleToCopy, unsigned int maxFailed, Mdouble rMin, Mdouble rMax, Mdouble hMin, Mdouble hMax,
             Vec3D normal = {0, 0, 1}, Mdouble thetaMin = -constants::pi, Mdouble thetaMax = constants::pi, Vec3D velMin = {0, 0, 0}, Vec3D velMax = {0, 0, 0});
 
    void
    set(BaseParticle &particleToCopy, unsigned int maxFailed, Mdouble rMin, Mdouble rMax, Mdouble hMin, Mdouble hMax,
        Vec3D normal = {0, 0, 1}, Mdouble thetaMin = -constants::pi, Mdouble thetaMax = constants::pi, Vec3D velMin = {0, 0, 0}, Vec3D velMax = {0, 0, 0});
 
    void
    set(std::vector<BaseParticle*> particleToCopy, unsigned int maxFailed, Mdouble rMin,
        Mdouble rMax, Mdouble hMin, Mdouble hMax, Vec3D normal = {0, 0, 1}, Mdouble thetaMin = -constants::pi, Mdouble thetaMax = constants::pi, Vec3D velMin = {0, 0, 0},
        Vec3D velMax = {0,0,0});
 
    void set(BaseParticle* particleToCopy, unsigned int maxFailed, Mdouble radMin,
             Mdouble radMax, Mdouble hMin, Mdouble hMax, Vec3D normal, Mdouble thetaMin, Mdouble thetaMax, Vec3D velMin, Vec3D velMax,
             Mdouble particleRMin, Mdouble particleRMax);
 
    void set(BaseParticle& particleToCopy, unsigned int maxFailed, Mdouble radMin, Mdouble radMax, Mdouble hMin,
             Mdouble hMax, Vec3D normal, Mdouble thetaMin, Mdouble thetaMax, Vec3D velMin, Vec3D velMax, Mdouble particleRMin,
             Mdouble particleRMax);
    
    void setGeometry(Mdouble rMin, Mdouble rMax, Mdouble hMin, Mdouble hMax, Mdouble thetaMin, Mdouble thetaMax, Vec3D normal);
 
    void setOrientation(Vec3D normal);
 
    Matrix3D getRotationMatrixX(Mdouble rotationAngle);
 
    Matrix3D getRotationMatrixY(Mdouble rotationAngle);
 
    Matrix3D getRotationMatrixZ(Mdouble rotationAngle);
 
    Vec3D getOrigin() const;
 
    Matrix3D getOrientationMatrix() const;
 
    void shiftBoundary(Vec3D shift) override;
 
    void rotateBoundary(Vec3D angle) override;
 
    void placeParticle(BaseParticle* p, RNG& random) override;
    
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
 
 
private:
    
    std::string getName() const override;
 
protected:
 
    Mdouble thetaMin_, thetaMax_;
 
    Mdouble radMin_, radMax_;
 
    Mdouble hMin_, hMax_;
 
    Matrix3D orientationMatrix_;
 
    Vec3D origin_;
};
 
#endif