HGrid.h

Go to the documentation of this file.

//Copyright (c) 2013-2014, 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"

class BaseParticle;

class HGrid
{
public:
    HGrid();

    HGrid(unsigned int num_buckets, double cellOverSizeRatio, std::vector<double>& cellSizes);

    ~HGrid();

    void Initialize_inv_size();

    void insertParticleToHgrid(BaseParticle* obj);

    unsigned int computeHashBucketIndex(int x, int y, int z, unsigned int l) const;

    unsigned int computeHashBucketIndex(int x, int y, unsigned int l) const;

    void clearBucketIsChecked();
    
    void clearFirstBaseParticleInBucket();

    void setFirstBaseParticleInBucket(unsigned int i, BaseParticle* p);

    void setBucketIsChecked(unsigned int i);

    bool getBucketIsChecked(unsigned int i) const;

    Mdouble getCellOverSizeRatio() const;

    double getCellSize(unsigned int i) const;

    const std::vector<double>& getCellSizes() const;

    const BaseParticle* getFirstBaseParticleInBucket(unsigned int i) const;

    BaseParticle* getFirstBaseParticleInBucket(unsigned int i);

    double getInvCellSize(unsigned int i) const;

    const std::vector<double>& getInvCellSizes() const;

    bool getNeedsRebuilding() const;

    unsigned int getNumberOfBuckets() const;

    unsigned int getNumberOfLevels() const;

    int getOccupiedLevelsMask() const;

    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