#include <HeedParticle.h>

Inheritance diagram for Heed::HeedParticle:

Public Member Functions
	HeedParticle ()
	Default constructor.

	HeedParticle (manip_absvol primvol, const point &pt, const vec &vel, vfloat time, particle_def fpardef, HeedFieldMap *fieldmap, const bool fcoulomb_scattering=false, const bool floss_only=false, const bool fprint_listing=false)

virtual	~HeedParticle ()
	Destructor.

HeedParticle *	copy () const override
	Clone the particle.

void	print (std::ostream &file, int l) const override
	Print-out.

Public Member Functions inherited from Heed::eparticle
	eparticle ()=default
	Default constructor.

	eparticle (manip_absvol primvol, const point &pt, const vec &vel, vfloat time, particle_def fpardef, HeedFieldMap *fieldmap)
	Constructor using velocity vector.

virtual	~eparticle ()
	Destructor.

Public Member Functions inherited from Heed::mparticle
	mparticle ()=default
	Default constructor.

	mparticle (manip_absvol *primvol, const point &pt, const vec &vel, vfloat ftime, double fmass)
	Constructor, $\gamma - 1$ 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
	Alive?

Protected Member Functions
void	physics (std::vector< gparticle * > &secondaries) override
	Apply any other processes (turn the trajectory, kill the particle, ...).

void	physics_mrange (double &fmrange) override

Protected Member Functions inherited from Heed::eparticle
int	force (const point &pt, vec &f, vec &f_perp, vfloat &mrange) override
	Calculate force components.

Protected Member Functions inherited from Heed::mparticle
void	step (std::vector< gparticle * > &secondaries) override

void	curvature (bool &curved, vec &frelcen, vfloat &fmrange, vfloat prec) override

Protected Member Functions inherited from Heed::gparticle
virtual void	change_vol ()
	Move from one volume to another.

virtual void	physics_after_new_speed (std::vector< gparticle * > &)
	Apply any other processes (turn the trajectory, kill the particle, ...).

virtual stvpoint	calc_step_to_bord ()
	Determine next position.

void	turn (const double ctheta, const double stheta)
	Change the direction of the particle.

stvpoint	switch_new_vol ()
	Generate next position in new volume.

Additional Inherited Members
Static Public Member Functions inherited from Heed::gparticle
static void	reset_counter ()
	Reset the counter.

Protected Attributes inherited from Heed::eparticle
particle_def *	m_pardef = nullptr

HeedFieldMap *	m_fieldMap = nullptr
	Pointer to field map.

Protected Attributes inherited from Heed::mparticle
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 $\gamma - 1$ .

double	m_orig_gamma_1 = 0.
	Original $\gamma - 1$ .

double	m_prev_gamma_1 = 0.
	Previous $\gamma - 1$ .

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.

Static Protected Attributes inherited from Heed::gparticle
static std::atomic< long >	s_counter {0L}
	Instance counter.

static constexpr long	m_max_qzero_step = 100
	Max. number of zero-steps allowed.

Detailed Description

Charged particle which can be traced through the geometry.

2003, I. Smirnov

Definition at line 14 of file HeedParticle.h.

Constructor & Destructor Documentation

◆ HeedParticle() [1/2]

Heed::HeedParticle::HeedParticle ( )

inline

Default constructor.

Definition at line 17 of file HeedParticle.h.

17: eparticle() {}

Heed::eparticle::eparticle

eparticle()=default

Default constructor.

Referenced by copy().

◆ HeedParticle() [2/2]

Heed::HeedParticle::HeedParticle	(	manip_absvol *	primvol,
		const point &	pt,
		const vec &	vel,
		vfloat	time,
		particle_def *	fpardef,
		HeedFieldMap *	fieldmap,
		const bool	fcoulomb_scattering = false,
		const bool	floss_only = false,
		const bool	fprint_listing = false )

Constructor. If fs_loss_only == false only transferred energy is simulated: no deposition of clusters, no generation of virtual photons.

Definition at line 24 of file HeedParticle.cpp.

    : eparticle(primvol, pt, vel, ftime, fpardef, fieldmap),
      m_coulomb_scattering(fcoulomb_scattering),
      m_loss_only(floss_only),
      m_print_listing(fprint_listing),
      m_particle_number(s_counter++) {}

◆ ~HeedParticle()

virtual Heed::HeedParticle::~HeedParticle ( )

inlinevirtual

Destructor.

Definition at line 28 of file HeedParticle.h.

28{}

Member Function Documentation

◆ copy()

HeedParticle * Heed::HeedParticle::copy ( ) const

inlineoverridevirtual

Clone the particle.

Reimplemented from Heed::eparticle.

Definition at line 30 of file HeedParticle.h.

30{ return new HeedParticle(*this); }

Heed::HeedParticle::HeedParticle

HeedParticle()

Default constructor.

Definition HeedParticle.h:17

◆ physics()

void Heed::HeedParticle::physics ( std::vector< gparticle * > & )

overrideprotectedvirtual

Apply any other processes (turn the trajectory, kill the particle, ...).

Reimplemented from Heed::gparticle.

