Heed::gparticle Class Reference

#include <gparticle.h>

Inheritance diagram for Heed::gparticle:

Public Member Functions
	gparticle ()
	Default constructor.
	gparticle (manip_absvol *primvol, const point &pt, const vec &vel, vfloat time)
	Constructor.
virtual	~gparticle ()
	Destructor.
virtual void	step (std::vector< gparticle * > &secondaries)
virtual void	change_vol (void)
virtual void	curvature (int &fs_cf, vec &frelcen, vfloat &fmrange, vfloat prec)
virtual void	physics_after_new_speed (std::vector< gparticle * > &)
virtual void	physics (std::vector< gparticle * > &)
virtual void	physics_mrange (double &fmrange)
virtual stvpoint	calc_step_to_bord ()
	Produces nextpos.
stvpoint	switch_new_vol ()
virtual void	fly (std::vector< gparticle * > &secondaries)
	Transport the particle.
virtual void	print (std::ostream &file, int l) const
virtual gparticle *	copy () const
Public Member Functions inherited from Heed::RegPassivePtr
	RegPassivePtr (void)
	RegPassivePtr (char fs_ban_del, char fs_ban_sub, char fs_ban_cop=0)
	RegPassivePtr (const RegPassivePtr &f)
RegPassivePtr &	operator= (const RegPassivePtr &f)
CountPP_ns::CountPassivePtr *	book (void) const
void	clear_pointers (void) const
virtual RegPassivePtr *	copy () const
virtual	~RegPassivePtr ()
virtual void	print (std::ostream &file, int l=1) const
void	set_s_ban_del (char fs_ban_del)
char	get_s_ban_del (void) const
void	set_s_ban_sub (char fs_ban_sub)
char	get_s_ban_sub (void) const
void	set_s_ban_cop (char fs_ban_cop)
char	get_s_ban_cop (void) const
void	set_s_allow_del_at_zero_count (char fs_allow_del_at_zero_count)
char	get_s_allow_del_at_zero_count (void) const
long	get_total_number_of_references (void) const

Public Attributes
bool	s_life
long	nstep
	Step number.
double	total_range_from_origin
	Range from origin to currpos.
long	n_zero_step
	Number of previous steps with zero range (including this step).
stvpoint	origin
stvpoint	prevpos
stvpoint	currpos
stvpoint	nextpos
vec	curr_relcen

Static Public Attributes
static long	max_q_zero_step = 100

Additional Inherited Members
Static Public Member Functions inherited from Heed::RegPassivePtr
static void	set_s_ban_del_ignore (char fs_ban_del_ignore)
static char	get_s_ban_del_ignore (void)
static void	set_s_print_adr_cpp (char fs_print_adr_cpp)
static char	get_s_print_adr_cpp (void)

Detailed Description

"Geometric particle" (particle which does not interact with materials). It moves along a polyline line or circle from one volume to another. The flying is represented by changing of class members representing particle position. Interacted particle should be derived class from this one.

Definition at line 156 of file gparticle.h.

Constructor & Destructor Documentation

gparticle() [1/2]

Heed::gparticle::gparticle ( )

inline

Default constructor.

Definition at line 159 of file gparticle.h.

: s_life(false), nstep(0) {}

Referenced by copy().

gparticle() [2/2]

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

Constructor.

Definition at line 43 of file gparticle.cpp.

    : s_life(false),
      nstep(0),
      total_range_from_origin(0.0),
      n_zero_step(0),
      prevpos(),
      nextpos() {
  // As far as I can now understand, PassivePtr<primvol> will be at
  // origin.tid.eid[0]
  mfunname("gparticle::gparticle(...)");
  primvol->m_find_embed_vol(pt, vel, &origin.tid);
  origin.pt = pt;
  if (vel == dv0) {
    origin.dir = dv0;
    origin.speed = 0.0;
  } else {
    origin.dir = unit_vec(vel);
    origin.speed = vel.length();
  }
  origin.ptloc = origin.pt;
  origin.tid.up_absref(&origin.ptloc);
  origin.dirloc = origin.dir;
  origin.tid.up_absref(&origin.dirloc);
  origin.time = time;
  origin.sb = 0;
  origin.s_ent = 1;
  if (origin.tid.eid.empty()) return;
  s_life = true;
  currpos = origin;
  nextpos = currpos;
  nextpos.s_ent = 0;
}

