BaseClusterInsertionBoundary.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 BOUNDARIES_BASECLUSTERINSERTIONBOUNDARY_H
#define BOUNDARIES_BASECLUSTERINSERTIONBOUNDARY_H
 
 
 
#include "InsertionBoundary.h"
#include "BaseCluster.h"
#include "Math/Vector.h"
#include "Math/PSD.h"
 
class BaseParticle;
 
class RNG;
 
class BaseClusterInsertionBoundary : public InsertionBoundary
{
public:
    
    BaseClusterInsertionBoundary();
 
    BaseClusterInsertionBoundary(const BaseClusterInsertionBoundary& other);
 
    ~BaseClusterInsertionBoundary() override;
 
    BaseClusterInsertionBoundary* copy() const override;
 
    void setRandomised(bool randomised);
 
    bool getRandomised();
 
    unsigned int getNumberOfClusterInserted();
 
    void setRadiusMicroParticle(Mdouble rMP);
    
    void setGeometry(Vec3D posMin, Vec3D posMax);
 
    void setVelocityRange(Vec3D velMin, Vec3D velMax);
 
    void setAdditionalClusterProperties(Mdouble collisionTimeOverTimeStep, Mdouble velocityDampingModulus, Mdouble energyRatioTolerance);
 
    void setOutputClusterProperties(bool doCdatOutput, bool doOverlOutput, bool doAmatOutput, bool doIntStrucOutput,
                                    bool doVtkOutput, bool doRestartOutput, bool doFStatOutput, bool doEneOutput);
 
    void placeParticle(BaseParticle* p, RNG& random) override;
 
    void checkBoundaryBeforeTimeStep(DPMBase* md) override;
 
    void read(std::istream& is) override;
 
    void write(std::ostream& os) const override;
 
 
private:
 
    std::string getName() const override;
 
    /*
    * ----------------------------------------------------
    *                    VARIABLES
    * ----------------------------------------------------
    */
 
    // Position in which the cluster will be created and also added in the domain.
    Vec3D position_;
 
 
protected:
 
    //number of cluster inserted
    unsigned int nClusterInserted_;
 
    //Radius of the particle composing the cluster
    Mdouble radiusParticle_;
 
    //Particles
    //\brief Total number of particles.
    int nParticles_;
 
    //species with which the cluster will be created.
    LinearPlasticViscoelasticFrictionSpecies* clusterSpecies_;
 
    // File
    //\brief bool used to define whether or not cluster data output must be created.
    bool isCdatOutputOn_;
    //\brief bool used to define whether or not overlap data output must be created.
    bool isOverlOutputOn_;
    //\brief bool used to define whether or not adjacency matrix output must be created.
    bool isAmatOutputOn_;
    //\brief bool used to define whether or not cluster internal structure output must be created.
    bool isIntStrucOutputOn_;
    //\brief bool used to define whether or not vtk output must be created.
    bool isVtkOutputOn_;
    //\brief bool used to define whether or not restart output must be created.
    bool isRestartOutputOn_;
    //\brief bool used to define whether or not fStat output must be created.
    bool isFStatOutputOn_;
    //\brief bool used to define whether or not eneOutput output must be created.
    bool isEneOutputOn_;
 
 
    //\brief Size dispersity of particles: must be between 0 and 1
    Mdouble sizeDispersityParticle_;
    //\brief Value of damping modulus for velocity.
    Mdouble velocityDampingModulus_;
    // \brief Number of points used for creating internal structure's file.
    int nInternalStructurePoints_;
    // \brief Energy ratio threshold under wich the simulation can be considered static.
    Mdouble energyRatioTolerance_;
 
    //\brief Ratio between collision time and time step: should be at least 50.
    Mdouble collisionTimeOverTimeStep_;
 
    /*
     * \brief Minimal and maximal positions defining the boundary's boundaries,
     * and minimum and maximum velocity of the particles to be inserted.
     */
    Vec3D posMin_, posMax_, velMin_, velMax_;
 
    // Bool defining if the user has set the radius of a single particle composing the cluster OR the number of
    // particles inside the cluster.
    bool setRadiusParticleAndNotNumberOfParticles_;
 
    // Vectors defining cluster radii and position for class FixedClusterInsertionBoundary
     std::vector<Vec3D> clusterPositions_;
     std::vector<Mdouble> clusterRadii_;
 
    //Variable used to switch the randomise() process
    bool randomised_;
};
 
#endif