UVector3 Struct Reference

#include <UVector3.hh>

Public Member Functions
	UVector3 ()
	UVector3 (double xval, double yval, double zval)
	UVector3 (double theta, double phi)
	UVector3 (const double coord[3])
UVector3 &	operator= (const UVector3 &v)
UVector3 &	operator= (const double *vect)
bool	operator== (const UVector3 &) const
bool	operator!= (const UVector3 &) const
UVector3	operator- () const
UVector3 &	operator+= (const UVector3 &)
UVector3 &	operator-= (const UVector3 &)
double &	operator[] (int index)
double	operator[] (int index) const
UVector3 &	operator*= (double)
UVector3 &	operator/= (double)
double	Dot (const UVector3 &) const
UVector3	Cross (const UVector3 &) const
double	Angle (const UVector3 &) const
UVector3	Unit () const
bool	IsNull () const
void	SetNull ()
void	Set (double xx, double yy, double zz)
void	Set (double xx)
double	Normalize ()
double	Phi () const
double	Theta () const
double	CosTheta () const
double	Mag2 () const
double	Mag () const
double	Perp2 () const
double	Perp () const
void	RotateX (double)
void	RotateY (double)
void	RotateZ (double)
UVector3 &	MultiplyByComponents (const UVector3 &p)

Data Fields
double	x
double	y
double	z

Detailed Description

Definition at line 28 of file UVector3.hh.

Constructor & Destructor Documentation

UVector3::UVector3 ( )

inline

Definition at line 31 of file UVector3.hh.

References x, y, and z.

Referenced by Cross(), and operator-().

    {
      x = y = z = 0.0;
    }

UVector3::UVector3 ( double  xval, double  yval, double  zval  )

inline

Definition at line 35 of file UVector3.hh.

References x, y, and z.

    {
      x = xval;
      y = yval;
      z = zval;
    }

UVector3::UVector3	(	double	theta,
		double	phi
	)

Definition at line 21 of file UVector3.cc.

References x, y, and z.

{
  // Creates a unit vector based on theta and phi angles
  x = std::sin(theta) * std::cos(phi);
  y = std::sin(theta) * std::sin(phi);
  z = std::cos(theta);
}

UVector3::UVector3 ( const double  coord[3] )

inline

Definition at line 42 of file UVector3.hh.

References x, y, and z.

    {
      x = coord[0];
      y = coord[1];
      z = coord[2];
    }

Member Function Documentation

double UVector3::Angle

(

const UVector3 &

q

)

const

Definition at line 30 of file UVector3.cc.

References UUtils::ACos(), Dot(), and Mag2().

{
  // return the angle w.r.t. another 3-vector
  double ptot2 = Mag2() * q.Mag2();
  if (ptot2 <= 0)
  {
    return 0.0;
  }
  else
  {
    double arg = Dot(q) / std::sqrt(ptot2);
    if (arg >  1.0) arg =  1.0;
    if (arg < -1.0) arg = -1.0;
    return UUtils::ACos(arg);
  }
}

double UVector3::CosTheta ( ) const

inline

Definition at line 277 of file UVector3.hh.

References Mag(), and z.

{
  double ptot = Mag();
  return ptot == 0.0 ? 1.0 : z / ptot;
}

UVector3 UVector3::Cross ( const UVector3 &  p ) const

inline

Definition at line 262 of file UVector3.hh.

References UVector3(), x, y, and z.

Referenced by UPolyhedraSide::Distance(), UPolyhedraSide::IntersectSidePlane(), UPolyconeSide::PointOnCone(), UPolyhedraSide::UPolyhedraSide(), and UTet::UTet().

{
  return UVector3(y * p.z - p.y * z, z * p.x - p.z * x, x * p.y - p.x * y);
}

double UVector3::Dot ( const UVector3 &  p ) const

inline

Definition at line 257 of file UVector3.hh.

References x, y, and z.

