Heed::box Class Reference

#include <box.h>

Inheritance diagram for Heed::box:

Public Member Functions
	box ()
	Default constructor.
	box (vfloat fdx, vfloat fdy, vfloat fdz, const std::string &fname)
	box (vfloat fdx, vfloat fdy, vfloat fdz, vfloat fprec, const std::string &fname)
	Constructor with user-provided precision.
	box (box &fb)
	box (const box &fb)
virtual	~box ()
	Destructor.
void	init_prec ()
void	init_planes ()
int	check_point_inside (const point &fpt, const vec &dir) const override
int	range_ext (trajestep &fts, int s_ext) const override
	Range till exit from given volume or to entry only.
void	income (gparticle *gp) override
void	chname (char *nm) const override
void	print (std::ostream &file, int l) const override
box *	copy () const override
Public Member Functions inherited from Heed::absvol
virtual	~absvol ()
	Destructor.
virtual int	check_point_inside (const point &fpt, const vec &dir) const =0
virtual int	find_embed_vol (const point &fpt, const vec &dir, manip_absvol_treeid *atid) const
virtual int	range (trajestep &fts, int s_ext, int &sb, manip_absvol *&faeid) const
virtual int	range_ext (trajestep &fts, int s_ext) const =0
virtual void	income (gparticle *)
virtual void	chname (char *nm) const
virtual void	print (std::ostream &file, int l) const
virtual absvol *	copy () const
virtual std::vector< manip_absvol * >	Gamanip_embed () const
Public Member Functions inherited from Heed::absref
virtual	~absref ()
	Destructor.
virtual void	down (const abssyscoor *fasc)
	Convert numbering representation of object to basical system of fasc.
virtual void	up (const abssyscoor *fasc)
	Convert numbering representation of objects to new system.
virtual void	turn (const vec &dir, vfloat angle)
	Turn around axis doing via center of coordinate system along dir.
virtual void	shift (const vec &dir)

Public Attributes
vfloat	m_dx
vfloat	m_dy
vfloat	m_dz
	Lengths of sides.
vfloat	m_dxh
vfloat	m_dyh
vfloat	m_dzh
	Half-lengths of sides.
ulsvolume	m_ulsv
std::string	m_name
Public Attributes inherited from Heed::absvol
vfloat	prec
bool	s_sensitive

Protected Member Functions
absref_transmit	get_components () override

Detailed Description

Box (three-dimensional rectangle/rectangular parallelogram). The box is centred with respect to the centre of the coordinate system.

Definition at line 25 of file box.h.

Constructor & Destructor Documentation

box() [1/5]

Heed::box::box

(

)

Default constructor.

Definition at line 26 of file box.cpp.

    : m_dx(0), m_dy(0), m_dz(0), m_dxh(0), m_dyh(0), m_dzh(0), m_name("none") {
  mfunname("box::box()");
  init_prec();
  init_planes();
}

Referenced by copy().

box() [2/5]

Heed::box::box	(	vfloat	fdx,
		vfloat	fdy,
		vfloat	fdz,
		const std::string &	fname
	)

Definition at line 33 of file box.cpp.

                                                                   {
  pvecerror("box(vfloat fdx, vfloat fdy, vfloat fdz, const string &fname)");
  m_dx = fabs(fdx);
  m_dy = fabs(fdy);
  m_dz = fabs(fdz);
  m_dxh = 0.5 * m_dx;
  m_dyh = 0.5 * m_dy;
  m_dzh = 0.5 * m_dz;
  m_name = fname;
  init_prec();
  init_planes();
}

box() [3/5]

Heed::box::box	(	vfloat	fdx,
		vfloat	fdy,
		vfloat	fdz,
		vfloat	fprec,
		const std::string &	fname
	)

Constructor with user-provided precision.

Definition at line 46 of file box.cpp.

                                 {
  pvecerror("box(vfloat fdx, vfloat fdy, vfloat fdz, vfloat fprec, const string &fname)");
  m_dx = fabs(fdx);
  m_dy = fabs(fdy);
  m_dz = fabs(fdz);
  m_dxh = 0.5 * m_dx;
  m_dyh = 0.5 * m_dy;
  m_dzh = 0.5 * m_dz;
  m_name = fname;
  prec = fprec;
  init_planes();
}

