GGEMSWorld.hh File Reference

GGEMS class handling global world (space between navigators) in GGEMS. More...

#include "GGEMS/global/GGEMSExport.hh"
#include "GGEMS/tools/GGEMSTypes.hh"

Include dependency graph for GGEMSWorld.hh:

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

Go to the source code of this file.

Classes
struct	GGEMSWorldRecording_t
	Structure storing data for world data recording. More...
class	GGEMSWorld
	GGEMS class handling global world (space between navigators) in GGEMS. More...

Typedefs
typedef struct GGEMSWorldRecording_t	GGEMSWorldRecording

Functions
GGEMSWorld *	create_ggems_world (void)
	Get the GGEMSWorld pointer for python user. More...
void	set_dimension_ggems_world (GGEMSWorld *world, GGsize const dimension_x, GGsize const dimension_y, GGsize const dimension_z)
	set the dimenstions of the world in X, Y and Z More...
void	set_size_ggems_world (GGEMSWorld *world, GGfloat const size_x, GGfloat const size_y, GGfloat const size_z, char const *unit)
	set the element sizes of the world More...
void	photon_tracking_ggems_world (GGEMSWorld *world, bool const is_activated)
	storing results about photon tracking More...
void	energy_tracking_ggems_world (GGEMSWorld *world, bool const is_activated)
	storing results about energy tracking More...
void	energy_squared_tracking_ggems_world (GGEMSWorld *world, bool const is_activated)
	storing results about energy squared tracking More...
void	set_output_ggems_world (GGEMSWorld *world, char const *world_output_basename)
	set output basename storing world tracking results More...
void	momentum_ggems_world (GGEMSWorld *world, bool const is_activated)
	storing sum of momentum in world More...

Detailed Description

GGEMS class handling global world (space between navigators) in GGEMS.

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

Tuesday March 11, 2021

Definition in file GGEMSWorld.hh.

Typedef Documentation

GGEMSWorldRecording

typedef struct GGEMSWorldRecording_t GGEMSWorldRecording

Using C convention name of struct to C++ (_t deletion)

Function Documentation

create_ggems_world()

GGEMSWorld * create_ggems_world

(

void

)

Get the GGEMSWorld pointer for python user.

Returns

the pointer on the world

Definition at line 568 of file GGEMSWorld.cc.

energy_squared_tracking_ggems_world()

void energy_squared_tracking_ggems_world	(	GGEMSWorld *	world,
		bool const	is_activated
	)

storing results about energy squared tracking

Parameters

world	- pointer on world volume
is_activated	- boolean activating energy tracking

Definition at line 622 of file GGEMSWorld.cc.

energy_tracking_ggems_world()

void energy_tracking_ggems_world	(	GGEMSWorld *	world,
		bool const	is_activated
	)

storing results about energy tracking

Parameters

world	- pointer on world volume
is_activated	- boolean activating energy tracking

Definition at line 613 of file GGEMSWorld.cc.

momentum_ggems_world()

void momentum_ggems_world	(	GGEMSWorld *	world,
		bool const	is_activated
	)

storing sum of momentum in world

Parameters

world	- pointer on world volume
is_activated	- boolean activating sum of momentum in world

Definition at line 631 of file GGEMSWorld.cc.

photon_tracking_ggems_world()

void photon_tracking_ggems_world	(	GGEMSWorld *	world,
		bool const	is_activated
	)

storing results about photon tracking

Parameters

world	- pointer on world volume
is_activated	- boolean activating the photon tracking output

Definition at line 595 of file GGEMSWorld.cc.

set_dimension_ggems_world()

void set_dimension_ggems_world	(	GGEMSWorld *	world,
		GGsize const	dimension_x,
		GGsize const	dimension_y,
		GGsize const	dimension_z
	)

set the dimenstions of the world in X, Y and Z

Parameters

world	- pointer on world volume
dimension_x	- dimension in X
dimension_y	- dimension in Y
dimension_z	- dimension in Z

Definition at line 577 of file GGEMSWorld.cc.

set_output_ggems_world()

void set_output_ggems_world	(	GGEMSWorld *	world,
		char const *	world_output_basename
	)

set output basename storing world tracking results

Parameters

world	- pointer on world
world_output_basename	- name of basename storing all results

Definition at line 604 of file GGEMSWorld.cc.

set_size_ggems_world()

void set_size_ggems_world	(	GGEMSWorld *	world,
		GGfloat const	size_x,
		GGfloat const	size_y,
		GGfloat const	size_z,
		char const *	unit
	)

set the element sizes of the world

Parameters

world	- pointer on world volume
size_x	- size of X elements of world
size_y	- size of Y elements of world
size_z	- size of Z elements of world
unit	- unit of the distance

Definition at line 586 of file GGEMSWorld.cc.