GGEMSMaterialsDatabaseManager.hh File Reference

GGEMS singleton class managing the material database. More...

#include <vector>
#include <unordered_map>
#include "GGEMS/global/GGEMSConstants.hh"

Include dependency graph for GGEMSMaterialsDatabaseManager.hh:

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

Go to the source code of this file.

Classes
struct	GGEMSChemicalElement
	GGEMS structure managing a specific chemical element. More...
struct	GGEMSSingleMaterial
	GGEMS structure managing a specific material. More...
class	GGEMSMaterialsDatabaseManager
	GGEMS class managing the material database. More...

Typedefs
typedef std::unordered_map< std::string, GGEMSChemicalElement >	ChemicalElementUMap
typedef std::unordered_map< std::string, GGEMSSingleMaterial >	MaterialUMap

Functions
GGEMSMaterialsDatabaseManager *	get_instance_materials_manager (void)
	Get the GGEMSMaterialsDatabaseManager pointer for python user. More...
void	set_materials_ggems_materials_manager (GGEMSMaterialsDatabaseManager *ggems_materials_manager, char const *filename)
	enter the material database to GGEMS More...
void	print_available_chemical_elements_ggems_materials_manager (GGEMSMaterialsDatabaseManager *ggems_materials_manager)
	print all available chemical elements More...
void	print_available_materials_ggems_materials_manager (GGEMSMaterialsDatabaseManager *ggems_materials_manager)
	print all available materials More...

Variables
__constant GGchar	SOLID = 0
__constant GGchar	GAS = 1

Detailed Description

GGEMS singleton class managing the material database.

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

Thrusday January 23, 2020

Definition in file GGEMSMaterialsDatabaseManager.hh.

Typedef Documentation

ChemicalElementUMap

typedef std::unordered_map<std::string, GGEMSChemicalElement> ChemicalElementUMap

Unordered map with key : name of element, value the chemical element structure

Definition at line 71 of file GGEMSMaterialsDatabaseManager.hh.

MaterialUMap

typedef std::unordered_map<std::string, GGEMSSingleMaterial> MaterialUMap

Unordered map with key : name of the material, value the material

Definition at line 72 of file GGEMSMaterialsDatabaseManager.hh.

Function Documentation

get_instance_materials_manager()

GGEMSMaterialsDatabaseManager * get_instance_materials_manager

(

void

)

Get the GGEMSMaterialsDatabaseManager pointer for python user.

Returns

the pointer on the singleton

Definition at line 378 of file GGEMSMaterialsDatabaseManager.cc.

print_available_chemical_elements_ggems_materials_manager()

void print_available_chemical_elements_ggems_materials_manager

(

GGEMSMaterialsDatabaseManager *

ggems_materials_manager

)

print all available chemical elements

Parameters

ggems_materials_manager

- pointer on the singleton

Definition at line 396 of file GGEMSMaterialsDatabaseManager.cc.

print_available_materials_ggems_materials_manager()

void print_available_materials_ggems_materials_manager

(

GGEMSMaterialsDatabaseManager *

ggems_materials_manager

)

print all available materials

Parameters

ggems_materials_manager

- pointer on the singleton

Definition at line 405 of file GGEMSMaterialsDatabaseManager.cc.

set_materials_ggems_materials_manager()

void set_materials_ggems_materials_manager	(	GGEMSMaterialsDatabaseManager *	ggems_materials_manager,
		char const *	filename
	)

enter the material database to GGEMS

Parameters

ggems_materials_manager	- pointer on the singleton
filename	- file with list of materials

Definition at line 387 of file GGEMSMaterialsDatabaseManager.cc.

Variable Documentation

GAS

__constant GGchar GAS = 1

Gas state

Definition at line 44 of file GGEMSMaterialsDatabaseManager.hh.

SOLID

__constant GGchar SOLID = 0

Solid state

Definition at line 43 of file GGEMSMaterialsDatabaseManager.hh.