Implementation of a 3D vector (by Vitaliy). More...

#include <Vector.h>

Public Member Functions
	Vec3D ()
	constructor More...

	Vec3D (const Mdouble x, const Mdouble y, const Mdouble z)
	Alternative constructor, taking the three elements as arguments. More...

void	setZero ()
	Sets all elements to zero. More...

bool	isZero () const
	Checks if ALL elements are zero. More...

Vec3D	operator+ (const Vec3D &a) const
	Adds another vector. More...

Vec3D	operator- (const Vec3D &a) const
	Subtracts another vector. More...

Vec3D	operator+ (const Mdouble a) const
	Adds a scalar. More...

Vec3D	operator- (const Mdouble a) const
	Subtracts a scalar. More...

Vec3D	operator* (const Mdouble a) const
	Multiplies by a scalar. More...

Vec3D	operator/ (const Mdouble a) const
	Divides by a scalar. More...

Vec3D &	operator+= (const Vec3D &a)
	Adds another vector. More...

Vec3D &	operator-= (const Vec3D &a)
	Subtracts another vector. More...

Vec3D &	operator*= (const Mdouble a)
	Multiplies by a scalar. More...

Vec3D &	operator/= (const Mdouble a)
	Divides by a scalar. More...

void	normalize ()
	Makes this Vec3D unit length. More...

void	setLength (Mdouble length)
	Make this Vec3D a certain length. More...

Mdouble	getLength () const
	Calculates the length of this Vec3D: \( \sqrt{a\cdot a} \). More...

Mdouble	getLengthSquared () const
	Calculates the squared length of this Vec3D: \( a\cdot a \). More...

Mdouble	getComponent (const int index) const
	Returns the requested component of this Vec3D. More...

void	setComponent (const int index, const double val)
	Sets the requested component of this Vec3D to the requested value. More...

Vec3D	getCylindricalCoordinates () const
	Returns the representation of this Vec3D in cylindrical coordinates. More...

Vec3D	getFromCylindricalCoordinates () const
	Returns the representation of this Vec3D in cartesian coordinates. More...

bool	isEqualTo (const Vec3D &other, const double tol) const
	Checks if the length this Vec3D is equal the length of other with a certain tolerance. More...

Static Public Member Functions
static Mdouble	dot (const Vec3D &a, const Vec3D &b)
	Calculates the dot product of two Vec3D: \( a \cdot b\). More...

static Vec3D	max (const Vec3D &a, const Vec3D &b)
	Calculates the pointwise maximum of two Vec3D. More...

static Vec3D	min (const Vec3D &a, const Vec3D &b)
	Calculates the pointwise minimum of two Vec3D. More...

static Vec3D	square (const Vec3D &a)
	Calculates the pointwise square of a Vec3D. More...

static Vec3D	sqrt (const Vec3D &a)
	Calculates the pointwise square root of a Vec3D. More...

static Vec3D	cross (const Vec3D &a, const Vec3D &b)
	Calculates the cross product of two Vec3D: \( a \times b\). More...

static Mdouble	getDistance (const Vec3D &a, const Vec3D &b)
	Calculates the distance between two Vec3D: \( \sqrt{\left(a-b\right) \cdot \left(a-b\right)} \). More...

static Mdouble	getDistanceSquared (const Vec3D &a, const Vec3D &b)
	Calculates the squared distance between two Vec3D: \( \left(a-b\right) \cdot \left(a-b\right) \). More...

static Mdouble	getLength (const Vec3D &a)
	Calculates the length of a Vec3D: \( \sqrt{a\cdot a} \). More...

static Mdouble	getLengthSquared (const Vec3D &a)
	Calculates the squared length of a Vec3D: \( a\cdot a \). More...

static Vec3D	getUnitVector (const Vec3D &a)
	Returns a unit Vec3D based on a. More...

Public Attributes
Mdouble	X
	the vector components More...

Mdouble	Y

Mdouble	Z

Friends
std::ostream &	operator<< (std::ostream &os, const Vec3D &a)
	Adds elements to an output stream. More...

