Heed::mparticle Class Reference

Massive particle. A force can be applied. More...

#include <mparticle.h>

Inheritance diagram for Heed::mparticle:

Public Member Functions
	mparticle ()=default
	Default constructor.
	mparticle (manip_absvol *primvol, const point &pt, const vec &vel, vfloat ftime, double fmass)
	Constructor, calculated from the from velocity vector.
virtual	~mparticle ()
	Destructor.
double	kinetic_energy () const
	Get the current kinetic energy.
void	print (std::ostream &file, int l) const override
	Print-out.
mparticle *	copy () const override
	Clone the particle.
Public Member Functions inherited from Heed::gparticle
	gparticle ()=default
	Default constructor.
	gparticle (manip_absvol *primvol, const point &pt, const vec &vel, vfloat time)
	Constructor.
virtual	~gparticle ()
	Destructor.
virtual void	fly (std::vector< gparticle * > &secondaries)
	Transport the particle.
virtual void	fly (std::vector< gparticle * > &secondaries, const bool one_step)
void	set_step_limits (const vfloat fmax_range, const vfloat frad_for_straight, const vfloat fmax_straight_arange, const vfloat fmax_circ_arange)
	Set limits/parameters for trajectory steps.
const vec &	position () const
	Get the current position of the particle.
vfloat	time () const
	Get the current time of the particle.
const vec &	direction () const
	Get the current direction of the particle.
bool	alive () const
virtual void	print (std::ostream &file, int l) const
	Print-out.
virtual gparticle *	copy () const
	Clone the particle.

Protected Member Functions
void	step (std::vector< gparticle * > &secondaries) override
void	curvature (bool &curved, vec &frelcen, vfloat &fmrange, vfloat prec) override
virtual int	force (const point &pt, vec &f, vec &f_perp, vfloat &mrange)
Protected Member Functions inherited from Heed::gparticle
virtual void	step (std::vector< gparticle * > &secondaries)
virtual void	change_vol ()
	Move from one volume to another.
virtual void	curvature (bool &curved, vec &frelcen, vfloat &fmrange, vfloat prec)
virtual void	physics_after_new_speed (std::vector< gparticle * > &)
	Apply any other processes (turn the trajectory, kill the particle, ...).
virtual void	physics (std::vector< gparticle * > &)
	Apply any other processes (turn the trajectory, kill the particle, ...).
virtual void	physics_mrange (double &fmrange)
virtual stvpoint	calc_step_to_bord ()
	Determine next position.
stvpoint	switch_new_vol ()
	Generate next position in new volume.

Protected Attributes
double	m_mass = 0.
	Mass (not mass * speed_of_light^2)
double	m_curr_ekin = 0.
	Current kinetic energy.
double	m_orig_ekin = 0.
	Original kinetic energy.
double	m_prev_ekin = 0.
	Previous kinetic energy.
double	m_curr_gamma_1 = 0.
	Current .
double	m_orig_gamma_1 = 0.
	Original .
double	m_prev_gamma_1 = 0.
	Previous .
Protected Attributes inherited from Heed::gparticle
bool	m_alive = false
	Status flag whether the particle is active.
long	m_nstep = 0
	Step number.
long	m_nzero_step = 0
	Number of previous steps with zero range (including this step).
stvpoint	m_origin
	Original point.
double	m_total_range_from_origin = 0.
	Range from origin to current position.
stvpoint	m_prevpos
	Previous point.
stvpoint	m_currpos
	Current point.
stvpoint	m_nextpos
	Next point.

Additional Inherited Members
Static Protected Attributes inherited from Heed::gparticle
static constexpr long	m_max_qzero_step = 100
	Max. number of zero-steps allowed.

Detailed Description

Massive particle. A force can be applied.

Definition at line 23 of file mparticle.h.

Constructor & Destructor Documentation

mparticle() [1/2]

Heed::mparticle::mparticle ( )

default

Default constructor.

Referenced by copy().

mparticle() [2/2]

Heed::mparticle::mparticle	(	manip_absvol *	primvol,
		const point &	pt,
		const vec &	vel,
		vfloat	ftime,
		double	fmass
	)

Constructor, calculated from the from velocity vector.

Definition at line 20 of file mparticle.cpp.

    : gparticle(primvol, pt, vel, ftime),
      m_mass(fmass) {
 
  mfunname("mparticle::mparticle(...)");
 
  const double mc2 = m_mass * c_squared;
  m_orig_gamma_1 = lorgamma_1(m_origin.speed / c_light);
  m_orig_ekin = m_orig_gamma_1 * mc2;
  m_prev_gamma_1 = lorgamma_1(m_prevpos.speed / c_light);
  m_prev_ekin = m_prev_gamma_1 * mc2;
  m_curr_gamma_1 = lorgamma_1(m_currpos.speed / c_light);
  m_curr_ekin = m_curr_gamma_1 * mc2;
  check_consistency();
}

