#include <G4DNABoundingBox.hh>

Public Member Functions
G4bool	contains (const G4DNABoundingBox &other) const

G4bool	contains (const G4ThreeVector &point) const

G4bool	contains (const G4ThreeVector &query, const G4double &radius) const

G4bool	contains (const G4ThreeVector &query, const G4ThreeVector &Point, const G4double &Radius) const

	G4DNABoundingBox ()=default

	G4DNABoundingBox (const G4DNABoundingBox &)=default

	G4DNABoundingBox (const std::initializer_list< G4double > &l)

	G4DNABoundingBox (G4DNABoundingBox &&rhs) noexcept

template<typename Iterator >
	G4DNABoundingBox (Iterator begin, Iterator end)

G4double	Getxhi () const

G4double	Getxlo () const

G4double	Getyhi () const

G4double	Getylo () const

G4double	Getzhi () const

G4double	Getzlo () const

G4double	halfSideLengthInX () const

G4double	halfSideLengthInY () const

G4double	halfSideLengthInZ () const

G4ThreeVector	middlePoint () const

G4bool	operator!= (const G4DNABoundingBox &rhs) const

G4DNABoundingBox &	operator= (const G4DNABoundingBox &)=default

G4DNABoundingBox &	operator= (G4DNABoundingBox &&hrs) noexcept

G4bool	operator== (const G4DNABoundingBox &rhs) const

G4bool	overlap (const G4DNABoundingBox &other, G4DNABoundingBox *out) const

G4bool	overlap (const G4ThreeVector &query, const G4double &radius) const

std::array< G4DNABoundingBox, 8 >	partition () const

void	resize (G4ThreeVector pics[8])

G4DNABoundingBox	translate (const G4ThreeVector &trans) const

G4double	Volume () const

	~G4DNABoundingBox ()=default

Private Attributes
G4double	fxhi

G4double	fxlo

G4double	fyhi

G4double	fylo

G4double	fzhi

G4double	fzlo

Friends
std::ostream &	operator<< (std::ostream &s, const G4DNABoundingBox &rhs)

Detailed Description

Definition at line 34 of file G4DNABoundingBox.hh.

Constructor & Destructor Documentation

◆ G4DNABoundingBox() [1/5]

G4DNABoundingBox::G4DNABoundingBox ( )

default

◆ ~G4DNABoundingBox()

G4DNABoundingBox::~G4DNABoundingBox ( )

default

◆ G4DNABoundingBox() [2/5]

template<typename Iterator >

G4DNABoundingBox::G4DNABoundingBox	(	Iterator	begin,
		Iterator	end
	)

Definition at line 111 of file G4DNABoundingBox.hh.

  : G4DNABoundingBox(initial)
{
  for(; begin != end; ++begin)
  {
    const G4ThreeVector& point = (*begin);
 
    if(point.x() < fxlo)
    {
      fxlo = point.x();
    }
    if(point.x() > fxhi)
    {
      fxhi = point.x();
    }
 
    if(point.y() < fylo)
    {
      fylo = point.y();
    }
    if(point.y() > fyhi)
    {
      fyhi = point.y();
    }
 
    if(point.z() < fzlo)
    {
      fzlo = point.z();
    }
    if(point.z() > fzhi)
    {
      fzhi = point.z();
    }
  }
}

References fxhi, fxlo, fyhi, fylo, fzhi, fzlo, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

◆ G4DNABoundingBox() [3/5]

G4DNABoundingBox::G4DNABoundingBox ( const std::initializer_list< G4double > & l )

◆ G4DNABoundingBox() [4/5]

G4DNABoundingBox::G4DNABoundingBox ( G4DNABoundingBox && rhs )

noexcept

Definition at line 34 of file G4DNABoundingBox.cc.

{
  fxhi = rhs.fxhi;
  fxlo = rhs.fxlo;
  fyhi = rhs.fyhi;
  fylo = rhs.fylo;
  fzhi = rhs.fzhi;
  fzlo = rhs.fzlo;
}

◆ G4DNABoundingBox() [5/5]

G4DNABoundingBox::G4DNABoundingBox ( const G4DNABoundingBox & )

default

Member Function Documentation

◆ contains() [1/4]

G4bool G4DNABoundingBox::contains ( const G4DNABoundingBox & other ) const

Definition at line 127 of file G4DNABoundingBox.cc.

{
  return fxlo <= other.fxlo && fxhi >= other.fxhi && fylo <= other.fylo &&
         fyhi >= other.fyhi && fzlo <= other.fzlo && fzhi >= other.fzhi;
}

References fxhi, fxlo, fyhi, fylo, fzhi, and fzlo.