Referenced by Angle(), UPolyhedraSide::Distance(), UPolyPhiFace::Distance(), UPolyhedraSide::DistanceAway(), UTet::DistanceToIn(), UCons::DistanceToIn(), UPolyhedraSide::DistanceToOneSide(), UTet::DistanceToOut(), UCons::DistanceToOut(), UPolyhedraSide::Extent(), UPolyconeSide::Extent(), UTet::Inside(), UPolyPhiFace::Inside(), UPolyhedraSide::IntersectSidePlane(), VUFacet::IsInside(), UTet::Normal(), UPolyPhiFace::Normal(), operator*(), UPolyconeSide::PointOnCone(), UPolyhedraSide::Safety(), UPolyPhiFace::Safety(), UTet::SafetyFromInside(), UPolyhedraSide::UPolyhedraSide(), and UTet::UTet().

{
  return x * p.x + y * p.y + z * p.z;
}

bool UVector3::IsNull ( ) const

inline

Definition at line 234 of file UVector3.hh.

References x, y, and z.

{
  return ((std::abs(x) + std::abs(y) + std::abs(z)) == 0.0) ? true : false;
}

double UVector3::Mag

(

)

const

Definition at line 48 of file UVector3.cc.

References Mag2().

Referenced by CosTheta(), UPolyhedraSide::UPolyhedraSide(), and UTet::UTet().

{
  // return the magnitude (rho in spherical coordinate system)

  return std::sqrt(Mag2());
}

double UVector3::Mag2 ( ) const

inline

Definition at line 267 of file UVector3.hh.

References x, y, and z.

Referenced by Angle(), Mag(), Normalize(), Theta(), and Unit().

{
  return x * x + y * y + z * z;
}

UVector3 & UVector3::MultiplyByComponents ( const UVector3 &  p )

inline

Definition at line 157 of file UVector3.hh.

References x, y, and z.

{
  // Assignment of a UVector3
  x *= p.x;
  y *= p.y;
  z *= p.z;
  return *this;
}

double UVector3::Normalize

(

)

Definition at line 89 of file UVector3.cc.

References Mag2(), x, y, and z.

Referenced by UTrd::Normal().

{
  // Normalize to unit. Return normalization factor.
  double  mag = Mag2();
  if (mag == 0.0) return mag;;
  mag = std::sqrt(mag);
  x /= mag;
  y /= mag;
  z /= mag;
  return mag;
}

bool UVector3::operator!= ( const UVector3 &  v ) const

inline

Definition at line 191 of file UVector3.hh.

References x, y, and z.

{
  return (v.x != x || v.y != y || v.z != z) ? true : false;
}

UVector3 & UVector3::operator*= ( double  a )

inline

Definition at line 217 of file UVector3.hh.

References test::a, x, y, and z.

{
  x *= a;
  y *= a;
  z *= a;
  return *this;
}

UVector3 & UVector3::operator+= ( const UVector3 &  p )

inline

Definition at line 196 of file UVector3.hh.

References x, y, and z.

{
  x += p.x;
  y += p.y;
  z += p.z;
  return *this;
}

UVector3 UVector3::operator- ( ) const

inline

Definition at line 212 of file UVector3.hh.

References UVector3(), x, y, and z.

{
  return UVector3(-x, -y, -z);
}

UVector3 & UVector3::operator-= ( const UVector3 &  p )

inline

Definition at line 204 of file UVector3.hh.

References x, y, and z.

{
  x -= p.x;
  y -= p.y;
  z -= p.z;
  return *this;
}

UVector3 & UVector3::operator/= ( double  a )

inline

Definition at line 225 of file UVector3.hh.

References test::a, x, y, and z.

{
  a = 1. / a;
  x *= a;
  y *= a;
  z *= a;
  return *this;
}

UVector3 & UVector3::operator= ( const UVector3 &  v )

inline

Definition at line 167 of file UVector3.hh.

References x, y, and z.

{
  // Assignment of a UVector3
  if (this == &p)  { return *this; }
  x = p.x;
  y = p.y;
  z = p.z;
  return *this;
}

UVector3& UVector3::operator= ( const double *  vect )

inline