Definition at line 36 of file HeedParticle.cpp.

                                                             {
  mfunname("void HeedParticle::physics()");
  if (m_print_listing) {
    mcout << "HeedParticle::physics is started\n";
    Iprintn(mcout, m_currpos.prange);
  }
  // Get the step.
  if (m_currpos.prange <= 0.0) return;
  const double stp = m_currpos.prange / cm;
  const vec dir = unit_vec(m_currpos.pt - m_prevpos.pt);
  const double range = (m_currpos.pt - m_prevpos.pt).length();
  if (m_print_listing) Iprint3n(mcout, m_prevpos.pt, dir, range);
  // Get local volume.
  const absvol* av = m_currpos.volume();
  auto etcs = dynamic_cast<const EnTransfCS*>(av);
  if (!etcs) return;
  HeedMatterDef* hmd = etcs->hmd;
  MatterDef* matter = hmd->matter;
  EnergyMesh* emesh = hmd->energy_mesh;
  const double* aetemp = emesh->get_ae();
  PointCoorMesh<double, const double*> pcm(emesh->get_q() + 1, &(aetemp));
  basis tempbas(m_currpos.dir, "tempbas");
  // Particle mass and energy.
  const double mp = m_mass * c_squared;
  const double ep = mp + m_curr_ekin;
  // Electron mass.
  const double mt = electron_mass_c2;
  // Particle velocity.
  const double invSpeed = 1. / m_prevpos.speed;
  // Shorthand.
  const auto sampleTransfer = t_hisran_step_ar<double, std::vector<double>,
                                               PointCoorMesh<double, const double*> >;
  const long qa = matter->qatom();
  if (m_print_listing) Iprintn(mcout, qa);
  for (long na = 0; na < qa; ++na) {
    if (m_print_listing) Iprintn(mcout, na);
    const long qs = hmd->apacs[na]->get_qshell();
    for (long ns = 0; ns < qs; ++ns) {
      if (m_print_listing) Iprintn(mcout, ns);
      if (etcs->quan[na][ns] <= 0.0) continue;
      // Sample the number of collisions for this shell.
      const long qt = pois(etcs->quan[na][ns] * stp);
      if (m_print_listing) Iprintn(mcout, qt);
      if (qt <= 0) continue;
      for (long nt = 0; nt < qt; ++nt) {
        // Sample the energy transfer in this collision.
        const double r = sampleTransfer(pcm, etcs->fadda[na][ns], SRANLUX());
        // Convert to internal units.
        const double et = r * MeV;
        m_edep += et;
        if (m_print_listing) Iprint2n(mcout, nt, et);
        // Sample the position of the collision.
        const double arange = SRANLUX() * range;
        point pt = m_prevpos.pt + dir * arange;
        if (m_loss_only) continue;
        if (m_print_listing) mcout << "generating new cluster\n";
        if (m_store_clusters) {
          m_clusterBank.emplace_back(HeedCluster(et, pt, na, ns));
        }
        // Generate a virtual photon.
        double theta_p, theta_t;
        theta_two_part(ep, ep - et, mp, mt, theta_p, theta_t);
        vec vel;
        vel.random_conic_vec(fabs(theta_t));
        vel.down(&tempbas);  // direction is OK
        vel *= c_light;
        const double t = m_prevpos.time + arange * invSpeed;
        if (m_print_listing) mcout << "generating new virtual photon\n";
        HeedPhoton* hp = new HeedPhoton(m_currpos.tid.eid[0], pt, vel, t,
                                        m_particle_number, et, m_fieldMap);
        if (!hp->alive()) {
          delete hp;
          continue;
        }
        hp->m_photon_absorbed = true;
        hp->m_delta_generated = false;
        hp->m_na_absorbing = na;
        hp->m_ns_absorbing = ns;
        secondaries.push_back(hp);
      }
    }
  }
 
  if (m_edep >= m_curr_ekin) {
    // Accumulated energy loss exceeds the particle's kinetic energy.
    m_alive = false;
  } 
 
  if (m_coulomb_scattering) {
    if (hmd->radiation_length > 0.) {
      const double x = range / hmd->radiation_length;
      const double sigma = etcs->sigma_ms * sqrt(x);
      double theta = sigma * rnorm_improved();
      turn(cos(theta), sin(theta));
    }
  }
  if (m_print_listing) {
    Iprintn(mcout, m_edep);
    mcout << "Exiting HeedParticle::physics\n";
  }
}

◆ physics_mrange()

void Heed::HeedParticle::physics_mrange ( double & fmrange )

overrideprotectedvirtual

Reduce the maximal possible range due to continuous processes. Called from calc_step_to_bord after the call of curvature. but before considering the crossing with volumes. Therefore mrange may be reduced after this.

Reimplemented from Heed::gparticle.

Definition at line 138 of file HeedParticle.cpp.

                                                 {
  if (!m_coulomb_scattering) return;
  // Get local volume and convert it to a cross-section object.
  const absvol* av = m_currpos.volume();
  auto etcs = dynamic_cast<const EnTransfCS*>(av);
  if (!etcs) return;
  if (etcs->quanC > 0.) {
    // Make sure the step is smaller than the mean free path between 
    // ionising collisions.
    fmrange = std::min(fmrange, 0.1 / etcs->quanC);
  }
} 

◆ print()

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

overridevirtual

Print-out.

Reimplemented from Heed::eparticle.

Definition at line 151 of file HeedParticle.cpp.

                                                      {
  if (l < 0) return;
  file << "HeedParticle: particle_number=" << m_particle_number << " type=";
  if (!m_pardef) {
    file << "none";
  } else {
    file << m_pardef->notation;
  }
  file << "\n  edep=" << m_edep << "\n";
  if (l <= 1) return;
  mparticle::print(file, l - 1);
}

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HeedParticle() [1/2]

◆ HeedParticle() [2/2]

◆ ~HeedParticle()

Member Function Documentation

◆ copy()

◆ physics()

◆ physics_mrange()

◆ print()