Referenced by G4DNAMesh::GetKey(), and overlap().

◆ contains() [2/4]

G4bool G4DNABoundingBox::contains ( const G4ThreeVector & point ) const

Definition at line 135 of file G4DNABoundingBox.cc.

{
  return fxlo <= point.x() && fxhi >= point.x() && fylo <= point.y() &&
         fyhi >= point.y() && fzlo <= point.z() && fzhi >= point.z();
}

References fxhi, fxlo, fyhi, fylo, fzhi, fzlo, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

◆ contains() [3/4]

G4bool G4DNABoundingBox::contains	(	const G4ThreeVector &	query,
		const G4double &	radius
	)		const

Definition at line 215 of file G4DNABoundingBox.cc.

{
  G4ThreeVector temp = query - this->middlePoint();
  G4double x         = std::abs(temp.x()) + this->halfSideLengthInX();
  G4double y         = std::abs(temp.y()) + this->halfSideLengthInY();
  G4double z         = std::abs(temp.z()) + this->halfSideLengthInZ();
  G4double norm      = std::sqrt(x * x + y * y + z * z);
  return (norm < Radius);
}

References halfSideLengthInX(), halfSideLengthInY(), halfSideLengthInZ(), middlePoint(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

◆ contains() [4/4]

G4bool G4DNABoundingBox::contains	(	const G4ThreeVector &	query,
		const G4ThreeVector &	Point,
		const G4double &	Radius
	)		const

Definition at line 227 of file G4DNABoundingBox.cc.

{
  return (((query - Point).mag()) < Radius);
}

◆ Getxhi()

G4double G4DNABoundingBox::Getxhi ( ) const

inline

Definition at line 147 of file G4DNABoundingBox.hh.

147{ return fxhi; }

References fxhi.

Referenced by G4DNAMesh::FindNeighboringVoxels(), G4DNAMesh::FindVoxelNeighbors(), G4DNAMesh::GetIndex(), G4DNAMesh::GetKey(), G4Voxel::GetVolume(), Volume(), and G4DNAGillespieDirectMethod::VolumeOfNode().

◆ Getxlo()

G4double G4DNABoundingBox::Getxlo ( ) const

inline

Definition at line 150 of file G4DNABoundingBox.hh.

150{ return fxlo; }

References fxlo.

Referenced by G4DNAMesh::FindNeighboringVoxels(), G4DNAMesh::FindVoxelNeighbors(), G4DNAMesh::GetBoundingBox(), G4DNAMesh::GetIndex(), G4DNAMesh::GetKey(), G4Voxel::GetVolume(), Volume(), and G4DNAGillespieDirectMethod::VolumeOfNode().

◆ Getyhi()

G4double G4DNABoundingBox::Getyhi ( ) const

inline

Definition at line 148 of file G4DNABoundingBox.hh.

148{ return fyhi; }

References fyhi.

Referenced by G4DNAMesh::FindNeighboringVoxels(), G4DNAMesh::FindVoxelNeighbors(), G4DNAMesh::GetIndex(), G4DNAMesh::GetKey(), G4Voxel::GetVolume(), G4DNAGillespieDirectMethod::PropensityFunction(), Volume(), and G4DNAGillespieDirectMethod::VolumeOfNode().

◆ Getylo()

G4double G4DNABoundingBox::Getylo ( ) const

inline

Definition at line 151 of file G4DNABoundingBox.hh.

151{ return fylo; }

References fylo.

Referenced by G4DNAMesh::FindNeighboringVoxels(), G4DNAMesh::FindVoxelNeighbors(), G4DNAMesh::GetBoundingBox(), G4DNAMesh::GetIndex(), G4DNAMesh::GetKey(), G4Voxel::GetVolume(), G4DNAGillespieDirectMethod::PropensityFunction(), Volume(), and G4DNAGillespieDirectMethod::VolumeOfNode().

◆ Getzhi()

G4double G4DNABoundingBox::Getzhi ( ) const

inline

Definition at line 149 of file G4DNABoundingBox.hh.

149{ return fzhi; }

References fzhi.

Referenced by G4DNAMesh::FindNeighboringVoxels(), G4DNAMesh::FindVoxelNeighbors(), G4DNAMesh::GetIndex(), G4Voxel::GetVolume(), Volume(), and G4DNAGillespieDirectMethod::VolumeOfNode().

◆ Getzlo()

G4double G4DNABoundingBox::Getzlo ( ) const

inline

Definition at line 152 of file G4DNABoundingBox.hh.

152{ return fzlo; }

References fzlo.

Referenced by G4DNAMesh::FindNeighboringVoxels(), G4DNAMesh::FindVoxelNeighbors(), G4DNAMesh::GetBoundingBox(), G4DNAMesh::GetIndex(), G4DNAMesh::GetKey(), G4Voxel::GetVolume(), Volume(), and G4DNAGillespieDirectMethod::VolumeOfNode().

◆ halfSideLengthInX()

G4double G4DNABoundingBox::halfSideLengthInX ( ) const

inline

Definition at line 95 of file G4DNABoundingBox.hh.

{
  return std::abs(fxhi - fxlo) * 0.5;
}

References fxhi, and fxlo.

Referenced by contains(), and overlap().

◆ halfSideLengthInY()

G4double G4DNABoundingBox::halfSideLengthInY ( ) const

inline

Definition at line 100 of file G4DNABoundingBox.hh.

{
  return std::abs(fyhi - fylo) * 0.5;
}

References fyhi, and fylo.

Referenced by contains(), and overlap().

◆ halfSideLengthInZ()

G4double G4DNABoundingBox::halfSideLengthInZ ( ) const

inline

Definition at line 105 of file G4DNABoundingBox.hh.

{
  return std::abs(fzhi - fzlo) * 0.5;
}

References fzhi, and fzlo.

Referenced by contains(), and overlap().

◆ middlePoint()

G4ThreeVector G4DNABoundingBox::middlePoint ( ) const

inline

Definition at line 88 of file G4DNABoundingBox.hh.

{
  G4ThreeVector mid((fxhi + fxlo) / 2.0, (fyhi + fylo) / 2.0,
                    (fzhi + fzlo) / 2.0);
  return mid;
}

References fxhi, fxlo, fyhi, fylo, fzhi, and fzlo.

Referenced by contains(), and overlap().

◆ operator!=()

G4bool G4DNABoundingBox::operator!= ( const G4DNABoundingBox & rhs ) const

Definition at line 269 of file G4DNABoundingBox.cc.

{
  return !operator==(rhs);
}

References operator==().

◆ operator=() [1/2]

G4DNABoundingBox & G4DNABoundingBox::operator= ( const G4DNABoundingBox & )

default

◆ operator=() [2/2]

G4DNABoundingBox & G4DNABoundingBox::operator= ( G4DNABoundingBox && hrs )

noexcept

Definition at line 52 of file G4DNABoundingBox.cc.

{
  fxhi = rhs.fxhi;
  fxlo = rhs.fxlo;
  fyhi = rhs.fyhi;
  fylo = rhs.fylo;
  fzhi = rhs.fzhi;
  fzlo = rhs.fzlo;
  return *this;
}

References fxhi.

◆ operator==()

G4bool G4DNABoundingBox::operator== ( const G4DNABoundingBox & rhs ) const

Definition at line 259 of file G4DNABoundingBox.cc.

{
  return (fxhi == rhs.fxhi && fxlo == rhs.fxlo && fyhi == rhs.fyhi &&
          fylo == rhs.fylo && fzhi == rhs.fzhi && fzlo == rhs.fzlo) ||
         (std::isnan(fxhi) && std::isnan(rhs.fxhi) && std::isnan(fxlo) &&
          std::isnan(rhs.fxlo) && std::isnan(fyhi) && std::isnan(rhs.fyhi) &&
          std::isnan(fylo) && std::isnan(rhs.fylo) && std::isnan(fzhi) &&
          std::isnan(rhs.fzhi) && std::isnan(fzlo) && std::isnan(rhs.fzlo));
}

References fxhi, fxlo, fyhi, fylo, fzhi, and fzlo.

Referenced by operator!=().

◆ overlap() [1/2]

G4bool G4DNABoundingBox::overlap	(	const G4DNABoundingBox &	other,
		G4DNABoundingBox *	out
	)		const

Definition at line 143 of file G4DNABoundingBox.cc.

{
  if(contains(other))
  {
    *out = other;
    return true;
  }
  else if(other.contains(*this))
  {
    *out = *this;
    return true;
  }
 
  // Check if there is no intersection
  if(fxhi < other.fxlo || fxlo > other.fxhi || fyhi < other.fylo ||
     fylo > other.fyhi || fzhi < other.fzlo || fzlo > other.fzhi)
  {
    *out = invalid;
    return false;
  }
 
  G4double upperX = std::min(fxhi, other.fxhi);
  G4double upperY = std::min(fyhi, other.fyhi);
  G4double upperZ = std::min(fzhi, other.fzhi);
 
  G4double lowerX = std::max(fxlo, other.fxlo);
  G4double lowerY = std::max(fylo, other.fylo);
  G4double lowerZ = std::max(fzlo, other.fzlo);
 
  *out = G4DNABoundingBox{ upperX, lowerX, upperY, lowerY, upperZ, lowerZ };
  return true;
}

References contains(), fxhi, fxlo, fyhi, fylo, fzhi, fzlo, invalid, G4INCL::Math::max(), and G4INCL::Math::min().

◆ overlap() [2/2]

G4bool G4DNABoundingBox::overlap	(	const G4ThreeVector &	query,
		const G4double &	radius
	)		const

Definition at line 179 of file G4DNABoundingBox.cc.

{
  G4double x = query.x() - this->middlePoint().x();
  G4double y = query.y() - this->middlePoint().y();
  G4double z = query.z() - this->middlePoint().z();
 
  x = std::abs(x);
  y = std::abs(y);
  z = std::abs(z);
 
  if((x > (Radius + this->halfSideLengthInX())) ||
     (y > (Radius + this->halfSideLengthInY())) ||
     (z > (Radius + this->halfSideLengthInZ())))
  {
    return false;  //
  }
  G4int num_less_extent = (x < this->halfSideLengthInX()) +
                          (y < this->halfSideLengthInY()) +
                          (z < this->halfSideLengthInZ());
 
  if(num_less_extent > 1)
  {
    return true;
  }
 
  x = std::max(x - this->halfSideLengthInX(), 0.0);
  y = std::max(y - this->halfSideLengthInY(), 0.0);
  z = std::max(z - this->halfSideLengthInZ(), 0.0);
 
  G4double norm = std::sqrt(x * x + y * y + z * z);
 
  return (norm < Radius);
}

References halfSideLengthInX(), halfSideLengthInY(), halfSideLengthInZ(), G4INCL::Math::max(), middlePoint(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

◆ partition()

array< G4DNABoundingBox, 8 > G4DNABoundingBox::partition ( ) const

Definition at line 236 of file G4DNABoundingBox.cc.

{
  G4double xmid = (fxhi + fxlo) / 2.;
  G4double ymid = (fyhi + fylo) / 2.;
  G4double zmid = (fzhi + fzlo) / 2.;
 
  std::array<G4DNABoundingBox, 8> ret{ {
    G4DNABoundingBox{ xmid, fxlo, ymid, fylo, zmid,
                      fzlo },  // bottom left front
    G4DNABoundingBox{ fxhi, xmid, ymid, fylo, zmid,
                      fzlo },  // bottom right front
    G4DNABoundingBox{ xmid, fxlo, fyhi, ymid, zmid, fzlo },  // bottom left back
    G4DNABoundingBox{ fxhi, xmid, fyhi, ymid, zmid,
                      fzlo },  // bottom right back
    G4DNABoundingBox{ xmid, fxlo, ymid, fylo, fzhi, zmid },  // top left front
    G4DNABoundingBox{ fxhi, xmid, ymid, fylo, fzhi, zmid },  // top right front
    G4DNABoundingBox{ xmid, fxlo, fyhi, ymid, fzhi, zmid },  // top left back
    G4DNABoundingBox{ fxhi, xmid, fyhi, ymid, fzhi, zmid }   // top right back
  } };
  return ret;
}

References fxhi, fxlo, fyhi, fylo, fzhi, and fzlo.

◆ resize()

void G4DNABoundingBox::resize ( G4ThreeVector pics[8] )

Definition at line 74 of file G4DNABoundingBox.cc.

{
  for(size_t i = 0; i < 8; i++)
  {
    const G4ThreeVector& point = pics[i];
    if(point.x() < fxlo)
    {
      fxlo = point.x();
    }
    if(point.x() > fxhi)
    {
      fxhi = point.x();
    }
 
    if(point.y() < fylo)
    {
      fylo = point.y();
    }
    if(point.y() > fyhi)
    {
      fyhi = point.y();
    }
 
    if(point.z() < fzlo)
    {
      fzlo = point.z();
    }
    if(point.z() > fzhi)
    {
      fzhi = point.z();
    }
  }
}

References fxhi, fxlo, fyhi, fylo, fzhi, fzlo, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

◆ translate()

G4DNABoundingBox G4DNABoundingBox::translate ( const G4ThreeVector & trans ) const

Definition at line 110 of file G4DNABoundingBox.cc.

{
  G4DNABoundingBox output;
 
  output.fxhi = fxhi + trans.x();
  output.fxlo = fxlo + trans.x();
 
  output.fyhi = fyhi + trans.y();
  output.fylo = fylo + trans.x();
 
  output.fzhi = fzhi + trans.z();
  output.fzlo = fzlo + trans.z();
 
  return output;
}

References fxhi, fxlo, fyhi, fylo, fzhi, fzlo, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

◆ Volume()

G4double G4DNABoundingBox::Volume ( ) const

Definition at line 63 of file G4DNABoundingBox.cc.

{
  auto LengthY = this->Getyhi() - this->Getylo();
  auto LengthX = this->Getxhi() - this->Getxlo();
  auto LengthZ = this->Getzhi() - this->Getzlo();
  G4double V   = LengthY * LengthX * LengthZ;
  return V;
}

References Getxhi(), Getxlo(), Getyhi(), Getylo(), Getzhi(), and Getzlo().

Referenced by G4DNAScavengerMaterial::Dump(), G4DNAGillespieDirectMethod::FindScavenging(), and G4DNAScavengerProcess::PostStepGetPhysicalInteractionLength().

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	s,
		const G4DNABoundingBox &	rhs
	)

friend

Definition at line 275 of file G4DNABoundingBox.cc.

{
  stream << "{" << G4BestUnit(rhs.fxhi, "Length") << ", "
         << G4BestUnit(rhs.fxlo, "Length") << ", "
         << G4BestUnit(rhs.fyhi, "Length") << ", "
         << G4BestUnit(rhs.fylo, "Length") << ", "
         << G4BestUnit(rhs.fzhi, "Length") << ", "
         << G4BestUnit(rhs.fzlo, "Length") << ", "
         << "}";
  return stream;
}

Field Documentation

◆ fxhi

G4double G4DNABoundingBox::fxhi

private

Definition at line 72 of file G4DNABoundingBox.hh.

Referenced by contains(), G4DNABoundingBox(), Getxhi(), halfSideLengthInX(), middlePoint(), operator=(), operator==(), overlap(), partition(), resize(), and translate().

◆ fxlo

G4double G4DNABoundingBox::fxlo

private

Definition at line 72 of file G4DNABoundingBox.hh.

Referenced by contains(), G4DNABoundingBox(), Getxlo(), halfSideLengthInX(), middlePoint(), operator==(), overlap(), partition(), resize(), and translate().

◆ fyhi

G4double G4DNABoundingBox::fyhi

private

Definition at line 72 of file G4DNABoundingBox.hh.

Referenced by contains(), G4DNABoundingBox(), Getyhi(), halfSideLengthInY(), middlePoint(), operator==(), overlap(), partition(), resize(), and translate().

◆ fylo

G4double G4DNABoundingBox::fylo

private

Definition at line 72 of file G4DNABoundingBox.hh.

Referenced by contains(), G4DNABoundingBox(), Getylo(), halfSideLengthInY(), middlePoint(), operator==(), overlap(), partition(), resize(), and translate().

◆ fzhi

G4double G4DNABoundingBox::fzhi

private

Definition at line 72 of file G4DNABoundingBox.hh.

Referenced by contains(), G4DNABoundingBox(), Getzhi(), halfSideLengthInZ(), middlePoint(), operator==(), overlap(), partition(), resize(), and translate().

◆ fzlo

G4double G4DNABoundingBox::fzlo

private

Definition at line 72 of file G4DNABoundingBox.hh.

Referenced by contains(), G4DNABoundingBox(), Getzlo(), halfSideLengthInZ(), middlePoint(), operator==(), overlap(), partition(), resize(), and translate().

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

source/processes/electromagnetic/dna/management/include/G4DNABoundingBox.hh
source/processes/electromagnetic/dna/management/src/G4DNABoundingBox.cc

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ G4DNABoundingBox() [1/5]

◆ ~G4DNABoundingBox()

◆ G4DNABoundingBox() [2/5]

◆ G4DNABoundingBox() [3/5]

◆ G4DNABoundingBox() [4/5]

◆ G4DNABoundingBox() [5/5]

Member Function Documentation

◆ contains() [1/4]

◆ contains() [2/4]

◆ contains() [3/4]

◆ contains() [4/4]

◆ Getxhi()

◆ Getxlo()

◆ Getyhi()

◆ Getylo()

◆ Getzhi()

◆ Getzlo()

◆ halfSideLengthInX()

◆ halfSideLengthInY()

◆ halfSideLengthInZ()

◆ middlePoint()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ overlap() [1/2]

◆ overlap() [2/2]

◆ partition()

◆ resize()

◆ translate()

◆ Volume()

Friends And Related Function Documentation

◆ operator<<

Field Documentation

◆ fxhi

◆ fxlo

◆ fyhi

◆ fylo

◆ fzhi

◆ fzlo