BeamHaloParticle Class Reference

A class to describe a generic beam halo particle. More...

#include <BeamHaloParticle.h>

Collaboration diagram for BeamHaloParticle:

Public Member Functions
	BeamHaloParticle ()
	BeamHaloParticle (long pdgId, HepMC::FourVector fourVector, HepMC::FourVector positionAtScoringPlane, double weight)
	BeamHaloParticle (long pdgId, HepMC::FourVector fourVector, HepMC::FourVector positionAtScoringPlane, double weight, HepMC::FourVector positionAtPrimary)
	BeamHaloParticle (const BeamHaloParticle &beamHaloParticle)=default
BeamHaloParticle &	operator= (const BeamHaloParticle &rhs)=default
	Assignment operator.
int	fill (MarsParticle *marsParticle)
	A function to fill the data members from an input MarsParticle object.
int	fill (FlukaParticle *flukaParticle)
	A function to fill the data members from an input FlukaParticle object.
void	print ()
	A function to print the contents of this particle.
long	pdgId () const
	A function to return the PDG id of this particle.
HepMC::FourVector	fourVector () const
	A function to return the momentum fourvector of this particle.
HepMC::FourVector	positionAtScoringPlane () const
	A function to return the position fourvector of this particle with respect to the scoring plane.
double	weight () const
	A function to return the weight of this particle within the input beam background simulation file.
HepMC::FourVector	positionAtPrimary () const
	A function to return the position fourvector of this particle with respect to the primary interaction.

Private Attributes
long	m_pdgId
	The PDG Id of the particle.
HepMC::FourVector	m_fourVector
	A four vector describing this particle at the scoring plane.
HepMC::FourVector	m_positionAtScoringPlane
	Position of the particle at the scoring plane (x,y,z,t).
double	m_weight
	The resultant particle weight after normalisation and rescaling.
HepMC::FourVector	m_positionAtPrimary
	Position of the particle at the primary interaction point (x,y,z,y).
std::shared_ptr< GenData >	m_gendata
	A shared pointer to the GenData helper object.

Detailed Description

A class to describe a generic beam halo particle.

Author

W. H. Bell W.Bel.nosp@m.l@ce.nosp@m.rn.ch

Definition at line 21 of file BeamHaloParticle.h.

Constructor & Destructor Documentation

BeamHaloParticle() [1/4]

BeamHaloParticle::BeamHaloParticle

(

)

Definition at line 14 of file BeamHaloParticle.cxx.

BeamHaloParticle() [2/4]

BeamHaloParticle::BeamHaloParticle	(	long	pdgId,
		HepMC::FourVector	fourVector,
		HepMC::FourVector	positionAtScoringPlane,
		double	weight )

Definition at line 24 of file BeamHaloParticle.cxx.

BeamHaloParticle() [3/4]

BeamHaloParticle::BeamHaloParticle	(	long	pdgId,
		HepMC::FourVector	fourVector,
		HepMC::FourVector	positionAtScoringPlane,
		double	weight,
		HepMC::FourVector	positionAtPrimary )

Definition at line 37 of file BeamHaloParticle.cxx.

BeamHaloParticle() [4/4]

BeamHaloParticle::BeamHaloParticle ( const BeamHaloParticle & beamHaloParticle )

default

Member Function Documentation

fill() [1/2]

int BeamHaloParticle::fill

(

FlukaParticle *

flukaParticle

)

A function to fill the data members from an input FlukaParticle object.

Definition at line 114 of file BeamHaloParticle.cxx.

fill() [2/2]

int BeamHaloParticle::fill

(

MarsParticle *

marsParticle

)

A function to fill the data members from an input MarsParticle object.

Definition at line 56 of file BeamHaloParticle.cxx.

fourVector()

HepMC::FourVector BeamHaloParticle::fourVector ( ) const

inline

A function to return the momentum fourvector of this particle.

Definition at line 61 of file BeamHaloParticle.h.

operator=()

BeamHaloParticle & BeamHaloParticle::operator= ( const BeamHaloParticle & rhs )

default

Assignment operator.

pdgId()

long BeamHaloParticle::pdgId ( ) const

inline

A function to return the PDG id of this particle.

Definition at line 57 of file BeamHaloParticle.h.

positionAtPrimary()

HepMC::FourVector BeamHaloParticle::positionAtPrimary ( ) const

inline

A function to return the position fourvector of this particle with respect to the primary interaction.

Definition at line 73 of file BeamHaloParticle.h.

positionAtScoringPlane()

HepMC::FourVector BeamHaloParticle::positionAtScoringPlane ( ) const

inline

A function to return the position fourvector of this particle with respect to the scoring plane.

Definition at line 65 of file BeamHaloParticle.h.

print()

void BeamHaloParticle::print

(

)

A function to print the contents of this particle.

Definition at line 193 of file BeamHaloParticle.cxx.

weight()

double BeamHaloParticle::weight ( ) const

inline

A function to return the weight of this particle within the input beam background simulation file.

Definition at line 69 of file BeamHaloParticle.h.

Member Data Documentation

m_fourVector

HepMC::FourVector BeamHaloParticle::m_fourVector

private

A four vector describing this particle at the scoring plane.

Definition at line 81 of file BeamHaloParticle.h.

m_gendata

std::shared_ptr<GenData> BeamHaloParticle::m_gendata

private

A shared pointer to the GenData helper object.

Definition at line 93 of file BeamHaloParticle.h.

m_pdgId

long BeamHaloParticle::m_pdgId

private

The PDG Id of the particle.

Definition at line 78 of file BeamHaloParticle.h.

m_positionAtPrimary

HepMC::FourVector BeamHaloParticle::m_positionAtPrimary

private

Position of the particle at the primary interaction point (x,y,z,y).

Definition at line 90 of file BeamHaloParticle.h.

m_positionAtScoringPlane

HepMC::FourVector BeamHaloParticle::m_positionAtScoringPlane

private

Position of the particle at the scoring plane (x,y,z,t).

Definition at line 84 of file BeamHaloParticle.h.

m_weight

double BeamHaloParticle::m_weight

private

The resultant particle weight after normalisation and rescaling.

Definition at line 87 of file BeamHaloParticle.h.

---

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

• BeamHaloParticle.h
• BeamHaloParticle.cxx