Stores additional information about Heavy Ion generator. More...

#include <GenHeavyIon.h>

Inheritance diagram for HepMC3::GenHeavyIon:

Public Member Functions
	GenHeavyIon ()
	Empty default constructor.

bool	from_string (const std::string &att) override
	Implementation of Attribute::from_string.

bool	is_valid () const
	Verify that the instance contains non-zero information.

bool	operator!= (const GenHeavyIon &) const
	Operator !=.

bool	operator== (const GenHeavyIon &) const
	Operator ==.

void	set (const int &nh, const int &np, const int &nt, const int &nc, const int &ns, const int &nsp, const int &nnw=0, const int &nwn=0, const int &nwnw=0, const double &im=0., const double &pl=0., const double &ec=0., const double &s=0., const double &cent=0., const double &usrcent=0.)
	Set all fields.

bool	to_string (std::string &att) const override
	Implementation of Attribute::to_string.

Public Member Functions inherited from HepMC3::Attribute
	Attribute ()
	Default constructor.

virtual	~Attribute ()
	Virtual destructor.

const GenEvent *	event () const

virtual bool	init ()
	Optionally initialize the attribute after from_string.

virtual bool	init (const GenRunInfo &)
	Optionally initialize the attribute after from_string.

bool	is_parsed () const
	Check if this attribute is parsed.

GenParticlePtr	particle ()

ConstGenParticlePtr	particle () const

const std::string &	unparsed_string () const
	Get unparsed string.

GenVertexPtr	vertex ()

ConstGenVertexPtr	vertex () const

Public Attributes
double	centrality
	The centrality.

std::map< int, double >	eccentricities
	Eccentricities.

double	eccentricity
	The eccentricity.

double	event_plane_angle
	The event plane angle.

bool	forceoldformat
	force writing in old format for compatibility purposes.

double	impact_parameter
	The impact parameter.

int	N_Nwounded_collisions
	Collisions with a diffractively excited target nucleon.

int	Ncoll
	the number of inelastic nucleon-nucleon collisions.

int	Ncoll_hard
	the number of hard nucleon-nucleon collisions.

int	Npart_proj
	the number of participating nucleons in the projectile.

int	Npart_targ
	the number of participating nucleons in the target.

int	Nspec_proj_n
	The number of spectator neutrons in the projectile.

int	Nspec_proj_p
	The number of spectator protons in the projectile.

int	Nspec_targ_n
	The number of spectator neutrons in the target.

int	Nspec_targ_p
	The number of spectator protons in the target.

int	Nwounded_N_collisions
	Collisions with a diffractively excited projectile nucleon.

int	Nwounded_Nwounded_collisions
	Non-diffractive or doubly diffractive collisions.

std::map< int, double >	participant_plane_angles
	Participant plane angles.

double	sigma_inel_NN
	The assumed inelastic nucleon-nucleon cross section.

int	spectator_neutrons
	Total number of spectator neutrons.

int	spectator_protons
	Total number of spectator protons.

double	user_cent_estimate
	A user defined centrality estimator.

Additional Inherited Members
Protected Member Functions inherited from HepMC3::Attribute
	Attribute (const std::string &st)
	Protected constructor that allows to set string.

void	set_is_parsed (bool flag)
	Set is_parsed flag.

void	set_unparsed_string (const std::string &st)
	Set unparsed string.

Detailed Description

Stores additional information about Heavy Ion generator.

This is an example of event attribute used to store Heavy Ion information

Definition at line 26 of file GenHeavyIon.h.

Constructor & Destructor Documentation

◆ GenHeavyIon()

HepMC3::GenHeavyIon::GenHeavyIon ( )

inline

Empty default constructor.

Definition at line 31 of file GenHeavyIon.h.

        : Ncoll_hard(-1), Npart_proj(-1), Npart_targ(-1), Ncoll(-1),
#ifndef HEPMC3_NO_DEPRECATED
          spectator_neutrons(-1), spectator_protons(-1),
#endif
          N_Nwounded_collisions(-1), Nwounded_N_collisions(-1),
          Nwounded_Nwounded_collisions(-1), impact_parameter(-1.0),
          event_plane_angle(-1.0),
#ifndef HEPMC3_NO_DEPRECATED
          eccentricity(-1.0),
