GGEMS  1.1
GPU GEant4-based Monte Carlo Simulations
Classes | Functions
GGEMSMaterials.hh File Reference

GGEMS class handling material(s) for a specific navigator. More...

#include "GGEMS/global/GGEMSOpenCLManager.hh"
#include "GGEMS/materials/GGEMSMaterialsDatabaseManager.hh"
#include "GGEMS/materials/GGEMSMaterialTables.hh"
Include dependency graph for GGEMSMaterials.hh:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  GGEMSMaterials
 GGEMS class handling material(s) for a specific navigator. More...
 

Functions

GGEMSMaterials * create_ggems_materials (void)
 Get the GGEMSMaterials pointer for python user. More...
 
void add_material_ggems_materials (GGEMSMaterials *materials, char const *material_name)
 Add a material. More...
 
void initialize_ggems_materials (GGEMSMaterials *materials)
 Intialize the tables for the materials. More...
 
void print_material_properties_ggems_materials (GGEMSMaterials *materials)
 Print tables. More...
 
GGfloat get_density_ggems_materials (GGEMSMaterials *materials, char const *material_name)
 Get the density of material in g.cm-3. More...
 
GGfloat get_energy_cut_ggems_materials (GGEMSMaterials *materials, char const *material_name, char const *particle_type, GGfloat const distance, char const *unit)
 Get the energy cut of material in keV. More...
 
GGfloat get_atomic_number_density_ggems_materials (GGEMSMaterials *materials, char const *material_name)
 Get the density of material in g.cm-3. More...
 
void clean_ggems_materials (GGEMSMaterials *materials)
 clean all declared materials on OpenCL device More...
 

Detailed Description

GGEMS class handling material(s) for a specific navigator.

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 4, 2020

Definition in file GGEMSMaterials.hh.

Function Documentation

◆ add_material_ggems_materials()

void add_material_ggems_materials ( GGEMSMaterials *  materials,
char const *  material_name 
)

Add a material.

Parameters
materials- pointer on GGEMS materials
material_name- name of the material

Definition at line 415 of file GGEMSMaterials.cc.

◆ clean_ggems_materials()

void clean_ggems_materials ( GGEMSMaterials *  materials)

clean all declared materials on OpenCL device

Parameters
materials- pointer on GGEMS materials

Definition at line 469 of file GGEMSMaterials.cc.

◆ create_ggems_materials()

GGEMSMaterials * create_ggems_materials ( void  )

Get the GGEMSMaterials pointer for python user.

Returns
the pointer on the singleton

Definition at line 406 of file GGEMSMaterials.cc.

◆ get_atomic_number_density_ggems_materials()

GGfloat get_atomic_number_density_ggems_materials ( GGEMSMaterials *  materials,
char const *  material_name 
)

Get the density of material in g.cm-3.

Parameters
materials- pointer on GGEMS materials
material_name- name of the material
Returns
atomic number density in atom.cm-3

Definition at line 460 of file GGEMSMaterials.cc.

◆ get_density_ggems_materials()

GGfloat get_density_ggems_materials ( GGEMSMaterials *  materials,
char const *  material_name 
)

Get the density of material in g.cm-3.

Parameters
materials- pointer on GGEMS materials
material_name- name of the material
Returns
density in g.cm-3

Definition at line 442 of file GGEMSMaterials.cc.

◆ get_energy_cut_ggems_materials()

GGfloat get_energy_cut_ggems_materials ( GGEMSMaterials *  materials,
char const *  material_name,
char const *  particle_type,
GGfloat const  distance,
char const *  unit 
)

Get the energy cut of material in keV.

Parameters
materials- pointer on GGEMS materials
material_name- name of the material
particle_type- type of particle
distance- distance cut
unit- unit of the distance
Returns
energy cut in keV

Definition at line 451 of file GGEMSMaterials.cc.

◆ initialize_ggems_materials()

void initialize_ggems_materials ( GGEMSMaterials *  materials)

Intialize the tables for the materials.

Parameters
materials- pointer on GGEMS materials

Definition at line 424 of file GGEMSMaterials.cc.

◆ print_material_properties_ggems_materials()

void print_material_properties_ggems_materials ( GGEMSMaterials *  materials)

Print tables.

Parameters
materials- pointer on GGEMS materials

Definition at line 433 of file GGEMSMaterials.cc.