HGRID_2D.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_2D_H
#define HGrid_2D_H

#include "HGRID_base.h"
#include <iostream>

class HGRID_2D : public HGRID_base
    {
public:

    HGRID_2D()
    {
        constructor();
        #ifdef CONSTUCTOR_OUTPUT
            std::cerr << "HGRID_2D() finished"<<std::endl;
        #endif
    }
    
    //The copy-constructor of MD has to be called because the link from MD to HGRID_base is virtual
    HGRID_2D(MD& other) : MD(other), HGRID_base(other)
    {
        constructor();
        #ifdef CONSTUCTOR_OUTPUT
            std::cerr << "HGRID_2D(MD& other) finished" << std::endl;
        #endif
    }
    HGRID_2D(HGRID_base& other) : MD(other), HGRID_base(other)
    {
        constructor();
        #ifdef CONSTUCTOR_OUTPUT
            std::cerr << "HGRID_2D(HGRID_base& other) finished" << std::endl;
        #endif
    }
    
    void constructor() {}

protected:

    void HGRID_UpdateParticleInHgrid  (BaseParticle *obj);
    void HGRID_RemoveParticleFromHgrid(BaseParticle *obj);

    virtual void CheckCell(int x, int y, int l, BaseParticle *obj, HGrid *grid);

    virtual void CheckCell_current(int x, int y, int l, HGrid *grid);

    void CheckObjAgainstGrid(HGrid *grid, BaseParticle *obj);
        
    void CheckObjAgainstWholeGrid(HGrid *grid, BaseParticle *obj);

    bool TestCell(int x, int y, int l, BaseParticle *obj, HGrid *grid);

    bool TestObjAgainstGrid(HGrid *grid, BaseParticle *obj);

#ifdef ContactListHgrid 
    void InsertCell(int x, int y, int l, Particle *obj, HGrid *grid);
    void InsertObjAgainstGrid(HGrid *grid, Particle *obj);
#endif
    };
//end class defintion

#endif