bool UVector3::operator== ( const UVector3 &  v ) const

inline

Definition at line 186 of file UVector3.hh.

References x, y, and z.

{
  return (v.x == x && v.y == y && v.z == z) ? true : false;
}

double & UVector3::operator[] ( int  index )

inline

Definition at line 284 of file UVector3.hh.

References x, y, and z.

{
  switch (index)
  {
    case 0:
      return x;
    case 1:
      return y;
    case 2:
      return z;
    default:
      return x;
  }
}

double UVector3::operator[] ( int  index ) const

inline

Definition at line 299 of file UVector3.hh.

References x, y, and z.

{
  //  return operator()(index);

  // TODO: test performance of both versions on Linux
  // => first version is slightly faster
  if (true)
  {
    double vec[3] = {x, y, z};
    return vec[index];
  }

  switch (index)
  {
    case 0:
      return x;
    case 1:
      return y;
    case 2:
      return z;
    default:
      return 0;
  }
}

double UVector3::Perp

(

)

const

Definition at line 56 of file UVector3.cc.

References Perp2().

Referenced by UPolyconeSide::Distance(), UPolyconeSide::DistanceAway(), UPolyconeSide::Extent(), UPolyconeSide::Normal(), and UPolyconeSide::PointOnCone().

{
  //return the transverse component  (R in cylindrical coordinate system)

  return std::sqrt(Perp2());
}

double UVector3::Perp2 ( ) const

inline

Definition at line 272 of file UVector3.hh.

References x, and y.

Referenced by UPolyhedraSide::Extent(), UPolyconeSide::Extent(), UEnclosingCylinder::MustBeOutside(), Perp(), and UEnclosingCylinder::ShouldMiss().

{
  return x * x + y * y;
}

double UVector3::Phi

(

)

const

Definition at line 64 of file UVector3.cc.

References UUtils::ATan2(), x, and y.

Referenced by UPolyconeSide::GetPhi(), and UPolyhedraSide::GetPhi().

{
  //return the  azimuth angle. returns phi from -pi to pi
  return x == 0.0 && y == 0.0 ? 0.0 : UUtils::ATan2(y, x);
}

void UVector3::RotateX

(

double

angle

)

Definition at line 102 of file UVector3.cc.

References test::c, y, and z.

{
  //rotate vector around X
  double s = std::sin(angle);
  double c = std::cos(angle);
  double yy = y;
  y = c * yy - s * z;
  z = s * yy + c * z;
}

void UVector3::RotateY

(

double

angle

)

Definition at line 113 of file UVector3.cc.

References test::c, x, and z.

{
  //rotate vector around Y
  double s = std::sin(angle);
  double c = std::cos(angle);
  double zz = z;
  z = c * zz - s * x;
  x = s * zz + c * x;
}

void UVector3::RotateZ

(

double

angle

)

Definition at line 124 of file UVector3.cc.

References test::c, x, and y.

{
  //rotate vector around Z
  double s = std::sin(angle);
  double c = std::cos(angle);
  double xx = x;
  x = c * xx - s * y;
  y = s * xx + c * y;
}

void UVector3::Set ( double  xx, double  yy, double  zz  )

inline

Definition at line 245 of file UVector3.hh.

References x, y, and z.

Referenced by UTrd::DistanceToOut(), UBox::DistanceToOut(), UOrb::Extent(), UTrd::Extent(), USphere::Extent(), UPolycone::Extent(), UBox::Normal(), UTransform3D::RotateX(), UTransform3D::RotateY(), UTransform3D::RotateZ(), UVoxelizer::SetMaxVoxels(), UUtils::TransformLimits(), and UTransform3D::UTransform3D().

{
  x = xx;
  y = yy;
  z = zz;
}

void UVector3::Set ( double  xx )

inline

Definition at line 252 of file UVector3.hh.

References x, y, and z.

{
  x = y = z = xx;
}

void UVector3::SetNull ( )

inline

double UVector3::Theta

(

)

const

Definition at line 71 of file UVector3.cc.

