#include <gparticle.h>

Inheritance diagram for Heed::gparticle:

Public Member Functions
	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?

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

virtual gparticle *	copy () const
	Clone the particle.

Static Public Member Functions
static void	reset_counter ()
	Reset the counter.

Protected Member Functions
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.

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

stvpoint	switch_new_vol ()
	Generate next position in new volume.

Protected Attributes
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
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

"Geometric particle" (particle that does not interact with materials). It moves along a polyline or circle from one volume to another. Classes for interacting particles should be derived from this base class.

Definition at line 147 of file gparticle.h.

Constructor & Destructor Documentation

◆ gparticle() [1/2]

Heed::gparticle::gparticle ( )

default

Default constructor.

Referenced by copy(), Heed::HeedPhoton::HeedPhoton(), and Heed::mparticle::mparticle().

◆ gparticle() [2/2]

Heed::gparticle::gparticle	(	manip_absvol *	primvol,
		const point &	pt,
		const vec &	vel,
		vfloat	time )

Constructor.

Definition at line 42 of file gparticle.cpp.

    : m_prevpos(),
      m_nextpos() {
  mfunname("gparticle::gparticle(...)");
  primvol->m_find_embed_vol(pt, vel, &m_origin.tid);
  m_origin.pt = pt;
  if (vel == dv0) {
    m_origin.dir = dv0;
    m_origin.speed = 0.0;
  } else {
    m_origin.dir = unit_vec(vel);
    m_origin.speed = vel.length();
  }
  m_origin.ptloc = m_origin.pt;
  m_origin.tid.up_absref(&m_origin.ptloc);
  m_origin.dirloc = m_origin.dir;
  m_origin.tid.up_absref(&m_origin.dirloc);
  m_origin.time = ftime;
  m_origin.sb = 0;
  m_origin.s_ent = 1;
  if (m_origin.tid.eid.empty()) return;
  m_alive = true;
  m_currpos = m_origin;
  m_nextpos = m_currpos;
  m_nextpos.s_ent = 0;
}

◆ ~gparticle()

virtual Heed::gparticle::~gparticle ( )

inlinevirtual

Destructor.

Definition at line 155 of file gparticle.h.

155{}

Member Function Documentation

◆ alive()

bool Heed::gparticle::alive ( ) const

inline

Alive?

Definition at line 195 of file gparticle.h.

195{ return m_alive; }

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

◆ calc_step_to_bord()

stvpoint Heed::gparticle::calc_step_to_bord ( )

protectedvirtual

Determine next position.

Definition at line 112 of file gparticle.cpp.

                                      {
  // Calculate next point as step to border.
  pvecerror("stvpoint gparticle::calc_step_to_bord()");
  if (m_currpos.sb > 0) {
    // Just switch to new volume.
    return switch_new_vol();
  }
  bool curved = false;
  vec relcen;
  vfloat mrange;
  curvature(curved, relcen, mrange, m_max_straight_arange);
  if (mrange <= 0) {
    // Preserve current point for modification by physics.
    stvpoint temp(m_currpos);
    temp.s_ent = 0;
    return temp;
  }
  // Change to local system.
  m_currpos.tid.up_absref(&relcen);  
  physics_mrange(mrange);
  trajestep ts(m_max_range, m_rad_for_straight, 
               m_max_straight_arange, m_max_circ_arange, 
               m_currpos.ptloc, m_currpos.dirloc, curved, relcen, mrange,
               m_currpos.tid.eid.back()->Gavol()->prec);
  if (ts.mrange <= 0) {
    stvpoint temp(m_currpos);
    temp.s_ent = 0;
    return temp;
  }
  // Here the range is calculated:
  int sb;
  manip_absvol* faeid = nullptr;
  m_currpos.volume()->range(ts, 1, sb, faeid);
  // 1 means inside the volume and makes
  // the program checking embraced volumes
  if (ts.s_prec == 0) {
    // Point is crossed.
    return stvpoint(m_currpos, ts, sb, 0, faeid);
  }
  return stvpoint(m_currpos, ts, ts.mrange, sb, 0, faeid);
}

Referenced by step(), and Heed::mparticle::step().

◆ change_vol()

virtual void Heed::gparticle::change_vol ( )

inlineprotectedvirtual

Move from one volume to another.

