Top-level namespace of the Bayeux/materials module library. More...

Classes
class	chemical_symbol
	Utilities for chemical symbols. More...

class	compound_entry
	Material compound entry. More...

class	element
	The description of an element. More...

class	factory
	Factory for isotopes, elements and materials. More...

class	iso_entry
	Isotope composition entry. More...

class	isotope
	A simple class to handle known isotopes (ZAI) and their basic properties (mass & decays). More...

class	manager
	The manager object for isotopes, elements and materials. More...

class	material
	The description of a material. More...

class	materials_driver
	Driver for materials. More...

struct	materials_driver_params
	Parameters for the material driver. More...

class	refractive_index
	Compute the refractive index or the extinction coefficient for a given medium. More...

class	smart_ref
	A handler object that is used as a smart reference for an object of which it can have the responsibility of the deletion. More...

struct	version
	Describe the materials API version and features. More...

Typedefs
typedef std::map< std::string, smart_ref< isotope > >	isotope_dict_type

typedef std::map< std::string, smart_ref< element > >	element_dict_type

typedef std::map< std::string, smart_ref< material > >	material_dict_type

typedef std::map< std::string, iso_entry >	isotope_weight_map_type
	Dictionary of isotope composition entries. More...

typedef std::map< std::string, compound_entry >	composition_map_type
	Dictionary of material compounds. More...

Functions
std::string	get_resource_dir (bool overriden_env=false)

std::string	get_resource (const std::string &rname, bool overriden_env=false)

Detailed Description

Top-level namespace of the Bayeux/materials module library.

The namespace of the Bayeux/materials module library.

materials/detail/tools.h

Top-level namespace of the Bayeux/materials module library

A simple class to handle "abstract" chemical elements and their basic properties.
Elements is simply a collection of isotopes (weighted by proportion) with same number of protons (Z).
They are construct and validated when invoking build() function.
When they are built, derived properties such as molar mass are computed.
Author
BG

Version
0.1

Typedef Documentation

◆ composition_map_type

typedef std::map<std::string, compound_entry> materials::composition_map_type

Dictionary of material compounds.

◆ element_dict_type

typedef std::map<std::string, smart_ref<element> > materials::element_dict_type

◆ isotope_dict_type

typedef std::map<std::string, smart_ref<isotope> > materials::isotope_dict_type

◆ isotope_weight_map_type

typedef std::map<std::string, iso_entry> materials::isotope_weight_map_type

Dictionary of isotope composition entries.

◆ material_dict_type

typedef std::map<std::string, smart_ref<material> > materials::material_dict_type

Function Documentation

◆ get_resource()

std::string materials::get_resource	(	const std::string &	rname,
		bool	overriden_env = `false`
	)

Return URL, i.e. a path, to named resource By default the encoded resource root, determined at compile time is used to search for the resource. This can be overriden by setting the MATERIALS_RESOURCE_DIR environment variable to a path holding custom resources.

Parameters

rname	name of resource, given as a path relative to resource root.
overriden_env	flag to allow path overriding by the MATERIALS_RESOURCE_DIR environment variable.

◆ get_resource_dir()

std::string materials::get_resource_dir ( bool overriden_env = false )

Return URL, i.e. a path, to the base directory where resource files are installed