std::istream &	operator>> (std::istream &is, Vec3D &a)
	Adds elements to an input stream. More...

Vec3D	operator+ (const Mdouble a, const Vec3D &b)
	Adds a scalar to a vector. More...

Vec3D	operator- (const Mdouble a, const Vec3D &b)
	Subtracts the elements of a vector from a scalar. More...

Vec3D	operator- (const Vec3D &a)
	Subtracts a vector. More...

Vec3D	operator* (const Mdouble a, const Vec3D &b)
	Multiplies all elements by a scalar. More...

Detailed Description

Implementation of a 3D vector (by Vitaliy).

Modifications 21:9:2009 - Added the inclusion guards and some include objects

Todo:: Need to generalize this to n-dimensional vectors of any type

Definition at line 45 of file Vector.h.

Constructor & Destructor Documentation

Vec3D::Vec3D ( )

constructor

Default constructor

Definition at line 31 of file Vector.cc.

References setZero().

Referenced by cross(), getCylindricalCoordinates(), getFromCylindricalCoordinates(), getUnitVector(), max(), min(), operator*(), operator+(), operator-(), operator/(), sqrt(), and square().

 {
     setZero();
 }

Vec3D::Vec3D	(	const Mdouble	x,
		const Mdouble	y,
		const Mdouble	z
	)

Alternative constructor, taking the three elements as arguments.

Alternative constructor, lets you define all three elements.

Parameters

[in]	x	the x-component
[in]	y	the y-component
[in]	z	the z-component

Definition at line 42 of file Vector.cc.

References X, Y, and Z.

 {
     X = x;
     Y = y;
     Z = z;
 }

Member Function Documentation

Vec3D Vec3D::cross	(	const Vec3D &	a,
		const Vec3D &	b
	)

static

Calculates the cross product of two Vec3D: \( a \times b\).

Calculates the cross product of two vectors NB: this is a STATIC function!

Parameters

[in]	a	the first vector
[in]	b	the second vector

Returns: the cross product of the arguments

Definition at line 268 of file Vector.cc.

References Vec3D(), X, Y, and Z.

Referenced by ChuteWithHopper::addHopper(), IntersectionOfWalls::addObject(), DPMBase::computeForcesDueToWalls(), FrictionInteraction::computeFrictionForce(), DPMBase::computeInternalForces(), IntersectionOfWalls::createOpenPrism(), IntersectionOfWalls::createPrism(), BaseInteractable::getVelocityAtContact(), and AngledPeriodicBoundary::set().

 {
     return Vec3D(a.Y * b.Z - a.Z * b.Y, a.Z * b.X - a.X * b.Z, a.X * b.Y - a.Y * b.X);
 }

Mdouble Vec3D::dot	(	const Vec3D &	a,
		const Vec3D &	b
	)

static

Calculates the dot product of two Vec3D: \( a \cdot b\).

Calculates the dot product of two vectors. NB: this is a STATIC function!

Parameters

[in]	a	the first vector
[in]	b	the second vector

Returns: the resulting scalar

Definition at line 187 of file Vector.cc.

References X, Y, and Z.

Referenced by IntersectionOfWalls::addObject(), SlidingFrictionInteraction::computeFrictionForce(), FrictionInteraction::computeFrictionForce(), LinearPlasticViscoelasticInteraction::computeLinearPlasticViscoelasticForce(), HertzianViscoelasticInteraction::computeNormalForce(), LinearViscoelasticInteraction::computeNormalForce(), AngledPeriodicBoundary::distance(), BaseInteraction::gatherContactStatistics(), DeletionBoundary::getDistance(), MaserBoundary::getDistance(), PeriodicBoundary::getDistance(), InfiniteWall::getDistance(), AxisymmetricIntersectionOfWalls::getDistanceAndNormal(), IntersectionOfWalls::getDistanceAndNormal(), AngledPeriodicBoundary::getOpeningAngle(), InfiniteWallWithHole::getWallDistance(), FrictionInteraction::integrate(), InfiniteWallWithHole::move_time(), DeletionBoundary::set(), AngledPeriodicBoundary::set(), PeriodicBoundary::set(), InfiniteWallWithHole::set(), AngledPeriodicBoundary::shiftPosition(), AngledPeriodicBoundary::shiftPositions(), DPMBase::writeEneTimestep(), and BaseInteraction::writeToFStat().

 {
     return a.X * b.X + a.Y * b.Y + a.Z * b.Z;
 }