box() [4/5]

Heed::box::box

(

box &

fb

)

Definition at line 60 of file box.cpp.

                : absref(fb), absvol(fb) {
  pvecerror("box(box& fb)");
  m_dx = fb.m_dx;
  m_dy = fb.m_dy;
  m_dz = fb.m_dz;
  m_dxh = 0.5 * m_dx;
  m_dyh = 0.5 * m_dy;
  m_dzh = 0.5 * m_dz;
  prec = fb.prec;
  m_name = fb.m_name;
  init_planes();
}

box() [5/5]

Heed::box::box

(

const box &

fb

)

Definition at line 73 of file box.cpp.

                      : absref(fb), absvol(fb) {
  pvecerror("box(const box& fb)");
  m_dx = fb.m_dx;
  m_dy = fb.m_dy;
  m_dz = fb.m_dz;
  m_dxh = 0.5 * m_dx;
  m_dyh = 0.5 * m_dy;
  m_dzh = 0.5 * m_dz;
  m_name = fb.m_name;
  prec = fb.prec;
  init_planes();
}

~box()

virtual Heed::box::~box ( )

inlinevirtual

Destructor.

Definition at line 43 of file box.h.

{}

Member Function Documentation

check_point_inside()

int Heed::box::check_point_inside ( const point &  fpt, const vec &  dir  ) const

overridevirtual

Check if a point is inside the volume. If two volumes are adjacent, it may happen that a point belongs to both. To avoid this confusion the parameter dir is used. If dir == (0, 0, 0), and the point is exactly on the border, the behaviour is in general not specified. If dir != (0, 0, 0), and the point is on the border with precision prec, the exiting volume is ignored.

Implements Heed::absvol.

Definition at line 109 of file box.cpp.

                                                                  {
  mfunname("virtual int check_point_inside(const point& fpt, const vec& dir)");
#ifdef TRACE_find_embed_vol
  mcout << "box::check_point_inside: \n";
  print(mcout, 1);
  mcout << "fpt=" << fpt << "dir=" << dir;
#endif
  if (dir == dv0) {
    if (fabs(fpt.v.x) <= m_dxh && fabs(fpt.v.y) <= m_dyh &&
        fabs(fpt.v.z) <= m_dzh) {
      return 1;
    }
    return 0;
  } else {
    if (fabs(fpt.v.x) <= m_dxh - prec && fabs(fpt.v.y) <= m_dyh - prec &&
        fabs(fpt.v.z) <= m_dzh - prec) {
#ifdef TRACE_find_embed_vol
      mcout << "cond 1, returning 1\n";
#endif
      return 1;
    }
    if (fabs(fpt.v.x) > m_dxh + prec || fabs(fpt.v.y) > m_dyh + prec ||
        fabs(fpt.v.z) > m_dzh + prec) {
#ifdef TRACE_find_embed_vol
      if (fabs(fpt.v.x) > m_dxh + prec) mcout << "cond 2.1 satisfied\n";
      if (fabs(fpt.v.y) > m_dyh + prec) mcout << "cond 2.2 satisfied\n";
      if (fabs(fpt.v.z) > m_dzh + prec) mcout << "cond 2.3 satisfied\n";
      mcout << "cond 2, returning 0\n";
#endif
      return 0;
    }
// What remains is point belonging to border
#ifdef IMPROVED_BOUNDARY
    // Below we detect cases when particle is exiting, leaving the
    // case when it is entering
    if (fabs(fpt.v.x) > m_dxh - prec) {
      if (dir.x == 0.0) return 0;
      if ((fpt.v.x > 0 && dir.x > 0) || (fpt.v.x < 0 && dir.x < 0)) {
#ifdef TRACE_find_embed_vol
        mcout << "cond 3, returning 0\n";
#endif
        return 0;
      }
    }
    if (fabs(fpt.v.y) > m_dyh - prec) {
      if (dir.y == 0.0) return 0;
      if ((fpt.v.y > 0 && dir.y > 0) || (fpt.v.y < 0 && dir.y < 0)) {
#ifdef TRACE_find_embed_vol
        mcout << "cond 4, returning 0\n";
#endif
        return 0;
      }
    }
    if (fabs(fpt.v.z) > m_dzh - prec) {
      if (dir.z == 0.0) return 0;
      if ((fpt.v.z > 0 && dir.z > 0) || (fpt.v.z < 0 && dir.z < 0)) {
#ifdef TRACE_find_embed_vol
        mcout << "cond 5, returning 0\n";
#endif
        return 0;
      }
    }
#ifdef TRACE_find_embed_vol
    mcout << "finish, returning 1\n";
#endif
    return 1;
 
#else
    // for IMPROVED_BOUNDARY
    // In the old version, which is below,
    // if the track is parallel to a boundary, it was interpreted as
    // signature of being inside volume.
    // The general principal, saying that
    // if particle is located at the boundary and headed
    // outside the volume,
    // it is considered in the volume to which it is headed,
    // cannot help to choose between two versions.
    // Of course, the box is convex and the particle flying along the border
    // enters the external space sooner or later and it can be regarded as
    // already outside. But the same can be said about the particle,
    // which is completely indise the volume.
    // So this principle does not work here.
    // The other principle should be applied.
    // If we allow the absolutely thing volumes (control surfaces)
    // we should use the algorithm, which, in particular stops the particle
    // crossing exactly the corner of volume without entering its inside.
    // But this does not allow to choose. So now the old (this) variant
    // is used, untill other arguments appear.
 
    if (fabs(fpt.v.x) > m_dxh - prec &&
        ((fpt.v.x > 0 && dir.x > 0) || (fpt.v.x < 0 && dir.x < 0))) {
#ifdef TRACE_find_embed_vol
      mcout << "cond 3, returning 0\n";
#endif
      return 0;  // exiting
    }
    if (fabs(fpt.v.y) > m_dyh - prec &&
        ((fpt.v.y > 0 && dir.y > 0) || (fpt.v.y < 0 && dir.y < 0))) {
#ifdef TRACE_find_embed_vol
      mcout << "cond 4, returning 0\n";
#endif
      return 0;
    }
    if (fabs(fpt.v.z) > m_dzh - prec &&
        ((fpt.v.z > 0 && dir.z > 0) || (fpt.v.z < 0 && dir.z < 0))) {
#ifdef TRACE_find_embed_vol
      mcout << "cond 5, returning 0\n";
#endif
      return 0;
    }
#ifdef TRACE_find_embed_vol
    mcout << "finish, returning 1\n";
#endif
    return 1;
#endif
  }
}