#endif
          sigma_inel_NN(-1.0), centrality(-1.0), user_cent_estimate(-1.0),
          Nspec_proj_n(-1), Nspec_targ_n(-1),
          Nspec_proj_p(-1), Nspec_targ_p(-1), forceoldformat(false) {}

References centrality, eccentricity, event_plane_angle, forceoldformat, impact_parameter, N_Nwounded_collisions, Ncoll, Ncoll_hard, Npart_proj, Npart_targ, Nspec_proj_n, Nspec_proj_p, Nspec_targ_n, Nspec_targ_p, Nwounded_N_collisions, Nwounded_Nwounded_collisions, sigma_inel_NN, spectator_neutrons, spectator_protons, and user_cent_estimate.

Referenced by operator!=(), and operator==().

Member Function Documentation

◆ from_string()

bool HepMC3::GenHeavyIon::from_string ( const std::string & att )

overridevirtual

Implementation of Attribute::from_string.

Implements HepMC3::Attribute.

◆ is_valid()

bool HepMC3::GenHeavyIon::is_valid ( ) const

Verify that the instance contains non-zero information.

HEPMC3_DEPRECATED("Each filed now have default values meaning that they have not been set")

◆ set()

void HepMC3::GenHeavyIon::set	(	const int &	nh,
		const int &	np,
		const int &	nt,
		const int &	nc,
		const int &	ns,
		const int &	nsp,
		const int &	nnw = 0,
		const int &	nwn = 0,
		const int &	nwnw = 0,
		const double &	im = 0.,
		const double &	pl = 0.,
		const double &	ec = 0.,
		const double &	s = 0.,
		const double &	cent = 0.,
		const double &	usrcent = 0. )

Set all fields.

HEPMC3_DEPRECATED("Set individual fields directly instead.")

Set all fields

◆ to_string()

bool HepMC3::GenHeavyIon::to_string ( std::string & att ) const

overridevirtual

Implementation of Attribute::to_string.

Implements HepMC3::Attribute.

Member Data Documentation

◆ centrality

double HepMC3::GenHeavyIon::centrality

The centrality.

The generated centrality in percentiles, where 0 is the maximally central and 100 is the minimally central. A negative value means that the information is not available.

Definition at line 148 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ eccentricities

std::map<int,double> HepMC3::GenHeavyIon::eccentricities

Eccentricities.

Calculated to different orders. The key of the map specifies the order, and the value gives the corresponding eccentricity.

Definition at line 199 of file GenHeavyIon.h.

◆ eccentricity

double HepMC3::GenHeavyIon::eccentricity

The eccentricity.

HEPMC3_DEPRECATED("Use eccentricities insted.")

Definition at line 133 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ event_plane_angle

double HepMC3::GenHeavyIon::event_plane_angle

The event plane angle.

The angle wrt. the x-axix of the impact parameter vector (pointing frm the target to the projectile). A positive number between 0 and two pi. A negative value means that the information is not available.

Definition at line 127 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ forceoldformat

bool HepMC3::GenHeavyIon::forceoldformat

force writing in old format for compatibility purposes.

HEPMC3_DEPRECATED("This should really not be needed");

Definition at line 237 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ impact_parameter

double HepMC3::GenHeavyIon::impact_parameter

The impact parameter.

The impact parameter given in units of femtometer. A negative value means that the information is not available.

Definition at line 119 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ N_Nwounded_collisions

int HepMC3::GenHeavyIon::N_Nwounded_collisions

Collisions with a diffractively excited target nucleon.

The number of single diffractive nucleon-nucleon collisions where the target nucleon is excited. A negative value means that the information is not available.

Definition at line 99 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Ncoll

int HepMC3::GenHeavyIon::Ncoll

the number of inelastic nucleon-nucleon collisions.

Note that a one participating nucleon can be involved in many inelastic collisions, and that inelastic also includes diffractive excitation. A negative value means that the information is not available.

Definition at line 80 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Ncoll_hard

int HepMC3::GenHeavyIon::Ncoll_hard

the number of hard nucleon-nucleon collisions.

Model-dependent. Usually the number of nucleon-nucleon collisions containing a special signal process. A negative value means that the information is not available.

Definition at line 57 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Npart_proj

int HepMC3::GenHeavyIon::Npart_proj

the number of participating nucleons in the projectile.

