GGEMSSource.hh

Go to the documentation of this file.

#ifndef GUARD_GGEMS_SOURCES_GGEMSSOURCE_HH
#define GUARD_GGEMS_SOURCES_GGEMSSOURCE_HH
 
// ************************************************************************
// * This file is part of GGEMS.                                          *
// *                                                                      *
// * GGEMS is free software: you can redistribute it and/or modify        *
// * it under the terms of the GNU General Public License as published by *
// * the Free Software Foundation, either version 3 of the License, or    *
// * (at your option) any later version.                                  *
// *                                                                      *
// * GGEMS is distributed in the hope that it will be useful,             *
// * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
// * GNU General Public License for more details.                         *
// *                                                                      *
// * You should have received a copy of the GNU General Public License    *
// * along with GGEMS.  If not, see <https://www.gnu.org/licenses/>.      *
// *                                                                      *
// ************************************************************************
 
#include "GGEMS/global/GGEMSOpenCLManager.hh"
 
class GGEMSParticles;
class GGEMSPseudoRandomGenerator;
class GGEMSGeometryTransformation;
 
class GGEMS_EXPORT GGEMSSource
{
  public:
    explicit GGEMSSource(std::string const& source_name);
 
    virtual ~GGEMSSource(void);
 
    GGEMSSource(GGEMSSource const& source) = delete;
 
    GGEMSSource& operator=(GGEMSSource const& source) = delete;
 
    GGEMSSource(GGEMSSource const&& source) = delete;
 
    GGEMSSource& operator=(GGEMSSource const&& source) = delete;
 
    inline std::string GetNameOfSource(void) const {return source_name_;}
 
    void SetPosition(GGfloat const& pos_x, GGfloat const& pos_y, GGfloat const& pos_z, std::string const& unit = "mm");
 
    void SetSourceParticleType(std::string const& particle_type);
 
    void SetRotation(GGfloat const& rx, GGfloat const& ry, GGfloat const& rz, std::string const& unit = "deg");
 
    void SetNumberOfParticles(GGsize const& number_of_particles);
 
    void EnableTracking(void);
 
    inline GGsize GetNumberOfBatchs(GGsize const& device_index) const {return number_of_batchs_[device_index];}
 
    inline GGsize GetNumberOfParticlesInBatch(GGsize const& device_index, GGsize const& batch_index) {return number_of_particles_in_batch_[device_index][batch_index];}
 
    virtual void CheckParameters(void) const;
 
    virtual void Initialize(bool const& is_tracking = false);
 
    virtual void GetPrimaries(GGsize const& thread_index, GGsize const& number_of_particles) = 0;
 
    virtual void PrintInfos(void) const = 0;
 
  protected:
    virtual void InitializeKernel(void) = 0;
 
  private:
    void OrganizeParticlesInBatch(void);
 
  protected:
    std::string source_name_; 
    GGsize number_of_particles_; 
    GGsize* number_of_particles_by_device_; 
    GGsize** number_of_particles_in_batch_; 
    GGsize* number_of_batchs_; 
    GGchar particle_type_; 
    std::string tracking_kernel_option_; 
    GGEMSGeometryTransformation* geometry_transformation_; 
    cl::Kernel** kernel_get_primaries_; 
    GGsize number_activated_devices_; 
};
 
#endif // End of GUARD_GGEMS_SOURCES_GGEMSSOURCE_HH