~mparticle()

virtual Heed::mparticle::~mparticle ( )

inlinevirtual

Destructor.

Definition at line 31 of file mparticle.h.

{}

Member Function Documentation

copy()

mparticle * Heed::mparticle::copy ( ) const

inlineoverridevirtual

Clone the particle.

Reimplemented from Heed::gparticle.

Reimplemented in Heed::eparticle.

Definition at line 37 of file mparticle.h.

{ return new mparticle(*this); }

curvature()

void Heed::mparticle::curvature ( bool &  curved, vec &  frelcen, vfloat &  fmrange, vfloat  prec  )

overrideprotectedvirtual

Set curvature. Calls force().

• If force is zero, set curved = false, frelcen = (0, 0, 0).
  • If, in addition, currpos.dir == (0, 0, 0), set fmrange = 0.
• If currpos.dir == (0, 0, 0), set currpos.dir = unit_vec(f).
• If force is parallel or anti-parallel to dir, set curved = false, frelcen = (0, 0, 0).
• If force is anti-parallel to dir, restrict range till exceeding kinetic energy.

Reimplemented from Heed::gparticle.

Definition at line 98 of file mparticle.cpp.

                                       {
 
  pvecerror("void mparticle::curvature(...)");
  vec f;
  vec f_perp_fl;
  int i = force(m_currpos.pt, f, f_perp_fl, fmrange);
  vec f_perp = m_currpos.speed * (m_currpos.dir || f_perp_fl);
  f += f_perp;
  if (i == 0 || f == dv0) {
    curved = false;
    frelcen = dv0;
    if (m_currpos.dir == dv0) fmrange = 0;  // to stay in the place
    return;
  }
  if (m_currpos.dir == dv0) {
    // starting to move in the direction of force
    m_currpos.dir = unit_vec(f);
  }
  const int j = check_par(m_currpos.dir, f, prec);
  if (j != 0) {
    curved = false;
    frelcen = dv0;
    if (j == -1) {
      // decelerate, search for stop point
      const double ran = m_curr_ekin / f.length();
      if (fmrange > ran) fmrange = ran;
    }
  } else {
    curved = true;
    vec fn = project_to_plane(f, m_currpos.dir);  // normal component
    frelcen = unit_vec(fn);
    double len = fn.length();
    vfloat rad =
        (m_currpos.speed * m_currpos.speed * (m_curr_gamma_1 + 1) * m_mass) / len;
    frelcen *= rad;
  }
  m_currpos.dirloc = m_currpos.dir;
  m_currpos.tid.up_absref(&m_currpos.dirloc);
}

force()

int Heed::mparticle::force ( const point &  pt, vec &  f, vec &  f_perp, vfloat &  mrange  )

protectedvirtual

The force is considered to be split in two components. One component, f, can be in any direction and is capable of doing work. The other one is always normal to dir and cannot do work. The latter can represent the magnetic component of the Lorentz force. This splitting improve precision of calculation of kinetic energy. But the latter component is not the true force. To derive the force one should do vector multiplication of speed by f_perp, f_perp2 = currpos.speed * (currpos.dir || f_perp_fl2); Return 0 if there is no force, f is initialised to zero anyway. mrange is the distance at which the force should not change much. The dimension of f is [weight] * [lenght] / [time]^2 The dimension of f_perp is [weight] / [time];

Reimplemented in Heed::eparticle.

Definition at line 139 of file mparticle.cpp.

                                                                        {
  f.x = f_perp.x = 0.;
  f.y = f_perp.y = 0.;
  f.z = f_perp.z = 0.;
  mrange = max_vfloat;
  return 0;
}

Referenced by curvature().

kinetic_energy()

double Heed::mparticle::kinetic_energy ( ) const

inline

Get the current kinetic energy.

Definition at line 34 of file mparticle.h.

{ return m_curr_ekin; }

Referenced by Garfield::TrackHeed::GetCluster().

print()

void Heed::mparticle::print ( std::ostream &  file, int  l  ) const

overridevirtual

Print-out.

Reimplemented from Heed::gparticle.

Reimplemented in Heed::eparticle.

