MercuryBase.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 MERCURYBASE_H
#define MERCURYBASE_H
 
#include <iostream>
 
#include "DPMBase.h"
#include "HGrid.h"
 
enum HGridMethod
{
    BOTTOMUP, TOPDOWN
};
 
inline std::ostream& operator<<(std::ostream& os, HGridMethod h)
{
    if (h == BOTTOMUP)
        return os << "BOTTOMUP";
    else
        return os << "TOPDOWN";
}
 
inline std::istream& operator>>(std::istream& is, HGridMethod& h)
{
    std::string s;
    is >> s;
    if (s == "BOTTOMUP")
        h = BOTTOMUP;
    else if (s == "TOPDOWN")
        h = TOPDOWN;
    else
    {
        logger(ERROR, "HGridMethod could not be read: %", s);
    }
    return is;
}
 
enum HGridDistribution
{
    OLDHGRID, LINEAR, EXPONENTIAL, USER
};
 
inline std::ostream& operator<<(std::ostream& os, HGridDistribution h)
{
    if (h == OLDHGRID)
        return os << "OLDHGRID";
    else if (h == LINEAR)
        return os << "LINEAR";
    else if (h == EXPONENTIAL)
        return os << "EXPONENTIAL";
    else
        return os << "USER";
}
 
inline std::istream& operator>>(std::istream& is, HGridDistribution& h)
{
    std::string s;
    is >> s;
    if (s == "OLDHGRID")
        h = OLDHGRID;
    else if (s == "LINEAR")
        h = LINEAR;
    else if (s == "EXPONENTIAL")
        h = EXPONENTIAL;
    else if (s == "USER")
        h = USER;
    else
    {
        logger(ERROR,"HGridDistribution could not be read: %",s);
    }
    return is;
}
 
class MercuryBase : public virtual DPMBase
{
public:
    MercuryBase();
    
    ~MercuryBase() override;
    
    MercuryBase(const MercuryBase& mercuryBase);
    
    void constructor();
    
    void hGridActionsBeforeTimeLoop() override;
    
    void hGridActionsBeforeTimeStep() override;
    
    void read(std::istream& is, ReadOptions opt = ReadOptions::ReadAll) override;
    
    void write(std::ostream& os, bool writeAllParticles = true) const override;
    
    Mdouble getHGridCurrentMaxRelativeDisplacement() const;
    
    Mdouble getHGridTotalCurrentMaxRelativeDisplacement() const;
    
    void setHGridUpdateEachTimeStep(bool updateEachTimeStep);
    
    bool getHGridUpdateEachTimeStep() const final;
    
    void setHGridMaxLevels(unsigned int HGridMaxLevels);
    
    unsigned int getHGridMaxLevels() const;
    
    HGridMethod getHGridMethod() const
    { return hGridMethod_; }
    
    void setHGridMethod(HGridMethod hGridMethod);
    
    HGridDistribution getHGridDistribution() const;
    
    void setHGridDistribution(HGridDistribution hGridDistribution);
    
    Mdouble getHGridCellOverSizeRatio() const;
    
    void setHGridCellOverSizeRatio(Mdouble cellOverSizeRatio);
    
    bool hGridNeedsRebuilding();
    
    virtual unsigned int getHGridTargetNumberOfBuckets() const;
    
    virtual Mdouble getHGridTargetMinInteractionRadius() const;
    
    virtual Mdouble getHGridTargetMaxInteractionRadius() const;
    
    bool checkParticleForInteraction(const BaseParticle& P) final;
    
    bool checkParticleForInteractionLocal(const BaseParticle& P) final;
    
    virtual Mdouble userHGridCellSize(unsigned int level);
    
    virtual std::vector<BaseParticle*> hGridFindParticleContacts(const BaseParticle* obj)=0;
 
protected:
    
    void hGridRebuild();
    
    void hGridInsertParticle(BaseParticle* obj) final;
    
    virtual bool hGridHasParticleContacts(const BaseParticle* obj)=0;
    
    void hGridUpdateMove(BaseParticle* iP, Mdouble move) final;
    
    void hGridActionsBeforeIntegration() override;
    
    void hGridActionsAfterIntegration() override;
    
    HGrid* getHGrid()
    { return grid; }
    
    const HGrid* getHGrid() const
    { return grid; }
    
    bool readNextArgument(int& i, int argc, char* argv[]) override;
 
public:
    void hGridInfo(std::ostream& os = std::cout) const;
 
private:
    HGrid* grid;
    
    HGridMethod hGridMethod_;
    
    HGridDistribution hGridDistribution_;
    
    Mdouble currentMaxRelativeDisplacement_;
    
    Mdouble totalCurrentMaxRelativeDisplacement_;
    
    bool gridNeedsUpdate_;
    
    bool updateEachTimeStep_;
    
    unsigned int hGridMaxLevels_;
    Mdouble hGridCellOverSizeRatio_;
};
 
#endif