Description of a nuclear level. More...

#include <bayeux/genbb_help/nuclear_level.h>

Inheritance diagram for genbb::nuclear_level:

Classes
class	decay_channel
	A decay channel attached to the level. More...

Public Types
enum	parity_type { PARITY_INVALID = 0, PARITY_MINUS = 1, PARITY_PLUS = 2, PARITY_UNKNOWN = 3 }
	Parity values. More...

typedef datatools::handle< nuclear_level >	handle_type
	Handle to a nuclear level. More...

typedef datatools::handle< nuclear_decay >	decay_handle_type
	Handle to a nuclear decay. More...

typedef std::vector< decay_channel >	decay_channels_col_type
	A collection of decay modes. More...

Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
	Enumeration for standard output streams. More...

Public Member Functions
	nuclear_level ()
	Default constructor. More...

virtual	~nuclear_level ()
	Desstructor. More...

bool	is_valid () const
	Check validity. More...

void	set_A (int)
	Set the number of nucleons. More...

void	set_Z (int)
	Set the number of protons. More...

void	set_spin (double)
	Set the spin. More...

void	set_parity (parity_type)
	Set the parity. More...

void	set_half_life (double)
	Set the half_life. More...

void	set_width (double)
	Set the width. More...

void	set_stable ()
	Make the level stable. More...

void	set_energy (double)
	Set the energy. More...

void	set_fundamental ()
	Set the fundamental energy. More...

int	get_A () const
	Return the number of nucleons. More...

int	get_Z () const
	Return the number of protons. More...

const std::string &	get_element_symbol () const
	Return the element symbol. More...

int	get_N () const
	Return the number of neutrons. More...

bool	spin_is_known () const
	Check if the spin is known. More...

bool	parity_is_known () const
	Check if the parity is known. More...

double	get_spin () const
	Return the spin. More...

parity_type	get_parity () const
	Return the parity. More...

double	get_half_life () const
	Return the half_life. More...

double	get_mean_life_time () const
	Return the mean life time. More...

double	get_width () const
	Return the level width. More...

bool	is_stable () const
	Check if the level is stable. More...

double	get_energy () const
	Return the excitation energy. More...

bool	is_fundamental () const
	Check if the level is fundamental. More...

bool	has_decay_table () const
	Check the decay table. More...

void	add_decay_channel (const nuclear_decay &decay_, double branching_ratio_)
	Add a decay channel. More...

size_t	get_number_of_decay_channels () const
	Return the number of decay channels. More...

const decay_channel &	get_decay_channel (int i_) const
	Return the decay channel at a given index. More...

const datatools::properties &	get_auxiliaries () const
	Return auxiliary properties. More...

datatools::properties &	grab_auxiliaries ()
	Return auxiliary properties. More...

const datatools::properties &	get_decay_table_config () const
	Return decay table configuration properties. More...

datatools::properties &	grab_decay_table_config ()
	Return decay table configuration properties. More...

std::string	to_string (unsigned int=0) const
	Return a descriptive string. More...

virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	Smart print. More...

bool	is_initialized () const
	Check initialization flag. More...

void	initialize (const datatools::properties &config_)
	Initialize from a list of parameters and a dictionary of nuclear decays. More...

void	initialize_simple ()
	Standalone initialization. More...

void	reset ()
	Reset. More...

void	install_decay_table (const datatools::properties &config_, const std::map< std::string, datatools::handle< nuclear_decay > > &decays_)
	Install the decay table. More...

void	reset_decay_table ()
	Reset decay table. More...

const decay_channels_col_type &	get_decay_channels () const
	Return the decay channel table. More...

Public Member Functions inherited from datatools::i_tree_dumpable
	i_tree_dumpable ()
	Constructor. More...

virtual	~i_tree_dumpable ()
	Destructor. More...

virtual void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
	Main new interface method for printing. More...

void	print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
	Printing with jsonized options. More...

void	print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
	Printing with jsonized options. More...

void	tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const

void	tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const

void	smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const

Static Public Member Functions
static std::string	label_from_parity (parity_type)
	Return a label associated to a parity value. More...

static parity_type	parity_from_label (const std::string &)
	Return the parity value associated to a label. More...

static std::string	label_from_spin (double)
	Return a label associated to a spin value. More...

static double	spin_from_label (const std::string &)
	Return the spin value associated to a label. More...

Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree &	empty_options ()

static boost::property_tree::ptree	make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)

