GGEMS.hh

Go to the documentation of this file.

#ifndef GUARD_GGEMS_GLOBAL_GGEMS_HH
#define GUARD_GGEMS_GLOBAL_GGEMS_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/>.      *
// *                                                                      *
// ************************************************************************
 
#ifdef _MSC_VER
#pragma warning(disable: 4251) // Deleting warning exporting STL members!!!
#endif
 
#include <cstdint>
#include <string>
#include <vector>
 
#include "GGEMS/global/GGEMSExport.hh"
 
#include "GGEMS/tools/GGEMSTypes.hh"
 
class GGEMS_EXPORT GGEMS
{
  public:
    GGEMS(void);
 
    ~GGEMS(void);
 
    GGEMS(GGEMS const& ggems) = delete;
 
    GGEMS& operator=(GGEMS const& ggems) = delete;
 
    GGEMS(GGEMS const&& ggems) = delete;
 
    GGEMS& operator=(GGEMS const&& ggems) = delete;
 
    void Initialize(GGuint const& seed = 0);
 
    void Run(void);
 
    void SetOpenCLVerbose(bool const& is_opencl_verbose);
 
    void SetMaterialDatabaseVerbose(bool const& is_material_database_verbose);
 
    void SetSourceVerbose(bool const& is_source_verbose);
 
    void SetNavigatorVerbose(bool const& is_navigator_verbose);
 
    void SetMemoryRAMVerbose(bool const& is_memory_ram_verbose);
 
    void SetProcessVerbose(bool const& is_process_verbose);
 
    void SetRangeCutsVerbose(bool const& is_range_cuts_verbose);
 
    void SetRandomVerbose(bool const& is_random_verbose);
 
    void SetProfilingVerbose(bool const& is_profiling_verbose);
 
    inline bool IsProfilingVerbose(void) const {return is_profiling_verbose_;};
 
    void SetTrackingVerbose(bool const& is_tracking_verbose, GGint const& particle_tracking_id);
 
    inline bool IsTrackingVerbose(void) const {return is_tracking_verbose_;};
 
    inline GGint GetParticleTrackingID(void) const {return particle_tracking_id_;};
 
  private:
    void PrintBanner(void) const;
 
    void RunOnDevice(GGsize const& thread_index);
 
  private: // Global simulation parameters
    bool is_opencl_verbose_; 
    bool is_material_database_verbose_; 
    bool is_source_verbose_; 
    bool is_navigator_verbose_; 
    bool is_memory_ram_verbose_; 
    bool is_process_verbose_; 
    bool is_range_cuts_verbose_; 
    bool is_random_verbose_; 
    bool is_tracking_verbose_; 
    bool is_profiling_verbose_; 
    GGint particle_tracking_id_; 
};
 
extern "C" GGEMS_EXPORT GGEMS* create_ggems(void);
 
extern "C" GGEMS_EXPORT void delete_ggems(GGEMS* ggems);
 
extern "C" GGEMS_EXPORT void initialize_ggems(GGEMS* ggems, GGuint const seed);
 
extern "C" GGEMS_EXPORT void set_opencl_verbose_ggems(GGEMS* ggems, bool const is_opencl_verbose);
 
extern "C" GGEMS_EXPORT void set_material_database_verbose_ggems(GGEMS* ggems, bool const is_material_database_verbose);
 
extern "C" GGEMS_EXPORT void set_source_ggems(GGEMS* ggems, bool const is_source_verbose);
 
extern "C" GGEMS_EXPORT void set_navigator_ggems(GGEMS* ggems, bool const is_navigator_verbose);
 
extern "C" GGEMS_EXPORT void set_memory_ram_ggems(GGEMS* ggems, bool const is_memory_ram_verbose);
 
extern "C" GGEMS_EXPORT void set_process_ggems(GGEMS* ggems, bool const is_process_verbose);
 
extern "C" GGEMS_EXPORT void set_range_cuts_ggems(GGEMS* ggems, bool const is_range_cuts_verbose);
 
extern "C" GGEMS_EXPORT void set_random_ggems(GGEMS* ggems, bool const is_random_verbose);
 
extern "C" GGEMS_EXPORT void set_profiling_ggems(GGEMS* ggems, bool const is_profiling_verbose);
 
extern "C" GGEMS_EXPORT void set_tracking_ggems(GGEMS* ggems, bool const is_tracking_verbose, GGint const particle_id_tracking);
 
extern "C" GGEMS_EXPORT void run_ggems(GGEMS* ggems);
 
#endif // End of GUARD_GGEMS_GLOBAL_GGEMS_HH