Definition at line 243 of file mparticle.cpp.

                                                   {
  if (l < 0) return;
  Ifile << "mparticle: mass=" << m_mass << " (" << m_mass / CLHEP::kg << " kg, "
          << m_mass * c_squared / CLHEP::GeV << " GeV)\n";
  Ifile << "orig_ekin=" << m_orig_ekin << " ("
        << m_orig_ekin / CLHEP::GeV << " GeV)"
        << " orig_gamma_1=" << m_orig_gamma_1 << '\n';
  Ifile << "prev_ekin=" << m_prev_ekin << " ("
        << m_prev_ekin / CLHEP::GeV << " GeV)"
        << " prev_gamma_1=" << m_prev_gamma_1 << '\n';
  Ifile << "curr_kin_energy=" << m_curr_ekin << " ("
        << m_curr_ekin / CLHEP::GeV << " GeV)"
        << " curr_gamma_1=" << m_curr_gamma_1 << '\n';
  gparticle::print(file, l);
}

Referenced by Heed::HeedDeltaElectron::print(), Heed::HeedParticle::print(), Heed::HeedParticle_BGM::print(), Heed::eparticle::print(), and step().

step()

void Heed::mparticle::step ( std::vector< gparticle * > &  secondaries )

overrideprotectedvirtual

Assign prevpos = currpos and currpos = nextpos, call change_vol if necessary and update nextpos = calc_step_to_bord(). Derived versions can also recalculate the direction at currpos right after updating currpos = nextpos. This is especially important in the case when the motion is approximated by straight-line steps, but there is a (magnetic) field which slightly
deflects the trajectory. In this case, the velocity is corrected at the end point of each interval, but the position is not.

Reimplemented from Heed::gparticle.

Definition at line 71 of file mparticle.cpp.

                                                       {
  // Make step to nextpos and calculate new step to border
  mfunname("void mparticle::step(...)");
  m_prevpos = m_currpos;
  m_prev_ekin = m_curr_ekin;
  m_prev_gamma_1 = m_curr_gamma_1;
  m_currpos = m_nextpos;
  m_total_range_from_origin += m_currpos.prange;
  m_nstep++;
  if (m_currpos.prange == 0) {
    m_nzero_step++;
    check_econd12a(m_nzero_step, >, m_max_qzero_step,
                   "too many zero steps, possible infinite loop\n";
                   print(mcout, 10);, mcerr);
  } else {
    m_nzero_step = 0;
  }
  // Calculate new current speed, direction and time.
  new_speed();
  physics_after_new_speed(secondaries);
 
  if (m_alive) {
    if (m_prevpos.tid != m_currpos.tid) change_vol();
    m_nextpos = calc_step_to_bord();
  }
}

Referenced by Heed::HeedParticle::physics(), and Heed::HeedParticle_BGM::physics().

Member Data Documentation

m_curr_ekin

double Heed::mparticle::m_curr_ekin = 0.

protected

Current kinetic energy.

Definition at line 73 of file mparticle.h.

Referenced by curvature(), kinetic_energy(), mparticle(), Heed::HeedParticle::physics(), Heed::HeedParticle_BGM::physics(), Heed::HeedDeltaElectron::physics_after_new_speed(), Heed::HeedDeltaElectron::physics_mrange(), print(), and step().

m_curr_gamma_1

double Heed::mparticle::m_curr_gamma_1 = 0.

protected

Current .

Definition at line 80 of file mparticle.h.

Referenced by curvature(), mparticle(), Heed::HeedParticle_BGM::physics(), Heed::HeedDeltaElectron::physics_after_new_speed(), print(), and step().

m_mass

double Heed::mparticle::m_mass = 0.

protected

Mass (not mass * speed_of_light^2)

Definition at line 70 of file mparticle.h.

Referenced by curvature(), mparticle(), Heed::HeedParticle::physics(), Heed::HeedParticle_BGM::physics(), Heed::HeedDeltaElectron::physics_after_new_speed(), and print().

m_orig_ekin

double Heed::mparticle::m_orig_ekin = 0.

protected

Original kinetic energy.

Definition at line 75 of file mparticle.h.

Referenced by mparticle(), and print().

m_orig_gamma_1

double Heed::mparticle::m_orig_gamma_1 = 0.

protected

Original .

Definition at line 82 of file mparticle.h.

Referenced by mparticle(), and print().

m_prev_ekin

double Heed::mparticle::m_prev_ekin = 0.

protected

Previous kinetic energy.

Definition at line 77 of file mparticle.h.

Referenced by mparticle(), Heed::HeedDeltaElectron::physics_after_new_speed(), print(), and step().

m_prev_gamma_1

double Heed::mparticle::m_prev_gamma_1 = 0.

protected

Previous .

Definition at line 84 of file mparticle.h.

Referenced by mparticle(), print(), and step().

---

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

• mparticle.h
• mparticle.cpp