CudaByteLattice.h

Go to the documentation of this file.

/*
 * University of Illinois Open Source License
 * Copyright 2008-2018 Luthey-Schulten Group,
 * All rights reserved.
 * 
 * Developed by: Luthey-Schulten Group
 *               University of Illinois at Urbana-Champaign
 *               http://www.scs.uiuc.edu/~schulten
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the Software), to deal with 
 * the Software without restriction, including without limitation the rights to 
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
 * of the Software, and to permit persons to whom the Software is furnished to 
 * do so, subject to the following conditions:
 * 
 * - Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimers.
 * 
 * - Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimers in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * - Neither the names of the Luthey-Schulten Group, University of Illinois at
 * Urbana-Champaign, nor the names of its contributors may be used to endorse or
 * promote products derived from this Software without specific prior written
 * permission.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL 
 * THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 
 * OTHER DEALINGS WITH THE SOFTWARE.
 *
 * Author(s): Elijah Roberts
 */
 
#ifndef LM_RDME_CUDABYTELATTICE_H_
#define LM_RDME_CUDABYTELATTICE_H_
 
#include <vector>
#include <map>
#include "core/Exceptions.h"
#include "cuda/lm_cuda.h"
#include "rdme/ByteLattice.h"
#include "rdme/Lattice.h"
 
namespace lm {
namespace rdme {
 
class CudaByteLattice : public ByteLattice
{
public:
    CudaByteLattice(lattice_coord_t size, si_dist_t spacing, uint particlesPerSite);
    CudaByteLattice(lattice_size_t xSize, lattice_size_t ySize, lattice_size_t zSize, si_dist_t spacing, uint particlesPerSite);
    virtual ~CudaByteLattice();
    
    virtual void copyToGPU();
    virtual void copyFromGPU();
    virtual void * getGPUMemorySrc();
    virtual void * getGPUMemoryDest();
    virtual void swapSrcDest();
    virtual void * getGPUMemorySiteTypes();
    virtual size_t getParticleMemorySize() const {return cudaParticlesSize;}
 
    // Override methods that can cause the GPU memory to become stale.
    virtual void setSiteType(lattice_size_t x, lattice_size_t y, lattice_size_t z, site_t site);
    virtual void setSiteType(lattice_size_t index, site_t site);
    virtual void addParticle(lattice_size_t x, lattice_size_t y, lattice_size_t z, particle_t particle);
    virtual void addParticle(lattice_size_t index, particle_t particle);
    virtual void removeParticles(lattice_size_t x,lattice_size_t y,lattice_size_t z);
    virtual void removeParticles(lattice_size_t index);
    virtual void removeAllParticles();
 
    // Methods to set the data directly.
    virtual void setFromRowMajorByteData(void * buffer, size_t bufferSize);
 
    virtual void getSiteLatticeView(uint8_t **siteLattice, int *Nz, int *Ny, int *Nx);
    virtual void getParticleLatticeView(uint8_t **particleLattice, int *Nw, int *Nz, int *Ny, int *Nx, int *Np);
    
protected:
    virtual void allocateCudaMemory();
    virtual void deallocateCudaMemory();
    
protected:
    uint cudaParticlesCurrent;
    size_t cudaParticlesSize;
    void * cudaParticles[2];
    size_t cudaSiteTypesSize;
    void * cudaSiteTypes;
    bool isGPUMemorySynched;
};
 
}
}
 
#endif