Mdouble Vec3D::getComponent ( const int index ) const

Returns the requested component of this Vec3D.

returns the vector element belonging to the given index.

Parameters

[in] index the index of interest (should be 0, 1 or 2)

Returns: the value of the vector element belonging to the given index

Definition at line 323 of file Vector.cc.

References ERROR, logger, X, Y, and Z.

         {
     switch (index)
     {
         case 0:
             return X;
         case 1:
             return Y;
         case 2:
             return Z;
         default:
             logger(ERROR, "[Vector::getComponent] Index = %, which is too high for a 3D vector (should be 0-2).", index);
             return 0;
     }
 }

Vec3D Vec3D::getCylindricalCoordinates ( ) const

Returns the representation of this Vec3D in cylindrical coordinates.

Transforms the (Cartesian) vector to cylindrical coordinates

Returns: Transformed vector

Definition at line 367 of file Vector.cc.

References Vec3D(), X, Y, and Z.

 {
     return Vec3D(std::sqrt(X * X + Y * Y), std::atan2(Y, X), Z);
 }

Mdouble Vec3D::getDistance	(	const Vec3D &	a,
		const Vec3D &	b
	)

static

Calculates the distance between two Vec3D: \( \sqrt{\left(a-b\right) \cdot \left(a-b\right)} \).

Calculates the distance (i.e. the length of the difference) between two vectors NB: this is a STATIC function!

Parameters

[in]	a	the first vector
[in]	b	the second vector

Returns: the distance between the two arguments.

Definition at line 280 of file Vector.cc.

References getDistanceSquared().

 {
     return std::sqrt(getDistanceSquared(a, b));
 }

Mdouble Vec3D::getDistanceSquared	(	const Vec3D &	a,
		const Vec3D &	b
	)

static

Calculates the squared distance between two Vec3D: \( \left(a-b\right) \cdot \left(a-b\right) \).

Calculates the square of the distance (i.e. the length of the difference) between two vectors. NB: this is a STATIC function!

Parameters

[in]	a	the first vector
[in]	b	the second vector

Returns: the square of the distance between the two arguments.

Definition at line 293 of file Vector.cc.

References X, Y, and Z.

Referenced by DPMBase::areInContact(), DPMBase::checkParticleForInteraction(), and getDistance().

 {
     return ((a.X - b.X) * (a.X - b.X) + (a.Y - b.Y) * (a.Y - b.Y) + (a.Z - b.Z) * (a.Z - b.Z));
 }

Vec3D Vec3D::getFromCylindricalCoordinates ( ) const

Returns the representation of this Vec3D in cartesian coordinates.

Transforms the (cylindrical) vector to cartesian coordinates

Returns: Transformed vector

Definition at line 376 of file Vector.cc.

References Vec3D(), X, Y, and Z.

 {
     return Vec3D(X * std::cos(Y), X * std::sin(Y), Z);
 }

Mdouble Vec3D::getLength ( const Vec3D & a )

static

Calculates the length of a Vec3D: \( \sqrt{a\cdot a} \).

Calculates the length of a given vector NB: this is a STATIC function!

Parameters

[in] a vector to be measured.

Returns: length of the argument.

Definition at line 427 of file Vector.cc.

References getLength().

Referenced by BaseInteraction::gatherContactStatistics(), Screw::getDistanceAndNormal(), CylindricalWall::getDistanceAndNormal(), AxisymmetricIntersectionOfWalls::getDistanceAndNormal(), Coil::getDistanceAndNormal(), InfiniteWallWithHole::getDistanceAndNormal(), getLength(), SlidingFrictionInteraction::getTangentialOverlap(), Chute::setChuteAngle(), and BaseInteraction::writeToFStat().

 {
     return a.getLength();
 }