References UUtils::ACos(), Mag2(), and z.

{
  //return the polar angle from 0 to pi
  double mag2 = Mag2();
  if (mag2 == 0.0) return 0.0;
  return UUtils::ACos(z / std::sqrt(mag2));
}

UVector3 UVector3::Unit

(

)

const

Definition at line 80 of file UVector3.cc.

References Mag2(), x, y, and z.

Referenced by UTet::DistanceToIn(), UTet::DistanceToOut(), UCons::DistanceToOut(), UTet::Normal(), UPolyconeSide::Normal(), UTubs::Normal(), UCons::Normal(), USphere::Normal(), UPolyhedraSide::UPolyhedraSide(), UPolyPhiFace::UPolyPhiFace(), and UTet::UTet().

{
  // return unit vector parallel to this.
  double  tot = Mag2();
  UVector3 p(x, y, z);
  return tot > 0.0 ? p *= (1.0 / std::sqrt(tot)) : p;
}

Field Documentation

double UVector3::x

Definition at line 136 of file UVector3.hh.

Referenced by UTubs::ApproxSurfaceNormal(), UVoxelizer::BuildBoundingBox(), Cross(), UPolyhedraSide::Distance(), UPolyconeSide::Distance(), UOrb::DistanceToIn(), UVCSGfaceted::DistanceToIn(), UTrd::DistanceToIn(), UBox::DistanceToIn(), G4USolid::DistanceToIn(), UTubs::DistanceToIn(), UCons::DistanceToIn(), USphere::DistanceToIn(), UPolycone::DistanceToIn(), UOrb::DistanceToOut(), UTrd::DistanceToOut(), UBox::DistanceToOut(), G4USolid::DistanceToOut(), UTubs::DistanceToOut(), UCons::DistanceToOut(), USphere::DistanceToOut(), Dot(), VUSolid::EstimateCubicVolume(), VUSolid::EstimateSurfaceArea(), UTet::Extent(), UBox::Extent(), UPolyPhiFace::Extent(), UVoxelizer::GetCandidatesVoxelArray(), UTet::GetParametersList(), G4USolid::GetPointOnSurface(), UTransform3D::GlobalPoint(), UTransform3D::GlobalVector(), UOrb::Inside(), UTrd::Inside(), UBox::Inside(), G4USolid::Inside(), UTubs::Inside(), UPolyPhiFace::Inside(), USphere::Inside(), UPolycone::Inside(), UCons::Inside(), UPolyPhiFace::InsideEdgesExact(), UPolycone::InsideSection(), IsNull(), UIntersectingCone::LineHitsCone1(), UIntersectingCone::LineHitsCone1Optimized(), UIntersectingCone::LineHitsCone2(), UPolyhedraSide::LineHitsSegments(), UTransform3D::LocalPoint(), UTransform3D::LocalVector(), Mag2(), UVoxelizer::MinDistanceToBox(), MultiplyByComponents(), UEnclosingCylinder::MustBeOutside(), UOrb::Normal(), UTrd::Normal(), UBox::Normal(), UPolyconeSide::Normal(), UTubs::Normal(), UCons::Normal(), USphere::Normal(), UPolycone::Normal(), Normalize(), UPolycone::NormalSection(), operator!=(), operator*(), UTransform3D::operator*=(), operator*=(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator<<(), operator=(), operator==(), operator[](), Perp2(), Phi(), UPolyconeSide::PointOnCone(), UTransform3D::RotateX(), UTransform3D::RotateY(), RotateY(), UTransform3D::RotateZ(), RotateZ(), UOrb::SafetyFromInside(), UTrd::SafetyFromInside(), UBox::SafetyFromInside(), UTubs::SafetyFromInside(), USphere::SafetyFromInside(), UCons::SafetyFromInside(), UTrd::SafetyFromInsideAccurate(), UPolycone::SafetyFromInsideSection(), UOrb::SafetyFromOutside(), UVCSGfaceted::SafetyFromOutside(), UTrd::SafetyFromOutside(), UBox::SafetyFromOutside(), UTubs::SafetyFromOutside(), UCons::SafetyFromOutside(), USphere::SafetyFromOutside(), UTrd::SafetyFromOutsideAccurate(), UPolycone::SafetyFromOutsideSection(), UUtils::SaveVectorToExternalFile(), UBox::Set(), Set(), UEnclosingCylinder::ShouldMiss(), G4USolid::SurfaceNormal(), UUtils::TransformLimits(), Unit(), UPolyPhiFace::UPolyPhiFace(), UTet::UTet(), and UVector3().

double UVector3::y

Definition at line 137 of file UVector3.hh.

Referenced by UTubs::ApproxSurfaceNormal(), UVoxelizer::BuildBoundingBox(), Cross(), UPolyhedraSide::Distance(), UPolyconeSide::Distance(), UOrb::DistanceToIn(), UVCSGfaceted::DistanceToIn(), UTrd::DistanceToIn(), UBox::DistanceToIn(), G4USolid::DistanceToIn(), UTubs::DistanceToIn(), UCons::DistanceToIn(), USphere::DistanceToIn(), UPolycone::DistanceToIn(), UOrb::DistanceToOut(), UTrd::DistanceToOut(), UBox::DistanceToOut(), G4USolid::DistanceToOut(), UTubs::DistanceToOut(), UCons::DistanceToOut(), USphere::DistanceToOut(), Dot(), VUSolid::EstimateCubicVolume(), VUSolid::EstimateSurfaceArea(), UTet::Extent(), UBox::Extent(), UPolyPhiFace::Extent(), UVoxelizer::GetCandidatesVoxelArray(), UTet::GetParametersList(), G4USolid::GetPointOnSurface(), UTransform3D::GlobalPoint(), UTransform3D::GlobalVector(), UOrb::Inside(), UTrd::Inside(), UBox::Inside(), G4USolid::Inside(), UTubs::Inside(), UPolyPhiFace::Inside(), USphere::Inside(), UPolycone::Inside(), UCons::Inside(), UPolyPhiFace::InsideEdgesExact(), UPolycone::InsideSection(), IsNull(), UIntersectingCone::LineHitsCone1(), UIntersectingCone::LineHitsCone1Optimized(), UIntersectingCone::LineHitsCone2(), UPolyhedraSide::LineHitsSegments(), UTransform3D::LocalPoint(), UTransform3D::LocalVector(), Mag2(), UVoxelizer::MinDistanceToBox(), MultiplyByComponents(), UEnclosingCylinder::MustBeOutside(), UOrb::Normal(), UTrd::Normal(), UBox::Normal(), UPolyconeSide::Normal(), UTubs::Normal(), UCons::Normal(), USphere::Normal(), UPolycone::Normal(), Normalize(), UPolycone::NormalSection(), operator!=(), operator*(), UTransform3D::operator*=(), operator*=(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator<<(), operator=(), operator==(), operator[](), Perp2(), Phi(), UPolyconeSide::PointOnCone(), UTransform3D::RotateX(), RotateX(), UTransform3D::RotateY(), UTransform3D::RotateZ(), RotateZ(), UOrb::SafetyFromInside(), UTrd::SafetyFromInside(), UBox::SafetyFromInside(), UTubs::SafetyFromInside(), USphere::SafetyFromInside(), UCons::SafetyFromInside(), UTrd::SafetyFromInsideAccurate(), UPolycone::SafetyFromInsideSection(), UOrb::SafetyFromOutside(), UVCSGfaceted::SafetyFromOutside(), UTrd::SafetyFromOutside(), UBox::SafetyFromOutside(), UTubs::SafetyFromOutside(), UCons::SafetyFromOutside(), USphere::SafetyFromOutside(), UTrd::SafetyFromOutsideAccurate(), UPolycone::SafetyFromOutsideSection(), UUtils::SaveVectorToExternalFile(), UBox::Set(), Set(), UEnclosingCylinder::ShouldMiss(), G4USolid::SurfaceNormal(), UUtils::TransformLimits(), Unit(), UPolyPhiFace::UPolyPhiFace(), UTet::UTet(), and UVector3().

double UVector3::z

Definition at line 138 of file UVector3.hh.

Referenced by UTubs::ApproxSurfaceNormal(), UVoxelizer::BuildBoundingBox(), CosTheta(), Cross(), UPolyPhiFace::Distance(), UPolyconeSide::DistanceAway(), UOrb::DistanceToIn(), UVCSGfaceted::DistanceToIn(), UTrd::DistanceToIn(), UBox::DistanceToIn(), G4USolid::DistanceToIn(), UTubs::DistanceToIn(), UCons::DistanceToIn(), USphere::DistanceToIn(), UPolycone::DistanceToIn(), UOrb::DistanceToOut(), UVCSGfaceted::DistanceToOut(), UTrd::DistanceToOut(), UBox::DistanceToOut(), G4USolid::DistanceToOut(), UTubs::DistanceToOut(), UCons::DistanceToOut(), USphere::DistanceToOut(), UPolycone::DistanceToOut(), Dot(), VUSolid::EstimateCubicVolume(), VUSolid::EstimateSurfaceArea(), UTet::Extent(), UPolyhedraSide::Extent(), UBox::Extent(), UPolyconeSide::Extent(), UPolyPhiFace::Extent(), UVoxelizer::GetCandidatesVoxelArray(), UTet::GetParametersList(), G4USolid::GetPointOnSurface(), UTransform3D::GlobalPoint(), UTransform3D::GlobalVector(), UOrb::Inside(), UVCSGfaceted::Inside(), UTrd::Inside(), UBox::Inside(), G4USolid::Inside(), UTubs::Inside(), UPolyPhiFace::Inside(), USphere::Inside(), UPolycone::Inside(), UCons::Inside(), UPolyPhiFace::InsideEdgesExact(), UPolycone::InsideSection(), IsNull(), UIntersectingCone::LineHitsCone1(), UIntersectingCone::LineHitsCone1Optimized(), UIntersectingCone::LineHitsCone2(), UTransform3D::LocalPoint(), UTransform3D::LocalVector(), Mag2(), UVoxelizer::MinDistanceToBox(), MultiplyByComponents(), UEnclosingCylinder::MustBeOutside(), UVCSGfaceted::Normal(), UOrb::Normal(), UTrd::Normal(), UBox::Normal(), UTubs::Normal(), UCons::Normal(), UPolyPhiFace::Normal(), USphere::Normal(), UPolycone::Normal(), Normalize(), UPolycone::NormalSection(), operator!=(), operator*(), UTransform3D::operator*=(), operator*=(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator<<(), operator=(), operator==(), operator[](), UPolyconeSide::PointOnCone(), UTransform3D::RotateX(), RotateX(), UTransform3D::RotateY(), RotateY(), UTransform3D::RotateZ(), UPolyPhiFace::Safety(), UOrb::SafetyFromInside(), UTrd::SafetyFromInside(), UBox::SafetyFromInside(), UVCSGfaceted::SafetyFromInside(), UTubs::SafetyFromInside(), USphere::SafetyFromInside(), UCons::SafetyFromInside(), UPolycone::SafetyFromInside(), UTrd::SafetyFromInsideAccurate(), UPolycone::SafetyFromInsideSection(), UOrb::SafetyFromOutside(), UVCSGfaceted::SafetyFromOutside(), UTrd::SafetyFromOutside(), UBox::SafetyFromOutside(), UTubs::SafetyFromOutside(), UCons::SafetyFromOutside(), USphere::SafetyFromOutside(), UPolycone::SafetyFromOutside(), UTrd::SafetyFromOutsideAccurate(), UPolycone::SafetyFromOutsideSection(), UUtils::SaveVectorToExternalFile(), UBox::Set(), Set(), G4USolid::SurfaceNormal(), Theta(), UUtils::TransformLimits(), Unit(), UTet::UTet(), and UVector3().

---

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

• UVector3.hh
• UVector3.cc