HGrid.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 HGRID_H
#define HGRID_H
 
#include <vector>
#include "Math/ExtendedMath.h"
#include "Particles/HGridCell.h"
 
class BaseParticle;
 
class HGrid
{
public:
    HGrid();
    
    HGrid(unsigned int num_buckets, double cellOverSizeRatio, std::vector<double>& cellSizes);
    
    ~HGrid();
    
    void insertParticleToHgrid(BaseParticle* obj);
    
    inline unsigned int computeHashBucketIndex(int x, int y, int z, unsigned int l) const
    {
        static const unsigned int h1 = 0x8da6b343u; // Large multiplicative constants;
        static const unsigned int h2 = 0xd8163841u; // here arbitrarily chosen primes
        static const unsigned int h3 = 0xcb1ab31fu;
        static const unsigned int h4 = 0x165667b1u;
        
        return (h1 * x + h2 * y + h3 * z + h4 * l) % numberOfBuckets_;
    }
    
    inline unsigned int computeHashBucketIndex(HGridCell hGridCell) const
    {
        return computeHashBucketIndex(hGridCell.getHGridX(),
                                      hGridCell.getHGridY(),
                                      hGridCell.getHGridZ(),
                                      hGridCell.getHGridLevel());
    }
    
    unsigned int computeHashBucketIndex(int x, int y, unsigned int l) const;
    
    void clearBucketIsChecked();
    
    void clearFirstBaseParticleInBucket();
    
    void setFirstBaseParticleInBucket(unsigned int i, BaseParticle* p)
    { firstBaseParticleInBucket_[i] = p; }
    
    void setBucketIsChecked(unsigned int i)
    { bucketIsChecked_[i] = true; }
    
    bool getBucketIsChecked(unsigned int i) const
    { return bucketIsChecked_[i]; }
    
    Mdouble getCellOverSizeRatio() const
    { return cellOverSizeRatio_; }
    
    double getCellSize(unsigned int i) const
    { return cellSizes_[i]; }
    
    const std::vector<double>& getCellSizes() const
    { return cellSizes_; }
    
    const BaseParticle* getFirstBaseParticleInBucket(unsigned int i) const
    { return firstBaseParticleInBucket_[i]; }
    
    BaseParticle* getFirstBaseParticleInBucket(unsigned int i)
    { return firstBaseParticleInBucket_[i]; }
    
    double getInvCellSize(unsigned int i) const
    { return invCellSizes_[i]; }
    
    const std::vector<double>& getInvCellSizes() const
    { return invCellSizes_; }
    
    bool getNeedsRebuilding() const
    { return needsRebuilding_; }
    
    unsigned int getNumberOfBuckets() const
    { return numberOfBuckets_; }
    
    unsigned long getNumberOfLevels() const
    { return cellSizes_.size(); }
    
    int getOccupiedLevelsMask() const
    { return occupiedLevelsMask_; }
    
    void info() const;
 
private:
    bool needsRebuilding_;
    
    unsigned int numberOfBuckets_;
    
    Mdouble cellOverSizeRatio_;
    
    int occupiedLevelsMask_;
    
    std::vector<double> cellSizes_;
    
    std::vector<double> invCellSizes_;
    
    std::vector<BaseParticle*> firstBaseParticleInBucket_;
    
    std::vector<bool> bucketIsChecked_;
};
 
#endif