Mdouble Vec3D::getLength ( ) const

Calculates the length of this Vec3D: \( \sqrt{a\cdot a} \).

Calculates the length of this vector

Returns: the (scalar) length of this vector

Definition at line 416 of file Vector.cc.

References getLengthSquared().

Referenced by normalize(), AngledPeriodicBoundary::set(), setLength(), and InfiniteWall::setNormal().

 {
     return std::sqrt(getLengthSquared());
 }

Mdouble Vec3D::getLengthSquared ( const Vec3D & a )

static

Calculates the squared length of a Vec3D: \( a\cdot a \).

Calculates the square of the length of a given vector. NB: this is a STATIC function!

Parameters

[in] a the vector.

Returns: the square of the length of the argument.

Definition at line 304 of file Vector.cc.

References X, Y, and Z.

Referenced by ChuteWithHopper::addHopper(), SlidingFrictionInteraction::computeFrictionForce(), FrictionInteraction::computeFrictionForce(), IntersectionOfWalls::getDistanceAndNormal(), SlidingFrictionInteraction::getElasticEnergy(), FrictionInteraction::getElasticEnergy(), BaseParticle::getKineticEnergy(), getUnitVector(), and Quarternion::integrate().

 {
     return (a.X * a.X + a.Y * a.Y + a.Z * a.Z);
 }

Mdouble Vec3D::getLengthSquared ( ) const

Calculates the squared length of this Vec3D: \( a\cdot a \).

Calculates the square of the length of itself

Returns: the square of the length of this vector

Definition at line 313 of file Vector.cc.

References X, Y, and Z.

Referenced by BaseParticle::getInteractionWith(), getLength(), and isEqualTo().

 {
     return (X * X + Y * Y + Z * Z);
 }

Vec3D Vec3D::getUnitVector ( const Vec3D & a )

static

Returns a unit Vec3D based on a.

Calculates the unit vector of a given vector (unless it is a vector with zero length; in that case it returns a 3D vector with each element equal to zero). NB: this is a STATIC function!

Parameters

[in] a the vector of interest

Returns: unit vector in the direction of the argument (unless the argument has length zero; in that case a zero-vector).

Definition at line 441 of file Vector.cc.

References getLengthSquared(), and Vec3D().

Referenced by IntersectionOfWalls::createOpenPrism(), and IntersectionOfWalls::createPrism().

 {
     Mdouble Length2 = a.getLengthSquared();
     if (Length2 != 0.0)
         return a / std::sqrt(Length2);
     else
         return Vec3D(0, 0, 0);
 }

bool Vec3D::isEqualTo	(	const Vec3D &	other,
		const double	tol
	)		const

Checks if the length this Vec3D is equal the length of other with a certain tolerance.

Checks if the length of the vector is equal to the one given in the first argument (other), with a tolerance given in the second argument (tol).

Parameters

[in]	other	the 3D vector to check against
[in]	tol	the tolerance

Returns: returns TRUE if the difference between the lengths of this vector and that given in the first argument (other) is smaller than the given tolerance.

Definition at line 390 of file Vector.cc.

References getLengthSquared().

         {
     if ((Vec3D::getLengthSquared(*this - other)) <= tol * tol)
     {
         return true;
     }
     else
     {
         return false;
     }
 }

bool Vec3D::isZero ( ) const

Checks if ALL elements are zero.

Checks if ALL elements are zero

Returns: TRUE if ALL elements are zero

Definition at line 63 of file Vector.cc.

References X, Y, and Z.

 {
     return X == 0.0 && Y == 0.0 && Z == 0.0;
 }

Vec3D Vec3D::max	(	const Vec3D &	a,
		const Vec3D &	b
	)

static

Calculates the pointwise maximum of two Vec3D.

Calculates the pointwise maximum of two vectors. NB: this is a STATIC function!

Parameters