Definition at line 217 of file gparticle.h.

217{ m_currpos.volume()->income(this); }

Referenced by step(), and Heed::mparticle::step().

◆ copy()

virtual gparticle * Heed::gparticle::copy ( ) const

inlinevirtual

Clone the particle.

Reimplemented in Heed::eparticle, Heed::HeedDeltaElectron, Heed::HeedParticle, Heed::HeedParticle_BGM, Heed::HeedPhoton, and Heed::mparticle.

Definition at line 203 of file gparticle.h.

203{ return new gparticle(*this); }

Heed::gparticle::gparticle

gparticle()=default

Default constructor.

◆ curvature()

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

protectedvirtual

Set curvature. Can also change the direction at the current position.

Parameters

curved	flag whether the trajectory is curved
frelcen	position of the centre of rotation relative to currpos.
fmrange	step range
prec	tolerance for checking if the force is parallel or antiparallel to dir. In the latter case, the range is restricted by the end point. In calc_step_to_bord() it is set to m_max_straight_arange.

Reimplemented in Heed::mparticle.

Definition at line 91 of file gparticle.cpp.

                                    {
  curved = false;
  frelcen.x = 0.;
  frelcen.y = 0.;
  frelcen.z = 0.;
  fmrange = max_vfloat;
  /* The following is for debug
  vec field(0,1,0);
  vfloat rad = 10;
  if (length(m_currpos.dir) > 0 && check_par(m_currpos.dir, field) == 0) {
    curved = true;
    vfloat coef = sin2vec(m_currpos.dir, field);
    rad = rad / coef;
    frelcen = unit_vec(m_currpos.dir || field) * rad;
  }
  */
}

Referenced by calc_step_to_bord().

◆ direction()

const vec & Heed::gparticle::direction ( ) const

inline

Get the current direction of the particle.

Definition at line 193 of file gparticle.h.

193{ return m_currpos.dir; }

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

◆ fly() [1/2]

virtual void Heed::gparticle::fly ( std::vector< gparticle * > & secondaries )

inlinevirtual

Transport the particle.

Definition at line 158 of file gparticle.h.

                                                       {
    mfunname("virtual void gparticle::fly()");
    while (m_alive) {
      step(secondaries);
      physics(secondaries);
    }
  }

Referenced by Garfield::TrackHeed::NewTrack(), Garfield::TrackHeed::TransportDeltaElectron(), and Garfield::TrackHeed::TransportPhoton().

◆ fly() [2/2]

virtual void Heed::gparticle::fly	(	std::vector< gparticle * > &	secondaries,
		const bool	one_step )

inlinevirtual

Definition at line 166 of file gparticle.h.

                                                                            {
    mfunname("virtual void gparticle::fly()");
    int nstep = 0;
    while (m_alive) {
      step(secondaries);
      physics(secondaries);
      ++nstep;
      if (one_step && nstep >= 2) break;
    }
  }

◆ physics()

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

inlineprotectedvirtual

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

Reimplemented in Heed::HeedParticle, Heed::HeedParticle_BGM, and Heed::HeedPhoton.

Definition at line 238 of file gparticle.h.

238{}

Referenced by fly(), and fly().

◆ physics_after_new_speed()

virtual void Heed::gparticle::physics_after_new_speed ( std::vector< gparticle * > & )

inlineprotectedvirtual

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

Reimplemented in Heed::HeedDeltaElectron, and Heed::HeedPhoton.

Definition at line 235 of file gparticle.h.

235{}

Referenced by step(), and Heed::mparticle::step().

◆ physics_mrange()

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

protectedvirtual

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 in Heed::HeedDeltaElectron, and Heed::HeedParticle.

Definition at line 110 of file gparticle.cpp.

110{}

Referenced by calc_step_to_bord().

◆ position()

const vec & Heed::gparticle::position ( ) const

inline

Get the current position of the particle.

Definition at line 189 of file gparticle.h.

189{ return m_currpos.pt.v; }

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

◆ print()

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

virtual

Print-out.

Reimplemented in Heed::eparticle, Heed::HeedDeltaElectron, Heed::HeedParticle, Heed::HeedParticle_BGM, Heed::HeedPhoton, and Heed::mparticle.