static std::ostream &	last_skip_tag (std::ostream &out_)

static std::ostream &	skip_tag (std::ostream &out_)

static std::ostream &	last_tag (std::ostream &out_)

static std::ostream &	tag (std::ostream &out_)

Protected Member Functions
void	_set_defaults ()
	Set defaults. More...

void	_compute_decay_weights ()
	Compute the weights associated to the decay. More...

Detailed Description

Description of a nuclear level.

Member Typedef Documentation

◆ decay_channels_col_type

typedef std::vector<decay_channel> genbb::nuclear_level::decay_channels_col_type

A collection of decay modes.

◆ decay_handle_type

typedef datatools::handle<nuclear_decay> genbb::nuclear_level::decay_handle_type

Handle to a nuclear decay.

◆ handle_type

typedef datatools::handle<nuclear_level> genbb::nuclear_level::handle_type

Handle to a nuclear level.

Member Enumeration Documentation

◆ parity_type

enum genbb::nuclear_level::parity_type

Parity values.

Enumerator
PARITY_INVALID	Invalid value.
PARITY_MINUS	Negative parity.
PARITY_PLUS	Positive parity.
PARITY_UNKNOWN	Unknown parity.

Constructor & Destructor Documentation

◆ nuclear_level()

genbb::nuclear_level::nuclear_level ( )

Default constructor.

◆ ~nuclear_level()

virtual genbb::nuclear_level::~nuclear_level ( )

virtual

Desstructor.

Member Function Documentation

◆ _compute_decay_weights()

void genbb::nuclear_level::_compute_decay_weights ( )

protected

Compute the weights associated to the decay.

◆ _set_defaults()

void genbb::nuclear_level::_set_defaults ( )

protected

Set defaults.

◆ add_decay_channel()

void genbb::nuclear_level::add_decay_channel	(	const nuclear_decay &	decay_,
		double	branching_ratio_
	)

Add a decay channel.

◆ get_A()

int genbb::nuclear_level::get_A ( ) const

Return the number of nucleons.

◆ get_auxiliaries()

const datatools::properties& genbb::nuclear_level::get_auxiliaries ( ) const

Return auxiliary properties.

◆ get_decay_channel()

const decay_channel& genbb::nuclear_level::get_decay_channel ( int i_ ) const

Return the decay channel at a given index.

◆ get_decay_channels()

const decay_channels_col_type& genbb::nuclear_level::get_decay_channels ( ) const

Return the decay channel table.

◆ get_decay_table_config()

const datatools::properties& genbb::nuclear_level::get_decay_table_config ( ) const

Return decay table configuration properties.

◆ get_element_symbol()

const std::string& genbb::nuclear_level::get_element_symbol ( ) const

Return the element symbol.

◆ get_energy()

double genbb::nuclear_level::get_energy ( ) const

Return the excitation energy.

◆ get_half_life()

double genbb::nuclear_level::get_half_life ( ) const

Return the half_life.

◆ get_mean_life_time()

double genbb::nuclear_level::get_mean_life_time ( ) const

Return the mean life time.

◆ get_N()

int genbb::nuclear_level::get_N ( ) const

Return the number of neutrons.

◆ get_number_of_decay_channels()

size_t genbb::nuclear_level::get_number_of_decay_channels ( ) const

Return the number of decay channels.

◆ get_parity()

parity_type genbb::nuclear_level::get_parity ( ) const

Return the parity.

◆ get_spin()

double genbb::nuclear_level::get_spin ( ) const

Return the spin.

◆ get_width()

double genbb::nuclear_level::get_width ( ) const

Return the level width.

◆ get_Z()

int genbb::nuclear_level::get_Z ( ) const

Return the number of protons.

◆ grab_auxiliaries()

datatools::properties& genbb::nuclear_level::grab_auxiliaries ( )

Return auxiliary properties.

◆ grab_decay_table_config()

datatools::properties& genbb::nuclear_level::grab_decay_table_config ( )

Return decay table configuration properties.

◆ has_decay_table()

bool genbb::nuclear_level::has_decay_table ( ) const

Check the decay table.

◆ initialize()

void genbb::nuclear_level::initialize ( const datatools::properties & config_ )

Initialize from a list of parameters and a dictionary of nuclear decays.

◆ initialize_simple()

void genbb::nuclear_level::initialize_simple ( )

Standalone initialization.

◆ install_decay_table()