chname()

void Heed::box::chname ( char *  nm ) const

overridevirtual

Reimplemented from Heed::absvol.

Reimplemented in Heed::manip_box, and Heed::sh_manip_box.

Definition at line 265 of file box.cpp.

                               {
  strcpy(nm, "box: ");
  strcat(nm, m_name.c_str());
}

Referenced by print().

copy()

box * Heed::box::copy ( ) const

overridevirtual

Reimplemented from Heed::absvol.

Reimplemented in Heed::manip_box, and Heed::sh_manip_box.

Definition at line 262 of file box.cpp.

{ return new box(*this); }

get_components()

absref_transmit Heed::box::get_components ( )

overrideprotectedvirtual

Reimplemented from Heed::absref.

Reimplemented in Heed::sh_manip_box.

Definition at line 17 of file box.cpp.

                                    {
  mfunnamep("box::get_components(...)");
  funnw.ehdr(mcerr);
  mcerr << "one should not call this function, since this object cannot be "
           "modified\n";
  spexit(mcerr);
  return absref_transmit();
}

income()

void Heed::box::income ( gparticle *  gp )

overridevirtual

Reimplemented from Heed::absvol.

Definition at line 264 of file box.cpp.

{}

init_planes()

void Heed::box::init_planes

(

)

Definition at line 91 of file box.cpp.

                      {
  mfunname("void box::init_planes()");
  std::vector<std::shared_ptr<surface> > fsurf(6);
  fsurf[0] = std::make_shared<splane>(
      plane(point(m_dxh, 0, 0), vec(-1, 0, 0)), vec(-1, 0, 0));
  fsurf[1] = std::make_shared<splane>(
      plane(point(-m_dxh, 0, 0), vec(+1, 0, 0)), vec(+1, 0, 0));
  fsurf[2] = std::make_shared<splane>(
      plane(point(0, m_dyh, 0), vec(0, -1, 0)), vec(0, -1, 0));
  fsurf[3] = std::make_shared<splane>(
    plane(point(0, -m_dyh, 0), vec(0, +1, 0)), vec(0, +1, 0));
  fsurf[4] = std::make_shared<splane>(
    plane(point(0, 0, m_dzh), vec(0, 0, -1)), vec(0, 0, -1));
  fsurf[5] = std::make_shared<splane>(
    plane(point(0, 0, -m_dzh), vec(0, 0, +1)), vec(0, 0, +1));
  m_ulsv.ulsvolume_init(fsurf, "ulsv of box", prec);
}

