GGEMSWorld.hh

Go to the documentation of this file.

#ifndef GUARD_GGEMS_NAVIGATORS_GGEMSWORLD_HH
#define GUARD_GGEMS_NAVIGATORS_GGEMSWORLD_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/GGEMSExport.hh"
#include "GGEMS/tools/GGEMSTypes.hh"
 
typedef struct GGEMSWorldRecording_t
{
  cl::Buffer** energy_tracking_; 
  cl::Buffer** energy_squared_tracking_; 
  cl::Buffer** photon_tracking_; 
  cl::Buffer** momentum_x_; 
  cl::Buffer** momentum_y_; 
  cl::Buffer** momentum_z_; 
} GGEMSWorldRecording; 
class GGEMS_EXPORT GGEMSWorld
{
  public:
    GGEMSWorld(void);
 
    ~GGEMSWorld(void);
 
    GGEMSWorld(GGEMSWorld const& world) = delete;
 
    GGEMSWorld& operator=(GGEMSWorld const& world) = delete;
 
    GGEMSWorld(GGEMSWorld const&& world) = delete;
 
    GGEMSWorld& operator=(GGEMSWorld const&& world) = delete;
 
    void SetOutputWorldBasename(std::string const& output_basename);
 
    void SetDimension(GGsize const& dimension_x, GGsize const& dimension_y, GGsize const& dimension_z);
 
    void SetElementSize(GGfloat const& size_x, GGfloat const& size_y, GGfloat const& size_z, std::string const& unit = "mm");
 
    void SetPhotonTracking(bool const& is_activated);
 
    void SetEnergyTracking(bool const& is_activated);
 
    void SetEnergySquaredTracking(bool const& is_activated);
 
    void SetMomentum(bool const& is_activated);
 
    void Initialize(void);
 
    void Tracking(GGsize const& thread_index);
 
    void SaveResults(void) const;
 
    void EnableTracking(void);
 
  private:
    void CheckParameters(void) const;
 
    void InitializeKernel(void);
 
    void SavePhotonTracking(void) const;
 
    void SaveEnergyTracking(void) const;
 
    void SaveEnergySquaredTracking(void) const;
 
    void SaveMomentum(void) const;
 
  private:
    std::string world_output_basename_; 
    GGsize3 dimensions_; 
    GGfloat3 sizes_; 
    bool is_photon_tracking_; 
    bool is_energy_tracking_; 
    bool is_energy_squared_tracking_; 
    bool is_momentum_; 
    std::string tracking_kernel_option_; 
    GGEMSWorldRecording world_recording_; 
    cl::Kernel** kernel_world_tracking_; 
    GGsize number_activated_devices_; 
};
 
extern "C" GGEMS_EXPORT GGEMSWorld* create_ggems_world(void);
 
extern "C" GGEMS_EXPORT void set_dimension_ggems_world(GGEMSWorld* world, GGsize const dimension_x, GGsize const dimension_y, GGsize const dimension_z);
 
extern "C" GGEMS_EXPORT void set_size_ggems_world(GGEMSWorld* world, GGfloat const size_x, GGfloat const size_y, GGfloat const size_z, char const* unit);
 
extern "C" GGEMS_EXPORT void photon_tracking_ggems_world(GGEMSWorld* world, bool const is_activated);
 
extern "C" GGEMS_EXPORT void energy_tracking_ggems_world(GGEMSWorld* world, bool const is_activated);
 
extern "C" GGEMS_EXPORT void energy_squared_tracking_ggems_world(GGEMSWorld* world, bool const is_activated);
 
extern "C" GGEMS_EXPORT void set_output_ggems_world(GGEMSWorld* world, char const* world_output_basename);
 
extern "C" GGEMS_EXPORT void momentum_ggems_world(GGEMSWorld* world, bool const is_activated);
 
#endif // End of GUARD_GGEMS_NAVIGATORS_GGEMSWORLD_HH