[in]	a	the first vector
[in]	b	the second vector

Returns: The resulting vector, in which each element is the maximum of the equivalent elements of the arguments

Definition at line 200 of file Vector.cc.

References Vec3D(), X, Y, and Z.

 {
     return Vec3D(std::max(a.X, b.X), std::max(a.Y, b.Y), std::max(a.Z, b.Z));
 }

Vec3D Vec3D::min	(	const Vec3D &	a,
		const Vec3D &	b
	)

static

Calculates the pointwise minimum of two Vec3D.

Calculates the pointwise minimum of two vectors. NB: this is a STATIC function!

Parameters

[in]	a	the first vector
[in]	b	the second vector

Returns: The resulting vector, in which each element is the minimum of the equivalent elements of the arguments

Definition at line 213 of file Vector.cc.

References Vec3D(), X, Y, and Z.

 {
     return Vec3D(std::min(a.X, b.X), std::min(a.Y, b.Y), std::min(a.Z, b.Z));
 }

void Vec3D::normalize ( )

Makes this Vec3D unit length.

Normalises the vector, i.e. divides all elements by the vectors length (resulting in a vector in the same direction, but with unit length).

Definition at line 234 of file Vector.cc.

References getLength().

Referenced by IntersectionOfWalls::addObject(), and Quarternion::Quarternion().

 {
     *this /= this->getLength();
 }

Vec3D Vec3D::operator* ( const Mdouble a ) const

Multiplies by a scalar.

Multiplies each element with a scalar

Parameters

[in] a the scalar to be multiplied with

Returns: the resulting vector

Definition at line 113 of file Vector.cc.

References Vec3D(), X, Y, and Z.

         {
     return Vec3D(X * a, Y * a, Z * a);
 }

Vec3D & Vec3D::operator*= ( const Mdouble a )

Multiplies by a scalar.

Multiplies each element by a scalar

Parameters

[in] a scalar to be multiplied by

Returns: (reference to) itself, i.e. resulting vector

Definition at line 159 of file Vector.cc.

References X, Y, and Z.

 {
     X *= a;
     Y *= a;
     Z *= a;
     return *this;
 }

Vec3D Vec3D::operator+ ( const Vec3D & a ) const

Adds another vector.

Adds vector to itself

Parameters

[in] a vector to be added

Returns: resulting 3D vector

Definition at line 73 of file Vector.cc.

References Vec3D(), X, Y, and Z.

         {
     return Vec3D(X + a.X, Y + a.Y, Z + a.Z);
 }

Vec3D Vec3D::operator+ ( const Mdouble a ) const

Adds a scalar.

Adds scalar to each element

Parameters

[in] a scalar to be added

Returns: resulting vector

Definition at line 93 of file Vector.cc.

References Vec3D(), X, Y, and Z.

         {
     return Vec3D(X + a, Y + a, Z + a);
 }

Vec3D & Vec3D::operator+= ( const Vec3D & a )

Adds another vector.

Adds a vector to itself

Parameters

[in] a vector to be added

Returns: (reference to) itself, i.e. resulting vector

Definition at line 133 of file Vector.cc.

References X, Y, and Z.

 {
     X += a.X;
     Y += a.Y;
     Z += a.Z;
     return *this;
 }

Vec3D Vec3D::operator- ( const Vec3D & a ) const

Subtracts another vector.

Subtracts vector from itself

Parameters

[in] a vector to be subtracted

Returns: resulting vector

Definition at line 83 of file Vector.cc.

References Vec3D(), X, Y, and Z.

         {
     return Vec3D(X - a.X, Y - a.Y, Z - a.Z);
 }

Vec3D Vec3D::operator- ( const Mdouble a ) const

Subtracts a scalar.

Subtracts scalar from each element

Parameters

[in] a scalar to be subtracted

Returns: resulting vector

Definition at line 103 of file Vector.cc.

References Vec3D(), X, Y, and Z.

         {
     return Vec3D(X - a, Y - a, Z - a);
 }

Vec3D & Vec3D::operator-= ( const Vec3D & a )