Definition at line 208 of file gparticle.cpp.

                                                   {
  if (l < 0) return;
  Ifile << "gparticle(l=" << l << "): alive=" << m_alive << " nstep=" << m_nstep
        << " total_range_from_origin=" << m_total_range_from_origin
        << " nzero_step=" << m_nzero_step << '\n';
  if (l <= 1) return;
  indn.n += 2;
  if (l - 5 >= 0) {
    Ifile << "origin point:\n";
    indn.n += 2;
    m_origin.print(file, l - 2);
    indn.n -= 2;
  }
  if (l - 4 >= 0) {
    Ifile << "previous point:\n";
    indn.n += 2;
    m_prevpos.print(file, l - 1);
    indn.n -= 2;
  }
  if (l - 2 >= 0) {
    Ifile << "current point:\n";
    indn.n += 2;
    m_currpos.print(file, l);
     indn.n -= 2;
  }
  if (l - 3 >= 0) {
    Ifile << "next point:\n";
    indn.n += 2;
    m_nextpos.print(file, l - 1);
    indn.n -= 2;
  }
  indn.n -= 2;
  file.flush();
}

Referenced by Heed::HeedPhoton::print(), and Heed::mparticle::print().

◆ reset_counter()

static void Heed::gparticle::reset_counter ( )

inlinestatic

Reset the counter.

Definition at line 198 of file gparticle.h.

198{ s_counter = 0L; }

Heed::gparticle::s_counter

static std::atomic< long > s_counter

Instance counter.

Definition gparticle.h:256

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

◆ set_step_limits()

void Heed::gparticle::set_step_limits	(	const vfloat	fmax_range,
		const vfloat	frad_for_straight,
		const vfloat	fmax_straight_arange,
		const vfloat	fmax_circ_arange )

inline

Set limits/parameters for trajectory steps.

Definition at line 178 of file gparticle.h.

                                                      {
    m_max_range = fmax_range;
    m_rad_for_straight = frad_for_straight;
    m_max_straight_arange = fmax_straight_arange;
    m_max_circ_arange = fmax_circ_arange;
  }

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

◆ step()

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

protectedvirtual

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 in Heed::mparticle.

Definition at line 70 of file gparticle.cpp.

                                                       {
  // Make step to next point and calculate new step to border.
  mfunname("void gparticle::step()");
  m_prevpos = m_currpos;
  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", mcerr);
  } else {
    m_nzero_step = 0;
  }
  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 fly(), and fly().

◆ switch_new_vol()

stvpoint Heed::gparticle::switch_new_vol ( )

protected

Generate next position in new volume.

Definition at line 168 of file gparticle.cpp.

                                   {
  // Generate next position in new volume.
  mfunname("stvpoint gparticle::switch_new_vol(void)");
  manip_absvol_treeid tidl;
  manip_absvol* eidl = nullptr;
  stvpoint nextp = m_currpos;
  point pth = nextp.pt;
  // Search from primary
  // In this case it does not necessarily switch to encountered volume
  // namely nextp.next_eid
  // Borders of two volumes may coincide. Thus it should look for
  // the deepest volume at this point.
  bool ok = false;
  while (!ok) {
    nextp.tid.eid[0]->m_find_embed_vol(pth, nextp.dir, &tidl);
    if (tidl.eid.empty()) {
      m_alive = false;
      break;
    }
    // By default, assume switching to new volume.
    int s_e = 1;
    if (tidl == nextp.tid) {
      // Remains in the same old volume, may be numerical error
      // Will probably repeat attempt to switch at the same steps until ok.
      s_e = 0;
      double curprec = nextp.volume()->prec;
      if (m_currpos.prange <= curprec) {
        // very bad case, to repeat the trial.
        vec additional_dist = nextp.dir * curprec;
        pth = pth + additional_dist;
        tidl = manip_absvol_treeid();
        continue;
      }
    }
    return stvpoint(pth, nextp.dir, nextp.speed, tidl, 0.0, nextp.time, 0, s_e,
                    eidl);
  }
  return stvpoint();
}

Referenced by calc_step_to_bord().

◆ time()

vfloat Heed::gparticle::time ( ) const

inline

Get the current time of the particle.

Definition at line 191 of file gparticle.h.

191{ return m_currpos.time; }