void genbb::nuclear_level::install_decay_table	(	const datatools::properties &	config_,
		const std::map< std::string, datatools::handle< nuclear_decay > > &	decays_
	)

Install the decay table.

◆ is_fundamental()

bool genbb::nuclear_level::is_fundamental ( ) const

Check if the level is fundamental.

◆ is_initialized()

bool genbb::nuclear_level::is_initialized ( ) const

Check initialization flag.

◆ is_stable()

bool genbb::nuclear_level::is_stable ( ) const

Check if the level is stable.

◆ is_valid()

bool genbb::nuclear_level::is_valid ( ) const

Check validity.

◆ label_from_parity()

static std::string genbb::nuclear_level::label_from_parity ( parity_type )

static

Return a label associated to a parity value.

◆ label_from_spin()

static std::string genbb::nuclear_level::label_from_spin ( double )

static

Return a label associated to a spin value.

◆ parity_from_label()

static parity_type genbb::nuclear_level::parity_from_label ( const std::string & )

static

Return the parity value associated to a label.

◆ parity_is_known()

bool genbb::nuclear_level::parity_is_known ( ) const

Check if the parity is known.

◆ reset()

void genbb::nuclear_level::reset ( )

Reset.

◆ reset_decay_table()

void genbb::nuclear_level::reset_decay_table ( )

Reset decay table.

◆ set_A()

void genbb::nuclear_level::set_A ( int )

Set the number of nucleons.

◆ set_energy()

void genbb::nuclear_level::set_energy ( double )

Set the energy.

◆ set_fundamental()

void genbb::nuclear_level::set_fundamental ( )

Set the fundamental energy.

◆ set_half_life()

void genbb::nuclear_level::set_half_life ( double )

Set the half_life.

◆ set_parity()

void genbb::nuclear_level::set_parity ( parity_type )

Set the parity.

◆ set_spin()

void genbb::nuclear_level::set_spin ( double )

Set the spin.

◆ set_stable()

void genbb::nuclear_level::set_stable ( )

Make the level stable.

◆ set_width()

void genbb::nuclear_level::set_width ( double )

Set the width.

◆ set_Z()

void genbb::nuclear_level::set_Z ( int )

Set the number of protons.

◆ spin_from_label()

static double genbb::nuclear_level::spin_from_label ( const std::string & )

static

Return the spin value associated to a label.

◆ spin_is_known()

bool genbb::nuclear_level::spin_is_known ( ) const

Check if the spin is known.

◆ to_string()

std::string genbb::nuclear_level::to_string ( unsigned int = 0 ) const

Return a descriptive string.

◆ tree_dump()

virtual void genbb::nuclear_level::tree_dump	(	std::ostream &	out_ = `std::clog`,
		const std::string &	title_ = `""`,
		const std::string &	indent_ = `""`,
		bool	inherit_ = `false`
	)		const

virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

The documentation for this class was generated from the following file:

bayeux/genbb_help/nuclear_level.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ decay_channels_col_type

◆ decay_handle_type

◆ handle_type

Member Enumeration Documentation

◆ parity_type

Constructor & Destructor Documentation

◆ nuclear_level()

◆ ~nuclear_level()

Member Function Documentation

◆ _compute_decay_weights()

◆ _set_defaults()

◆ add_decay_channel()

◆ get_A()

◆ get_auxiliaries()

◆ get_decay_channel()

◆ get_decay_channels()

◆ get_decay_table_config()

◆ get_element_symbol()

◆ get_energy()

◆ get_half_life()

◆ get_mean_life_time()

◆ get_N()

◆ get_number_of_decay_channels()

◆ get_parity()

◆ get_spin()

◆ get_width()

◆ get_Z()

◆ grab_auxiliaries()

◆ grab_decay_table_config()

◆ has_decay_table()

◆ initialize()

◆ initialize_simple()

◆ install_decay_table()

◆ is_fundamental()

◆ is_initialized()

◆ is_stable()

◆ is_valid()

◆ label_from_parity()

◆ label_from_spin()

◆ parity_from_label()

◆ parity_is_known()

◆ reset()

◆ reset_decay_table()

◆ set_A()

◆ set_energy()

◆ set_fundamental()

◆ set_half_life()

◆ set_parity()

◆ set_spin()

◆ set_stable()

◆ set_width()

◆ set_Z()

◆ spin_from_label()

◆ spin_is_known()

◆ to_string()

◆ tree_dump()