Subtracts another vector.

Subtracts a vector from itself

Parameters

[in] a vector to be subtracted

Returns: (reference to) itself, i.e. resulting vector

Definition at line 146 of file Vector.cc.

References X, Y, and Z.

 {
     X -= a.X;
     Y -= a.Y;
     Z -= a.Z;
     return *this;
 }

Vec3D Vec3D::operator/ ( const Mdouble a ) const

Divides by a scalar.

Divides each element by a scalar

Parameters

[in] a the scalar to be divided by

Returns: resulting vector

Definition at line 123 of file Vector.cc.

References Vec3D(), X, Y, and Z.

         {
     return Vec3D(X / a, Y / a, Z / a);
 }

Vec3D & Vec3D::operator/= ( const Mdouble a )

Divides by a scalar.

Divides each element by a scalar

Parameters

[in] a scalar to be divided by

Returns: (reference to) itself, i.e. resulting vector

Definition at line 172 of file Vector.cc.

References X, Y, and Z.

 {
     X /= a;
     Y /= a;
     Z /= a;
     return *this;
 }

void Vec3D::setComponent	(	const int	index,
		const double	val
	)

Sets the requested component of this Vec3D to the requested value.

Sets the element of the vector belonging to the first argument (index) to the value given in the second argument (val).

Parameters

[in]	index	index of element of interest,
[in]	val	value to be set

Definition at line 345 of file Vector.cc.

References ERROR, logger, X, Y, and Z.

 {
     switch (index)
     {
         case 0:
             X = val;
             break;
         case 1:
             Y = val;
             break;
         case 2:
             Z = val;
             break;
         default:
             logger(ERROR, "[Vector::setComponent] Index = %, which is too high for a 3D vector (should be 0-2).", index);
     }
 }

void Vec3D::setLength ( Mdouble length )

Make this Vec3D a certain length.

Sets the length of the vector to a given scalar (while maintaining the direction).

Parameters

[in] length the length to be set

Definition at line 244 of file Vector.cc.

References getLength().

 {
     *this /= this->getLength() * length;
 }

void Vec3D::setZero ( )

Sets all elements to zero.

Sets each element to zero.

Definition at line 52 of file Vector.cc.

References X, Y, and Z.

Referenced by BaseInteractable::BaseInteractable(), BaseInteraction::BaseInteraction(), BaseParticle::BaseParticle(), Coil::Coil(), FrictionInteraction::FrictionInteraction(), Screw::Screw(), SlidingFrictionInteraction::SlidingFrictionInteraction(), StatisticsPoint< T >::StatisticsPoint(), and Vec3D().

 {
     X = 0.0;
     Y = 0.0;
     Z = 0.0;
 }

Vec3D Vec3D::sqrt ( const Vec3D & a )

static

Calculates the pointwise square root of a Vec3D.

Calculates the pointwise square root of a given vector. NB: this is a STATIC function!

Parameters

[in] a the vector to be pointwise square rooted

Returns: the resulting vector, of which each element is the square root of the equivalent element of the argument.

Definition at line 256 of file Vector.cc.

References Vec3D(), X, Y, and Z.

 {
     return Vec3D(std::sqrt(a.X), std::sqrt(a.Y), std::sqrt(a.Z));
 }

Vec3D Vec3D::square ( const Vec3D & a )

static

Calculates the pointwise square of a Vec3D.

Calculates the pointwise square of the vector. NB: this is a STATIC function!

Parameters

[in] a the vector to be squared.

Returns: the resulting vector, of which each element is the square of the equivalent element of the argument.

Definition at line 225 of file Vector.cc.

References Vec3D(), X, Y, and Z.

 {
     return Vec3D(a.X * a.X, a.Y * a.Y, a.Z * a.Z);
 }

Friends And Related Function Documentation

Vec3D operator*	(	const Mdouble	a,
		const Vec3D &	b
	)

friend

Multiplies all elements by a scalar.

Multiplies each element of a given vector (b) by a given scalar (a). NB: this is a global function and a friend of the Vec3D class. Gets called when a scalar multiplication of the form (Mdouble) * (Vec3D) is performed.