~gparticle()

virtual Heed::gparticle::~gparticle ( )

inlinevirtual

Destructor.

Definition at line 164 of file gparticle.h.

{}

Member Function Documentation

calc_step_to_bord()

stvpoint Heed::gparticle::calc_step_to_bord ( )

virtual

Produces nextpos.

Definition at line 119 of file gparticle.cpp.

                                      {
  pvecerror("stvpoint gparticle::calc_step_to_bord()");
  curr_relcen = dv0;
  if (currpos.sb > 0) {
    // it does not do step, but switch to new volume
    return switch_new_vol();
  }
  int s_cf;
  vec relcen;
  vfloat mrange;
  curvature(s_cf, relcen, mrange, gtrajlim.max_straight_arange);
  curr_relcen = relcen;
  if (mrange <= 0) {
    // preserves currpos for modification by physics
    stvpoint temp(currpos);
    temp.s_ent = 0;
    return temp;
  }
  currpos.tid.up_absref(&relcen);  // changing to local system
  physics_mrange(mrange);
  trajestep ts(&gtrajlim, currpos.ptloc, currpos.dirloc, s_cf, relcen, mrange,
               currpos.tid.eid.back()->Gavol()->prec);
  if (ts.mrange <= 0) {
    stvpoint temp(currpos);
    temp.s_ent = 0;
    return temp;
  }
  // Here the range is calculated:
  int sb;
  // manip_absvol_eid faeid;
  PassivePtr<manip_absvol> faeid;
  currpos.tid.G_lavol()->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(currpos, ts, sb, 0, faeid);
  }
  return stvpoint(currpos, ts, ts.mrange, sb, 0, faeid);
}

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

change_vol()

virtual void Heed::gparticle::change_vol ( void  )

inlinevirtual

Definition at line 194 of file gparticle.h.

{ currpos.tid.G_lavol()->income(this); }

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

copy()

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

inlinevirtual

Reimplemented from Heed::RegPassivePtr.

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

Definition at line 233 of file gparticle.h.

{ return new gparticle(*this); }

curvature()

void Heed::gparticle::curvature ( int &  fs_cf, vec &  frelcen, vfloat &  fmrange, vfloat  prec  )

virtual

Reimplemented in Heed::mparticle.

Definition at line 99 of file gparticle.cpp.

                                    {
  fs_cf = 0;
  frelcen = vec(0, 0, 0);
  fmrange = max_vfloat;
  /* The following is for debug
  vec field(0,1,0);
  vfloat rad = 10;
  if (length(currpos.dir) > 0 && check_par(currpos.dir, field) == 0) {
    fs_cf = 1;
    vfloat coef = sin2vec(currpos.dir, field);
    rad = rad / coef;
    frelcen = unit_vec(currpos.dir || field) * rad;
  }
  */
}

Referenced by calc_step_to_bord().

fly()

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

inlinevirtual

Transport the particle.

Definition at line 225 of file gparticle.h.

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

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

physics()

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

inlinevirtual

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

Definition at line 210 of file gparticle.h.

{}

Referenced by fly().

physics_after_new_speed()

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

inlinevirtual

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

Definition at line 207 of file gparticle.h.

{}

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

physics_mrange()

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

virtual

Reimplemented in Heed::HeedDeltaElectron.

Definition at line 116 of file gparticle.cpp.

{}

Referenced by calc_step_to_bord().

print()

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

virtual

Reimplemented from Heed::RegPassivePtr.

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