The number of nucleons in the projectile participating in an inelastic collision (see Ncoll). A negative value means that the information is not available.

Definition at line 64 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Npart_targ

int HepMC3::GenHeavyIon::Npart_targ

the number of participating nucleons in the target.

The number of nucleons in the target participating in an inelastic collision (see Ncoll). A negative value means that the information is not available.

Definition at line 71 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Nspec_proj_n

int HepMC3::GenHeavyIon::Nspec_proj_n

The number of spectator neutrons in the projectile.

ie. those that thave not participated in any inelastic nucleon-nucleon collision. A negative value indicatess that the information is not available.

Definition at line 165 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Nspec_proj_p

int HepMC3::GenHeavyIon::Nspec_proj_p

The number of spectator protons in the projectile.

ie. those that thave not participated in any inelastic nucleon-nucleon collision. A negative value indicatess that the information is not available.

Definition at line 179 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Nspec_targ_n

int HepMC3::GenHeavyIon::Nspec_targ_n

The number of spectator neutrons in the target.

ie. those that thave not participated in any inelastic nucleon-nucleon collision. A negative value indicatess that the information is not available.

Definition at line 172 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Nspec_targ_p

int HepMC3::GenHeavyIon::Nspec_targ_p

The number of spectator protons in the target.

ie. those that thave not participated in any inelastic nucleon-nucleon collision. A negative value indicatess that the information is not available.

Definition at line 186 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Nwounded_N_collisions

int HepMC3::GenHeavyIon::Nwounded_N_collisions

Collisions with a diffractively excited projectile nucleon.

The number of single diffractive nucleon-nucleon collisions where the projectile nucleon is excited. A negative value means that the information is not available.

Definition at line 106 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ Nwounded_Nwounded_collisions

int HepMC3::GenHeavyIon::Nwounded_Nwounded_collisions

Non-diffractive or doubly diffractive collisions.

The number of nucleon-nucleon collisions where both projectile and target nucleons are wounded. A negative value means that the information is not available.

Definition at line 113 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ participant_plane_angles

std::map<int,double> HepMC3::GenHeavyIon::participant_plane_angles

Participant plane angles.

calculated to different orders. The key of the map specifies the order, and the value gives to the angle wrt. the event plane.

Definition at line 193 of file GenHeavyIon.h.

◆ sigma_inel_NN

double HepMC3::GenHeavyIon::sigma_inel_NN

The assumed inelastic nucleon-nucleon cross section.

in units of millibarn. As used in a Glauber calculation to simulate the distribution in Ncoll. A negative value means that the information is not available.

Definition at line 141 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ spectator_neutrons

int HepMC3::GenHeavyIon::spectator_neutrons

Total number of spectator neutrons.

HEPMC3_DEPRECATED("Use Nspec_proj_n and Nspec_targ_n instead.")

Definition at line 86 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ spectator_protons

int HepMC3::GenHeavyIon::spectator_protons

Total number of spectator protons.

HEPMC3_DEPRECATED("Use Nspec_proj_p and Nspec_targ_p instead.")

Definition at line 91 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

◆ user_cent_estimate

double HepMC3::GenHeavyIon::user_cent_estimate

A user defined centrality estimator.

This variable may contain anything a generator feels is reasonable for estimating centrality. The value should be non-negative, and a low value corresponds to a low centrality. A negative value indicatess that the information is not available.

Definition at line 157 of file GenHeavyIon.h.

Referenced by GenHeavyIon().

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

/home/sjg/Desktop/marley/include/builtin/HepMC3/GenHeavyIon.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GenHeavyIon()

Member Function Documentation

◆ from_string()

◆ is_valid()

◆ set()

◆ to_string()

Member Data Documentation

◆ centrality

◆ eccentricities

◆ eccentricity

◆ event_plane_angle

◆ forceoldformat

◆ impact_parameter

◆ N_Nwounded_collisions

◆ Ncoll

◆ Ncoll_hard

◆ Npart_proj

◆ Npart_targ

◆ Nspec_proj_n

◆ Nspec_proj_p

◆ Nspec_targ_n

◆ Nspec_targ_p

◆ Nwounded_N_collisions

◆ Nwounded_Nwounded_collisions

◆ participant_plane_angles

◆ sigma_inel_NN

◆ spectator_neutrons

◆ spectator_protons

◆ user_cent_estimate