Parameters

[in]	a	the scalar
[in]	b	the vector

Returns: the resulting vector

Definition at line 522 of file Vector.cc.

 {
     return Vec3D(b.X * a, b.Y * a, b.Z * a);
 }

Vec3D operator+	(	const Mdouble	a,
		const Vec3D &	b
	)

friend

Adds a scalar to a vector.

Adds a scalar to the elements of given vector NB this is a global function and a friend of the Vec3D class. Gets called when addition operation of the form (Mdouble) + (Vec3D) is performed.

Parameters

[in]	a	the scalar to be added
[in]	b	the vector the scalar gets added to.

Returns: the resulting vector.

Definition at line 484 of file Vector.cc.

 {
     return Vec3D(b.X + a, b.Y + a, b.Z + a);
 }

Vec3D operator-	(	const Mdouble	a,
		const Vec3D &	b
	)

friend

Subtracts the elements of a vector from a scalar.

Subtracts each element of a given vector from a scalar NB this is a global function and a friend of the Vec3D class. Gets called when subtraction operation of the form (Mdouble) - (Vec3D) is performed.

Parameters

[in]	a	the scalar
[in]	b	the vector to be subtracted the scalar gets subtracted from.

Returns: the resulting vector.

Definition at line 497 of file Vector.cc.

 {
     return Vec3D(a - b.X, a - b.Y, a - b.Z);
 }

Vec3D operator- ( const Vec3D & a )

friend

Subtracts a vector.

Returns the negative of a given vector. NB: this is a global function and a friend of the Vec3D class. Gets called when a negation operation of the form - (Vec3D) is performed.

Parameters

[in] a the vector to be negated

Returns: the negated vector

Definition at line 509 of file Vector.cc.

 {
     return Vec3D(-a.X, -a.Y, -a.Z);
 }

std::ostream& operator<<	(	std::ostream &	os,
		const Vec3D &	a
	)

friend

Adds elements to an output stream.

Adds all elements of the vector to an output stream. NB: this is a global function and a friend of the Vec3D class!

Parameters

[in]	os	the output stream,
[in]	a	The vector of interest

Returns: the output stream with vector elements added

Definition at line 457 of file Vector.cc.

 {
     os << a.X << ' ' << a.Y << ' ' << a.Z;
     return os;
 }

std::istream& operator>>	(	std::istream &	is,
		Vec3D &	a
	)

friend

Adds elements to an input stream.

Reads all elements of a given vector from an input stream. NB: this is a global function and a friend of the Vec3D class!

Parameters

[in,out]	is	the input stream
[in,out]	a	the vector to be read in

Returns: the input stream from which the vector elements were read

Definition at line 470 of file Vector.cc.

 {
     is >> a.X >> a.Y >> a.Z;
     return is;
 }

Member Data Documentation

Mdouble Vec3D::X

the vector components

Definition at line 52 of file Vector.h.

