GGEMS.hh File Reference

GGEMS class managing the GGEMS simulation. More...

#include <cstdint>
#include <string>
#include <vector>
#include "GGEMS/global/GGEMSExport.hh"
#include "GGEMS/tools/GGEMSTypes.hh"

Include dependency graph for GGEMS.hh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	GGEMS
	GGEMS class managing the complete simulation. More...

Functions
GGEMS *	create_ggems (void)
	Get the GGEMS pointer for python user. More...
void	delete_ggems (GGEMS *ggems)
	Delete GGEMS pointer. More...
void	initialize_ggems (GGEMS *ggems, GGuint const seed)
	Initialize GGEMS simulation. More...
void	set_opencl_verbose_ggems (GGEMS *ggems, bool const is_opencl_verbose)
	Set the OpenCL verbosity. More...
void	set_material_database_verbose_ggems (GGEMS *ggems, bool const is_material_database_verbose)
	Set the material database verbosity. More...
void	set_source_ggems (GGEMS *ggems, bool const is_source_verbose)
	Set the source verbosity. More...
void	set_navigator_ggems (GGEMS *ggems, bool const is_navigator_verbose)
	Set the navigator verbosity. More...
void	set_memory_ram_ggems (GGEMS *ggems, bool const is_memory_ram_verbose)
	Set the memory RAM verbosity. More...
void	set_process_ggems (GGEMS *ggems, bool const is_process_verbose)
	Set the processes verbosity. More...
void	set_range_cuts_ggems (GGEMS *ggems, bool const is_range_cuts_verbose)
	Set the range cuts verbosity. More...
void	set_random_ggems (GGEMS *ggems, bool const is_random_verbose)
	Set the random verbosity. More...
void	set_profiling_ggems (GGEMS *ggems, bool const is_profiling_verbose)
	Set the profiling verbosity. More...
void	set_tracking_ggems (GGEMS *ggems, bool const is_tracking_verbose, GGint const particle_id_tracking)
	Set the tracking verbosity. More...
void	run_ggems (GGEMS *ggems)
	Run the GGEMS simulation. More...

Detailed Description

GGEMS class managing the GGEMS simulation.

Author

Julien BERT julie.nosp@m.n.be.nosp@m.rt@un.nosp@m.iv-b.nosp@m.rest..nosp@m.fr

Didier BENOIT didie.nosp@m.r.be.nosp@m.noit@.nosp@m.inse.nosp@m.rm.fr

LaTIM, INSERM - U1101, Brest, FRANCE

Version

1.0

Date

Monday September 30, 2019

Definition in file GGEMS.hh.

Function Documentation

create_ggems()

GGEMS * create_ggems

(

void

)

Get the GGEMS pointer for python user.

Returns

the pointer to GGEMS

Definition at line 365 of file GGEMS.cc.

delete_ggems()

GGEMSBox * delete_ggems

(

GGEMS *

ggems

)

Delete GGEMS pointer.

Parameters

ggems

- pointer on ggems

Definition at line 374 of file GGEMS.cc.

initialize_ggems()

void initialize_ggems	(	GGEMS *	ggems,
		GGuint const	seed
	)

Initialize GGEMS simulation.

Parameters

ggems	- pointer to GGEMS
seed	- seed of the random

Definition at line 386 of file GGEMS.cc.

run_ggems()

void run_ggems

(

GGEMS *

ggems

)

Run the GGEMS simulation.

Parameters

ggems

- pointer to GGEMS

Definition at line 485 of file GGEMS.cc.

set_material_database_verbose_ggems()

void set_material_database_verbose_ggems	(	GGEMS *	ggems,
		bool const	is_material_database_verbose
	)

Set the material database verbosity.

Parameters

ggems	- pointer to GGEMS
is_material_database_verbose	- flag on material database verbose

Definition at line 404 of file GGEMS.cc.

set_memory_ram_ggems()

void set_memory_ram_ggems	(	GGEMS *	ggems,
		bool const	is_memory_ram_verbose
	)

Set the memory RAM verbosity.

Parameters

ggems	- pointer to GGEMS
is_memory_ram_verbose	- flag on memory RAM verbose

Definition at line 431 of file GGEMS.cc.

set_navigator_ggems()

void set_navigator_ggems	(	GGEMS *	ggems,
		bool const	is_navigator_verbose
	)

Set the navigator verbosity.

Parameters

ggems	- pointer to GGEMS
is_navigator_verbose	- flag on navigator verbose

Definition at line 422 of file GGEMS.cc.

set_opencl_verbose_ggems()

void set_opencl_verbose_ggems	(	GGEMS *	ggems,
		bool const	is_opencl_verbose
	)

Set the OpenCL verbosity.

Parameters

ggems	- pointer to GGEMS
is_opencl_verbose	- flag on opencl verbose

Definition at line 395 of file GGEMS.cc.

set_process_ggems()

void set_process_ggems	(	GGEMS *	ggems,
		bool const	is_process_verbose
	)

Set the processes verbosity.

Parameters

ggems	- pointer to GGEMS
is_process_verbose	- flag on processes verbose

Definition at line 440 of file GGEMS.cc.

set_profiling_ggems()

void set_profiling_ggems	(	GGEMS *	ggems,
		bool const	is_profiling_verbose
	)

Set the profiling verbosity.

Parameters

ggems	- pointer to GGEMS
is_profiling_verbose	- flag on profiling verbose

Definition at line 467 of file GGEMS.cc.

set_random_ggems()

void set_random_ggems	(	GGEMS *	ggems,
		bool const	is_random_verbose
	)

Set the random verbosity.

Parameters

ggems	- pointer to GGEMS
is_random_verbose	- flag on random verbose

Definition at line 458 of file GGEMS.cc.

set_range_cuts_ggems()

void set_range_cuts_ggems	(	GGEMS *	ggems,
		bool const	is_range_cuts_verbose
	)

Set the range cuts verbosity.

Parameters

ggems	- pointer to GGEMS
is_range_cuts_verbose	- flag on range cuts verbose

Definition at line 449 of file GGEMS.cc.

set_source_ggems()

void set_source_ggems	(	GGEMS *	ggems,
		bool const	is_source_verbose
	)

Set the source verbosity.

Parameters

ggems	- pointer to GGEMS
is_source_verbose	- flag on source verbose

Definition at line 413 of file GGEMS.cc.

set_tracking_ggems()

void set_tracking_ggems	(	GGEMS *	ggems,
		bool const	is_tracking_verbose,
		GGint const	particle_id_tracking
	)

Set the tracking verbosity.

Parameters

ggems	- pointer to GGEMS
is_tracking_verbose	- flag on tracking verbose
particle_id_tracking	- particle id for tracking

Definition at line 476 of file GGEMS.cc.