Referenced by Heed::eparticle::eparticle(), gparticle(), Heed::HeedPhoton::HeedPhoton(), and Garfield::TrackHeed::TransportPhoton().

◆ turn()

void Heed::gparticle::turn	(	const double	ctheta,
		const double	stheta )

protected

Change the direction of the particle.

Definition at line 154 of file gparticle.cpp.

                                                             {
 
  vec dir = m_currpos.dir;
  basis temp(dir, "temp");
  vec vturn;
  vturn.random_round_vec();
  vturn = vturn * stheta;
  vec new_dir(vturn.x, vturn.y, ctheta);
  new_dir.down(&temp);
  m_currpos.dir = new_dir;
  m_currpos.dirloc = m_currpos.dir;
  m_currpos.tid.up_absref(&m_currpos.dirloc);
}

Referenced by Heed::HeedParticle::physics(), and Heed::HeedDeltaElectron::physics_after_new_speed().

Member Data Documentation

◆ m_alive

bool Heed::gparticle::m_alive = false

protected

Status flag whether the particle is active.

Definition at line 259 of file gparticle.h.

Referenced by alive(), fly(), fly(), gparticle(), Heed::HeedParticle::physics(), Heed::HeedParticle_BGM::physics(), Heed::HeedDeltaElectron::physics_after_new_speed(), Heed::HeedPhoton::physics_after_new_speed(), print(), step(), Heed::mparticle::step(), and switch_new_vol().

◆ m_currpos

stvpoint Heed::gparticle::m_currpos

protected

◆ m_max_qzero_step

long Heed::gparticle::m_max_qzero_step = 100

staticconstexprprotected

Max. number of zero-steps allowed.

Definition at line 264 of file gparticle.h.

Referenced by step(), and Heed::mparticle::step().

◆ m_nextpos

stvpoint Heed::gparticle::m_nextpos

protected

Next point.

Definition at line 278 of file gparticle.h.

Referenced by gparticle(), Heed::HeedPhoton::physics(), print(), step(), and Heed::mparticle::step().

◆ m_nstep

long Heed::gparticle::m_nstep = 0

protected

Step number.

Definition at line 262 of file gparticle.h.

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

◆ m_nzero_step

long Heed::gparticle::m_nzero_step = 0

protected

Number of previous steps with zero range (including this step).

Definition at line 266 of file gparticle.h.

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

◆ m_origin

stvpoint Heed::gparticle::m_origin

protected

Original point.

Definition at line 269 of file gparticle.h.

Referenced by gparticle(), Heed::mparticle::mparticle(), and print().

◆ m_prevpos

stvpoint Heed::gparticle::m_prevpos

protected

Previous point.

Definition at line 274 of file gparticle.h.

Referenced by gparticle(), Heed::mparticle::mparticle(), Heed::HeedParticle::physics(), Heed::HeedParticle_BGM::physics(), print(), step(), and Heed::mparticle::step().

◆ m_total_range_from_origin

double Heed::gparticle::m_total_range_from_origin = 0.

protected

Range from origin to current position.

Definition at line 271 of file gparticle.h.

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

◆ s_counter

std::atomic< long > Heed::gparticle::s_counter {0L}

staticprotected

Instance counter.

Definition at line 256 of file gparticle.h.

Referenced by Heed::HeedDeltaElectron::HeedDeltaElectron(), Heed::HeedParticle::HeedParticle(), Heed::HeedParticle_BGM::HeedParticle_BGM(), Heed::HeedPhoton::HeedPhoton(), and reset_counter().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ gparticle() [1/2]

◆ gparticle() [2/2]

◆ ~gparticle()

Member Function Documentation

◆ alive()

◆ calc_step_to_bord()

◆ change_vol()

◆ copy()

◆ curvature()

◆ direction()

◆ fly() [1/2]

◆ fly() [2/2]

◆ physics()

◆ physics_after_new_speed()

◆ physics_mrange()

◆ position()

◆ print()

◆ reset_counter()

◆ set_step_limits()

◆ step()

◆ switch_new_vol()

◆ time()

◆ turn()

Member Data Documentation

◆ m_alive

◆ m_currpos

◆ m_max_qzero_step

◆ m_nextpos

◆ m_nstep

◆ m_nzero_step

◆ m_origin

◆ m_prevpos

◆ m_total_range_from_origin

◆ s_counter