Definition at line 200 of file gparticle.cpp.

                                                   {
  if (l < 0) return;
  Ifile << "gparticle(l=" << l << "): s_life=" << s_life << " nstep=" << nstep
        << " total_range_from_origin=" << total_range_from_origin
        << " n_zero_step=" << n_zero_step << '\n';
  if (l == 1) {
    file.flush();
    return;
  }
  indn.n += 2;
  if (l - 5 >= 0) {
    Ifile << "origin point:\n";
    indn.n += 2;
    origin.print(file, l - 2);
    indn.n -= 2;
  }
  if (l - 4 >= 0) {
    Ifile << "previous point:\n";
    indn.n += 2;
    prevpos.print(file, l - 1);
    indn.n -= 2;
  }
  if (l - 2 >= 0) {
    Ifile << "current point:\n";
    indn.n += 2;
    currpos.print(file, l);
    Iprint(file, curr_relcen);
    Ifile << " length(curr_relcen)=" << curr_relcen.length() << '\n';
    indn.n -= 2;
  }
  if (l - 3 >= 0) {
    Ifile << "next point:\n";
    indn.n += 2;
    nextpos.print(file, l - 1);
    indn.n -= 2;
  }
  indn.n -= 2;
  file.flush();
}

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

step()

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

virtual

Assign prevpos = currpos and currpos = nextpos, calls change_vol if necessary and update nextpos =calc_step_to_bord().

Reimplemented in Heed::mparticle.

Definition at line 77 of file gparticle.cpp.

                                                       {
  // Make step to nextpos and calculate new step to border
  mfunname("void gparticle::step()");
  prevpos = currpos;
  currpos = nextpos;
  curr_relcen = dv0;
  total_range_from_origin += currpos.prange;
  nstep++;
  if (currpos.prange == 0) {
    n_zero_step++;
    check_econd12a(n_zero_step, >, max_q_zero_step,
                   "too much zero steps, possible infinite loop\n", mcerr);
  } else {
    n_zero_step = 0;
  }
  physics_after_new_speed(secondaries);
  if (s_life) {
    if (prevpos.tid != currpos.tid) change_vol();
    nextpos = calc_step_to_bord();
  }
}

Referenced by fly().

switch_new_vol()

stvpoint Heed::gparticle::switch_new_vol

(

void

)

Definition at line 160 of file gparticle.cpp.

                                       {
  // generates next position in new volume
  mfunname("stvpoint gparticle::switch_new_vol(void)");
  manip_absvol_treeid tidl;
  PassivePtr<manip_absvol> eidl;
  stvpoint nextp = currpos;
  point pth = nextp.pt;
  // search from primary
  // In this case it does not necessary 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()) {
      s_life = 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.tid.G_lavol()->prec;
      if (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().

Member Data Documentation

curr_relcen

vec Heed::gparticle::curr_relcen

Definition at line 181 of file gparticle.h.

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

currpos

stvpoint Heed::gparticle::currpos

Definition at line 177 of file gparticle.h.

Referenced by calc_step_to_bord(), change_vol(), Heed::mparticle::check_consistency(), Heed::mparticle::curvature(), Garfield::TrackHeed::GetCluster(), gparticle(), Heed::mparticle::mparticle(), Heed::mparticle::new_speed(), Heed::HeedParticle::physics(), Heed::HeedParticle_BGM::physics(), Heed::HeedPhoton::physics(), Heed::HeedDeltaElectron::physics_after_new_speed(), Heed::HeedPhoton::physics_after_new_speed(), Heed::HeedDeltaElectron::physics_mrange(), print(), step(), Heed::mparticle::step(), switch_new_vol(), and Garfield::TrackHeed::TransportPhoton().

max_q_zero_step

long Heed::gparticle::max_q_zero_step = 100

static

Definition at line 174 of file gparticle.h.

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

n_zero_step

long Heed::gparticle::n_zero_step

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

Definition at line 172 of file gparticle.h.

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

nextpos

stvpoint Heed::gparticle::nextpos

Definition at line 178 of file gparticle.h.

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

nstep

long Heed::gparticle::nstep

Step number.

Definition at line 168 of file gparticle.h.

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

origin

stvpoint Heed::gparticle::origin

Definition at line 175 of file gparticle.h.

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

prevpos

stvpoint Heed::gparticle::prevpos

Definition at line 176 of file gparticle.h.

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

s_life

bool Heed::gparticle::s_life

Definition at line 166 of file gparticle.h.

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

total_range_from_origin

double Heed::gparticle::total_range_from_origin

Range from origin to currpos.

Definition at line 170 of file gparticle.h.

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

---

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

• gparticle.h
• gparticle.cpp