Referenced by box().

init_prec()

void Heed::box::init_prec

(

)

Definition at line 86 of file box.cpp.

                    {
  prec = (m_dxh + m_dyh + m_dzh) / 3.0;
  prec *= vprecision;
}

Referenced by box().

print()

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

overridevirtual

Reimplemented from Heed::absvol.

Reimplemented in Heed::manip_box, and Heed::sh_manip_box.

Definition at line 227 of file box.cpp.

                                             {
  if (l <= 0) return;
  char s[1000];
  chname(s);
  Ifile << "box::print(l=" << l << "): " << s << '\n';
  indn.n += 2;
  Ifile << " dx=" << m_dx << " dy=" << m_dy << " dz=" << m_dz
        << " prec=" << prec << '\n';
  Ifile << " dxh=" << m_dxh << " dyh=" << m_dyh << " dzh=" << m_dzh << '\n';
  if (l >= 10) {
    l--;
    indn.n += 2;
    m_ulsv.print(file, l);
    indn.n -= 2;
  }
  absvol::print(file, l);
  indn.n -= 2;
}

Referenced by check_point_inside(), Heed::manip_box::print(), and Heed::sh_manip_box::print().

range_ext()

int Heed::box::range_ext ( trajestep &  fts, int  s_ext  ) const

overridevirtual

Range till exit from given volume or to entry only.

Implements Heed::absvol.

Definition at line 246 of file box.cpp.

                                                  {
  mfunname("virtual int box::range_ext(trajestep& fts, int s_ext) const");
  if (s_ext == 0) {
    if (fabs(fts.currpos.v.x) > m_dxh + fts.mrange) return 0;
    if (fabs(fts.currpos.v.y) > m_dyh + fts.mrange) return 0;
    if (fabs(fts.currpos.v.z) > m_dzh + fts.mrange) return 0;
  } else {
    if (fabs(fts.currpos.v.x) < m_dxh - fts.mrange &&
        fabs(fts.currpos.v.y) < m_dyh - fts.mrange &&
        fabs(fts.currpos.v.z) < m_dzh - fts.mrange) {
      return 0;
    }
  }
  return m_ulsv.range_ext(fts, s_ext);
}

Member Data Documentation

m_dx

vfloat Heed::box::m_dx

Definition at line 27 of file box.h.

Referenced by box(), and print().

m_dxh

vfloat Heed::box::m_dxh

Definition at line 28 of file box.h.

Referenced by box(), check_point_inside(), init_planes(), init_prec(), print(), and range_ext().

m_dy

vfloat Heed::box::m_dy

Definition at line 27 of file box.h.

Referenced by box(), and print().

m_dyh

vfloat Heed::box::m_dyh

Definition at line 28 of file box.h.

Referenced by box(), check_point_inside(), init_planes(), init_prec(), print(), and range_ext().

m_dz

vfloat Heed::box::m_dz

Lengths of sides.

Definition at line 27 of file box.h.

Referenced by box(), and print().

m_dzh

vfloat Heed::box::m_dzh

Half-lengths of sides.

Definition at line 28 of file box.h.

Referenced by box(), check_point_inside(), init_planes(), init_prec(), print(), and range_ext().

m_name

std::string Heed::box::m_name

Definition at line 30 of file box.h.

Referenced by box(), chname(), Heed::manip_box::chname(), and Heed::sh_manip_box::chname().

m_ulsv

ulsvolume Heed::box::m_ulsv

Definition at line 29 of file box.h.

Referenced by init_planes(), print(), and range_ext().

---

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

• box.h
• box.cpp