reactions Namespace Reference

Main namespace of the Reactions package. More...

Namespaces
	database
	Utilities to handle database objects and their elements.
	element_traits
	Handle the properties of elements.
	exceptions
	Exceptions that are handled internally.
	pow_enum
	Utilities to define smart enumeration types.
	processes
	Processes among elements (reactions and decays)
	tokens
	Syntax tokens.
	units
	Contain functions to determine the scale factors for the given units.
	utils
	General utilities.

Classes
class	database_error
	Raised whenever a problem is detected in the database. More...
class	decay
	Description of a process where head particle generate a set of products. More...
class	element_wrapper
	Template for elements of a reaction or decay. More...
struct	fill
	Small structure to define fields without explicitely knowing its type. More...
class	internal_error
	Raised when unexpected problems appear, which should be reported as bugs. More...
class	lookup_error
	Raised when an element is not found within a database. More...
class	missing_fields_error
	Raised when trying to access a field that is not defined. More...
class	node
	Base class for a process node. More...
struct	node_object
	Base class for types referred to a node. More...
class	reaction
	Description of a process where reactants generate a set of products. More...
class	syntax_error
	Raised when processing the syntax of reactions and decays. More...
class	value_error
	Raised whenever a problem is detected with an input value. More...

Typedefs
using	string_element = std::string
	Alias for an element based on a simple string. More...

Functions
template<class Element >
reaction< Element >	make_reaction_for (std::string const &str, typename reaction< Element >::builder_type builder)
	Create a new reaction with a custom builder. More...
template<class Element >
reaction< Element >	make_reaction (std::string const &str)
	Create a new reaction. More...
template<class Element >
decay< Element >	make_decay_for (std::string const &str, typename decay< Element >::builder_type builder)
	Create a new decay with a custom builder. More...
template<class Element >
decay< Element >	make_decay (std::string const &str)
	Create a new decay. More...
	REACTIONS_POW_ENUM_WITH_UNKNOWN (energy_units, eV, keV, MeV, GeV, TeV, PeV)
	Energy units. More...

Variables
static constexpr auto	missing = std::nullopt
	Static object that defines a missing field within an object. More...

Detailed Description

Main namespace of the Reactions package.

All the objects needed to work with the package are exposed in this namespace. It can be loaded by simply including the all.hpp file.

Typedef Documentation

string_element

using reactions::string_element = typedef std::string

Alias for an element based on a simple string.

Function Documentation

make_decay()

template<class Element >

decay<Element> reactions::make_decay

(

std::string const &

str

)

Create a new decay.

Parameters

str	string to process

Returns

the decay

make_decay_for()

template<class Element >

decay<Element> reactions::make_decay_for	(	std::string const &	str,
		typename decay< Element >::builder_type	builder
	)

Create a new decay with a custom builder.

Parameters

str	string to parse
builder	function to build the underlying elements

Returns

the new decay

make_reaction()

template<class Element >

reaction<Element> reactions::make_reaction

(

std::string const &

str

)

Create a new reaction.

Parameters

str	string to process

Returns

the reaction

make_reaction_for()

template<class Element >

reaction<Element> reactions::make_reaction_for	(	std::string const &	str,
		typename reaction< Element >::builder_type	builder
	)

Create a new reaction with a custom builder.

Parameters

str	string to parse
builder	function to build the underlying elements

Returns

the new reaction

REACTIONS_POW_ENUM_WITH_UNKNOWN()

reactions::REACTIONS_POW_ENUM_WITH_UNKNOWN	(	energy_units	,
		eV	,
		keV	,
		MeV	,
		GeV	,
		TeV	,
		PeV
	)

Energy units.

Variable Documentation

missing

constexpr auto reactions::missing = std::nullopt

static

Static object that defines a missing field within an object.