Referenced by ChuteWithHopper::addHopper(), CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), Chute::cleanChute(), Chute::createBottom(), CircularPeriodicBoundary::createPeriodicParticles(), Matrix3D::cross(), cross(), dot(), Matrix3D::dyadic(), ChuteInsertionBoundary::generateParticle(), CubeInsertionBoundary::generateParticle(), getComponent(), getCylindricalCoordinates(), BaseParticle::getDisplacement2(), Screw::getDistanceAndNormal(), CylindricalWall::getDistanceAndNormal(), AxisymmetricIntersectionOfWalls::getDistanceAndNormal(), Coil::getDistanceAndNormal(), InfiniteWallWithHole::getDistanceAndNormal(), getDistanceSquared(), getFromCylindricalCoordinates(), InfiniteWallWithHole::getHoleDistance(), LeesEdwardsBoundary::getHorizontalDistance(), getLengthSquared(), Mercury2D::hGridFindOneSidedContacts(), Mercury3D::hGridFindOneSidedContacts(), Mercury2D::hGridHasParticleContacts(), Mercury2D::hGridUpdateParticle(), Mercury3D::hGridUpdateParticle(), Quarternion::integrate(), mathsFunc::isEqual(), isZero(), max(), min(), Matrix3D::operator*(), operator*(), operator*(), operator*=(), operator+(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator<<(), operator>>(), Quarternion::Quarternion(), DPMBase::readNextDataFile(), ParticleHandler::readOldObject(), CircularPeriodicBoundary::rotateParticle(), MatrixSymmetric3D::selfDyadic(), AngledPeriodicBoundary::set(), setComponent(), ChuteBottom::setupInitialConditions(), setZero(), sqrt(), square(), MatrixSymmetric3D::symmetrisedDyadic(), and Vec3D().

Mdouble Vec3D::Y

Definition at line 52 of file Vector.h.

Referenced by CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), Chute::createBottom(), CircularPeriodicBoundary::createPeriodicParticles(), Matrix3D::cross(), cross(), dot(), Matrix3D::dyadic(), ChuteInsertionBoundary::generateParticle(), CubeInsertionBoundary::generateParticle(), getComponent(), getCylindricalCoordinates(), BaseParticle::getDisplacement2(), Screw::getDistanceAndNormal(), CylindricalWall::getDistanceAndNormal(), Coil::getDistanceAndNormal(), InfiniteWallWithHole::getDistanceAndNormal(), getDistanceSquared(), getFromCylindricalCoordinates(), InfiniteWallWithHole::getHoleDistance(), getLengthSquared(), LeesEdwardsBoundary::getVerticalDistance(), Mercury2D::hGridFindOneSidedContacts(), Mercury3D::hGridFindOneSidedContacts(), Mercury2D::hGridHasParticleContacts(), Mercury2D::hGridUpdateParticle(), Mercury3D::hGridUpdateParticle(), Quarternion::integrate(), mathsFunc::isEqual(), isZero(), max(), min(), Matrix3D::operator*(), operator*(), operator*(), operator*=(), operator+(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator<<(), operator>>(), Quarternion::Quarternion(), DPMBase::readNextDataFile(), ParticleHandler::readOldObject(), CircularPeriodicBoundary::rotateParticle(), MatrixSymmetric3D::selfDyadic(), AngledPeriodicBoundary::set(), setComponent(), ChuteBottom::setupInitialConditions(), setZero(), sqrt(), square(), MatrixSymmetric3D::symmetrisedDyadic(), and Vec3D().

Mdouble Vec3D::Z

Definition at line 52 of file Vector.h.

Referenced by ChuteWithHopper::addHopper(), Matrix3D::cross(), cross(), dot(), Matrix3D::dyadic(), ChuteInsertionBoundary::generateParticle(), CubeInsertionBoundary::generateParticle(), getComponent(), getCylindricalCoordinates(), BaseParticle::getDisplacement2(), Screw::getDistanceAndNormal(), CylindricalWall::getDistanceAndNormal(), AxisymmetricIntersectionOfWalls::getDistanceAndNormal(), Coil::getDistanceAndNormal(), InfiniteWallWithHole::getDistanceAndNormal(), getDistanceSquared(), getFromCylindricalCoordinates(), getLengthSquared(), Mercury3D::hGridFindOneSidedContacts(), Mercury3D::hGridUpdateParticle(), Quarternion::integrate(), mathsFunc::isEqual(), isZero(), max(), min(), Matrix3D::operator*(), operator*(), operator*(), operator*=(), operator+(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator<<(), operator>>(), Quarternion::Quarternion(), DPMBase::readNextDataFile(), ParticleHandler::readOldObject(), CircularPeriodicBoundary::rotateParticle(), MatrixSymmetric3D::selfDyadic(), AngledPeriodicBoundary::set(), setComponent(), ChuteBottom::setupInitialConditions(), setZero(), sqrt(), square(), MatrixSymmetric3D::symmetrisedDyadic(), and Vec3D().

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

Math/Vector.h
Math/Vector.cc

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation