#include <Vector.h>

Public Member Functions
	Vec3D ()
	constructor More...

	Vec3D (const SmallVector< 3 > &vector)

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

	Vec3D (std::array< double, 3 > a)

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

void	setNaN ()
	Sets all elements to NaN. More...

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

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

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

Vec3D	operator- (const Vec3D a) const
	Binary vector subtraction. More...

bool	operator== (const Vec3D &a) const

Vec3D	multiplyElementwise (const Vec3D &a) const

Vec3D	divideElementwise (const Vec3D &a) const

Vec3D	signedSquare () const

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

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

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

bool	operator>= (const Vec3D &a) const
	Checks if all coordinates satisfy this>=a. More...

bool	operator< (const Vec3D &a) const

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

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

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

void	normalise ()
	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 (int index) const
	Returns the requested component of this Vec3D. More...

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

Mdouble &	x ()
	RW reference to X. More...

Mdouble	x () const
	RO reference to X. More...

Mdouble &	y ()
	RW reference to Y. More...

Mdouble	y () const
	RO reference to Y. More...

Mdouble &	z ()
	RW reference to Z. More...

Mdouble	z () const
	RO reference to Z. More...

void	setX (Mdouble x)

void	setY (Mdouble y)

void	setZ (Mdouble z)

Mdouble	getX () const

Mdouble	getY () const

Mdouble	getZ () const

void	set (Mdouble x, Mdouble y, Mdouble z)

Mdouble	getRadialCoordinateSquared () const
	Returns the square of the radial cylindrical coordinate, r^2=x^2+y^2. More...

Mdouble	getRadialCoordinate () const
	Returns the square of the radial cylindrical coordinate, r=sqrt(x^2+y^2). More...

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

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

Vec3D	getCylindricalTensorField (const Vec3D &position) const
	Returns this vector field at point p to cylindrical coordinates. More...

bool	isEqualTo (const Vec3D &other, 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 double	max (const Vec3D &a)
	Calculates the maximum coordinate of vector a. More...

static double	min (const Vec3D &a)
	Calculates the minimum coordinate of vector a. 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 Vec3D &a)
	Reverts the direction of a vector. More...

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

Constructor & Destructor Documentation

◆ Vec3D() [1/4]

Vec3D::Vec3D ( )

inline

constructor

72 { setZero(); }

Vec3D::setZero

void setZero()

Sets all elements to zero.

Definition: Vector.cc:43

References setZero().

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

◆ Vec3D() [2/4]

Vec3D::Vec3D ( const SmallVector< 3 > & vector )

Alternative constructor, that constructs a Vec3D from a SmallVector size 3

Parameters

[in] vector Small vector that should be copied

 {
     X = vector[0];
     Y = vector[1];
     Z = vector[2];
 }

References X, Y, and Z.

◆ Vec3D() [3/4]

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

inline

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

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

References X, x(), Y, y(), Z, and z().

◆ Vec3D() [4/4]

Vec3D::Vec3D ( std::array< double, 3 > a )

inline

Defines mapping between std::array<double,3> and Vec3D

     {
         X = a[0];
         Y = a[1];
         Z = a[2];
     }

References X, Y, and Z.

Member Function Documentation

◆ cross()

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

 {
     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);
 }

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

Referenced by MarbleRun::actionsAfterTimeStep(), IntersectionOfWalls::add3PointObject(), ChuteWithHopper::addHopper(), IntersectionOfWalls::addTetra(), IntersectionOfWalls::addTetraSTL(), MeshTriangle::checkInteractions(), DPMBase::computeAllForces(), Mercury3Dclump::computeAllForces(), DPMBase::computeForcesDueToWalls(), Mercury3Dclump::computeForcesDueToWalls(), FrictionInteraction::computeFrictionForce(), MindlinRollingTorsionInteraction::computeFrictionForce(), DPMBase::computeInternalForce(), Mercury3Dclump::computeInternalForce(), ChuteWithPeriodicInflow::computeInternalForces(), IntersectionOfWalls::createOpenPrism(), IntersectionOfWalls::createPrism(), BaseParticle::getAngularMomentum(), MeshTriangle::getBaricentricWeight(), HorizontalBaseScrew::getDistanceAndNormal(), BasicIntersectionOfWalls::getDistanceAndNormal(), BaseWall::getInteractionWith(), TriangleMeshWall::getInteractionWith(), ParticleParticleCollision::getRelativeVelocity(), WallParticleCollision::getRelativeVelocity(), Membrane::Edge::getSineHalfTheta(), BaseInteractable::getVelocityAtContact(), TriangleMeshWall::getVolumeTetrahedron(), InfiniteWall::InfiniteWall(), TriangleWall::isInsideTriangle(), main(), WearableTriangulatedWall::processDebris(), ClumpParticle::rotatePrincipalDirections(), AngledPeriodicBoundary::set(), TriangulatedWall::setNormalsAndNeighbours(), IntersectionOfWalls::setPointsAndLines(), AxisymmetricHopper::setupInitialConditions(), WearableTriangleMeshWall::storeDebris(), WearableTriangulatedWall::storeDebris(), UniformRandomPDs(), ClumpParticle::updatePebblesVelPos(), MeshTriangle::updateVertexAndNormal(), TriangleWall::updateVertexAndNormal(), and WallVTKWriter::writeVTKSurfaceArea().

◆ divideElementwise()

Vec3D Vec3D::divideElementwise ( const Vec3D & a ) const

inline

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

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

◆ dot()

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

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

References X, Y, and Z.

◆ getComponent()

Mdouble Vec3D::getComponent ( 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

 {
     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;
     }
 }

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

Referenced by MeshTriangle::checkInteractions(), Dipole::computeMultipoleExpansion(), Domain::containsParticle(), Panel::createPanels(), Domain::findNearbyBoundaries(), Panel::Panel(), Domain::setBounds(), and Domain::setRange().

◆ getCylindricalCoordinates()

Vec3D Vec3D::getCylindricalCoordinates ( ) const

Returns the representation of this Vec3D in cylindrical coordinates.

Transforms the (Cartesian) vector to cylindrical coordinates

Returns: Transformed vector

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

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

◆ getCylindricalTensorField()

Vec3D Vec3D::getCylindricalTensorField ( const Vec3D & p ) const

Returns this vector field at point p to cylindrical coordinates.

Transforms the (Cartesian) vector to cylindrical coordinates. See https://en.wikipedia.org/wiki/Vector_fields_in_cylindrical_and_spherical_coordinates

Returns: Transformed vector

 {
     //define sin(A)=y/r, cos(A)=x/r
     Mdouble r = std::sqrt(p.X * p.X + p.Y * p.Y);
     Mdouble s = p.Y / r;
     Mdouble c = p.X / r;
     if (r == 0)
     {
         s = 0;
         c = 1;
     }
     return Vec3D(X * c + Y * s, -X * s + Y * c, Z);
 }

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

Referenced by main(), CGFields::StandardFields::setCylindricalFields(), and CGFields::GradVelocityField::setCylindricalFields().

◆ getDistance()

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 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.

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.

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

References getDistanceSquared().

Referenced by main(), and Panel::setPanelInteractions().

◆ getDistanceSquared()

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

inlinestatic

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

                                                                       {
         const double X = a.X-b.X;
         const double Y = a.Y-b.Y;
         const double Z = a.Z-b.Z;
         return (X * X + Y * Y + Z * Z);
         //return getLengthSquared(a - b);
     }

References X, Y, and Z.

Referenced by Mercury3Dclump::checkClumpForInteraction(), Mercury3Dclump::checkClumpForInteractionPeriodic(), DPMBase::checkParticleForInteractionLocal(), ChuteWithPeriodicInflow::computeInternalForces(), getDistance(), Mercury3D::hGridFindContactsWithTargetCell(), and BaseParticle::isInContactWith().

◆ getFromCylindricalCoordinates()

Vec3D Vec3D::getFromCylindricalCoordinates ( ) const

Returns the representation of this Vec3D in cylindrical coordinates.

Transforms the (cylindrical) vector to cartesian coordinates

Returns: Transformed vector

Todo:

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

References mathsFunc::cos(), mathsFunc::sin(), Vec3D(), X, Y, and Z.

◆ getLength() [1/2]

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

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

References getLengthSquared().

Referenced by CGHandler::computeContactPoints(), AngledPeriodicBoundarySecondUnitTest::computeExternalForces(), ChuteWithPeriodicInflow::computeInternalForces(), SphericalWall::getDistance(), SphericalWall::getDistanceAndNormal(), TriangulatedWall::Face::getDistanceAndNormal(), AngledPeriodicBoundary::set(), AxisymmetricHopper::setupInitialConditions(), and testCGHandler().

◆ getLength() [2/2]

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.

 {
     return a.getLength();
 }

References getLength().

◆ getLengthSquared() [1/2]

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

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

References X, Y, and Z.

Referenced by DPM::computeLocalCGHGrid(), DPM::computeLocalVolumeFraction(), DPM::computeLocalVolumeFractionHGrid(), HorizontalBaseScrew::convertLimits(), Domain::findNewMPIInteractions(), NurbsSurface::getDistance(), HorizontalBaseScrew::getDistanceAndNormal(), TriangulatedWall::Face::getDistanceAndNormal(), CGCoordinates::XYZ::getDistanceSquared(), SuperQuadricParticle::getInitialGuessForContact(), BaseParticle::getInteractionWith(), SuperQuadricParticle::getInteractionWith(), getLength(), CGCoordinates::XYZ::getTangentialSquared(), isEqualTo(), and normalise().

◆ getLengthSquared() [2/2]

static Mdouble Vec3D::getLengthSquared ( const Vec3D & a )

inlinestatic

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.

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

References X, Y, and Z.

Referenced by VolumeCoupling::actionsAfterTimeStep(), LawinenBox::actionsBeforeTimeStep(), IntersectionOfWalls::add3PointObject(), ChuteWithHopper::addHopper(), IntersectionOfWalls::addPlate(), IntersectionOfWalls::addTetra(), IntersectionOfWalls::addTetraSTL(), PeriodicBoundary::checkBoundaryAfterParticlesMove(), FrictionInteraction::computeFrictionForce(), MindlinRollingTorsionInteraction::computeFrictionForce(), SlidingFrictionInteraction::computeFrictionForce(), ChuteWithPeriodicInflow::computeInternalForces(), NurbsSurface::getDistance(), IntersectionOfWalls::getDistanceAndNormal(), SimpleDrumSuperquadrics::getDistanceNormalOverlapSuperquadric(), FrictionInteraction::getElasticEnergy(), MindlinInteraction::getElasticEnergy(), MindlinRollingTorsionInteraction::getElasticEnergy(), SlidingFrictionInteraction::getElasticEnergy(), BaseParticle::getKineticEnergy(), ClumpParticle::getRotationalEnergy(), getUnitVector(), InfiniteWall::InfiniteWall(), BaseParticle::integrateBeforeForceComputation(), ClumpParticle::integrateBeforeForceComputation(), LawinenBox::printTime(), setDistance(), DPMBase::setMeanVelocityAndKineticEnergy(), Domain::updateParticlePosition(), and PeriodicBoundaryHandler::updateParticles().

◆ getRadialCoordinate()

Mdouble Vec3D::getRadialCoordinate ( ) const

Returns the square of the radial cylindrical coordinate, r=sqrt(x^2+y^2).

 {
     return std::sqrt(X * X + Y * Y);
 }

References X, and Y.

◆ getRadialCoordinateSquared()

Mdouble Vec3D::getRadialCoordinateSquared ( ) const

Returns the square of the radial cylindrical coordinate, r^2=x^2+y^2.

 {
     return X * X + Y * Y;
 }

References X, and Y.

◆ getUnitVector()

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).

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

References getLengthSquared(), and Vec3D().

Referenced by IntersectionOfWalls::createOpenPrism(), IntersectionOfWalls::createPrism(), MindlinInteraction::getTangentialOverlap(), WearableTriangulatedWall::processDebris(), TriangulatedWall::setNormalsAndNeighbours(), CGHandlerSelfTest::setupInitialConditions(), and MindlinInteraction::updateK_t().

◆ getX()

Mdouble Vec3D::getX ( ) const

inline

403 { return X; }

References X.

Referenced by MercuryProblem::actionsAfterTimeStep(), VolumeCoupling::checkParticlesInFiniteElems(), VolumeCoupling::computeCouplingOnFEM(), SCoupling< M, O >::computeSCouplingForcesFromTriangles(), VolumeCoupling::computeWeightOnParticles(), VolumeCoupling::getProjectionAndProjected(), and BaseCoupling< M, O >::writeEneTimeStep().

◆ getY()

Mdouble Vec3D::getY ( ) const

inline

406 { return Y; }

References Y.

Referenced by MercuryProblem::actionsAfterTimeStep(), VolumeCoupling::checkParticlesInFiniteElems(), VolumeCoupling::computeCouplingOnFEM(), SCoupling< M, O >::computeSCouplingForcesFromTriangles(), VolumeCoupling::computeWeightOnParticles(), and VolumeCoupling::getProjectionAndProjected().

◆ getZ()

Mdouble Vec3D::getZ ( ) const

inline

409 { return Z; }

References Z.

Referenced by MercuryProblem::actionsAfterTimeStep(), VolumeCoupling::checkParticlesInFiniteElems(), VolumeCoupling::computeCouplingOnFEM(), SCoupling< M, O >::computeSCouplingForcesFromTriangles(), VolumeCoupling::computeWeightOnParticles(), VolumeCoupling::getProjectionAndProjected(), RollingOverTriangleWalls::setupInitialConditions(), and MercuryProblem::setupInitialConditions().

◆ isEqualTo()

bool Vec3D::isEqualTo	(	const Vec3D &	other,
		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.

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

References getLengthSquared().

Referenced by TriangleMeshWall::addToMesh(), STLTriangle::isEqualTo(), and main().

◆ isNaN()

bool Vec3D::isNaN ( ) const

Checks if ALL elements are zero.

Checks if ALL elements are zero

Returns: TRUE if ALL elements are zero

 {
     return std::isnan(X) || std::isnan(Y) || std::isnan(Z);
 }

References X, Y, and Z.

◆ isZero()

bool Vec3D::isZero ( ) const

inline

Checks if ALL elements are zero.

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

References X, Y, and Z.

Referenced by MeshTriangle::rotate(), TriangleWall::rotate(), and ArcWallUnitTest::setupInitialConditions().

◆ max() [1/2]

static double Vec3D::max ( const Vec3D & a )

inlinestatic

Calculates the maximum coordinate of vector a.

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

References X, Y, and Z.

◆ max() [2/2]

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

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

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

Referenced by statistics_while_running< T >::auto_set_domain(), FileReader::read(), TriangleMeshWall::updateBoundingBox(), TriangleMeshWall::updateBoundingBoxGlobal(), MeshTriangle::updateVertexAndNormal(), and TriangleWall::updateVertexAndNormal().

◆ min() [1/2]

static double Vec3D::min ( const Vec3D & a )

inlinestatic

Calculates the minimum coordinate of vector a.

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

References X, Y, and Z.

◆ min() [2/2]

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

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

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

Referenced by BaseWall::addParticlesAtWall(), statistics_while_running< T >::auto_set_domain(), FileReader::read(), TriangleMeshWall::updateBoundingBox(), TriangleMeshWall::updateBoundingBoxGlobal(), MeshTriangle::updateVertexAndNormal(), and TriangleWall::updateVertexAndNormal().

◆ multiplyElementwise()

Vec3D Vec3D::multiplyElementwise ( const Vec3D & a ) const

inline

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

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

Referenced by BaseWall::setForceControl(), and BaseWall::setVelocityControl().

◆ normalise()

void Vec3D::normalise ( )

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).

 {
     Mdouble length2 = this->getLengthSquared();
     if (length2 == 0)
     {
         logger(ERROR, "Normalizing a vector of length 0");
     }
     *this /= std::sqrt(length2);
 }

References ERROR, getLengthSquared(), and logger.

Referenced by IntersectionOfWalls::addObject(), IntersectionOfWalls::addTetraSTL(), SlidingFrictionInteraction::computeSlidingSpringSuperQuadric(), ArcWall::getDistanceAndNormal(), HorizontalScrew::getDistanceAndNormal(), ScrewsymmetricIntersectionOfWalls::getDistanceAndNormal(), SimpleDrumSuperquadrics::getDistanceAndNormal(), Screw::getDistanceAndNormalLabCoordinates(), SimpleDrumSuperquadrics::getDistanceNormalOverlapSuperquadric(), ClumpParticle::rotatePrincipalDirections(), ArcWall::set(), setLength(), Quaternion::setOrientationViaNormal(), HorizontalMixer::setOuterWalls(), HorizontalMixerWalls::setOuterWalls(), UniformRandomPDs(), MeshTriangle::updateVertexAndNormal(), and TriangleWall::updateVertexAndNormal().

◆ operator*()

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

inline

Multiplies by a scalar.

Multiplies each element with a scalar

Parameters

[in] a the scalar to be multiplied with

Returns: the resulting vector

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

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

◆ operator*=()

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

inline

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

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

References X, Y, and Z.

◆ operator+()

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

inline

Adds another vector.

Adds vector to itself

Parameters

[in] a vector to be added

Returns: resulting 3D vector

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

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

◆ operator+=()

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

inline

Adds another vector.

Adds a vector to itself

Parameters

[in] a vector to be added

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

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

References X, Y, and Z.

◆ operator-()

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

inline

Binary vector subtraction.

Subtracts a vector from another vector

Parameters

[in] a vector to be subtracted

Returns: resulting vector

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

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

◆ operator-=()

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

inline

Subtracts another vector.

Subtracts a vector from itself

Parameters

[in] a vector to be subtracted

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

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

References X, Y, and Z.

◆ operator/()

Vec3D Vec3D::operator/ ( Mdouble a ) const

inline

Divides by a scalar.

Divides each element by a scalar

Parameters

[in] a the scalar to be divided by

Returns: resulting vector

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

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

◆ operator/=()

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

inline

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

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

References X, Y, and Z.

◆ operator<()

bool Vec3D::operator< ( const Vec3D & a ) const

inline

                                          {
         return X<a.X && Y<a.Y && Z<a.Z;
     }

References X, Y, and Z.

◆ operator==()

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

inline

     {
         return X == a.X and Y == a.Y and Z == a.Z;
     };

References X, Y, and Z.

◆ operator>=()

bool Vec3D::operator>= ( const Vec3D & a ) const

inline

Checks if all coordinates satisfy this>=a.

                                           {
         return X>=a.X && Y>=a.Y && Z>=a.Z;
     }

References X, Y, and Z.

◆ set()

void Vec3D::set	(	Mdouble	x,
		Mdouble	y,
		Mdouble	z
	)

inline

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

References X, x(), Y, y(), Z, and z().

◆ setComponent()

void Vec3D::setComponent	(	int	index,
		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

 {
     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);
     }
 }

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

Referenced by ScaleCoupling< M, O >::computeCouplingForce(), Panel::createPanels(), Panel::Panel(), and Domain::setBounds().

◆ setLength()

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

 {
     this->normalise();
     *this *= length;
 }

References normalise().

◆ setNaN()

void Vec3D::setNaN ( )

Sets all elements to NaN.

Sets each element to zero.

 {
     X = constants::NaN;
     Y = constants::NaN;
     Z = constants::NaN;
 }

References constants::NaN, X, Y, and Z.

Referenced by BaseInteraction::BaseInteraction().

◆ setX()

void Vec3D::setX ( Mdouble x )

inline

394 { X = x; }

References X, and x().

Referenced by SCoupling< M, O >::createDPMWallsFromFiniteElems().

◆ setY()

void Vec3D::setY ( Mdouble y )

inline

397 { Y = y; }

References Y, and y().

Referenced by SCoupling< M, O >::createDPMWallsFromFiniteElems().

◆ setZ()

void Vec3D::setZ ( Mdouble z )

inline

400 { Z = z; }

References Z, and z().

Referenced by SCoupling< M, O >::createDPMWallsFromFiniteElems().

◆ setZero()

void Vec3D::setZero ( )

Sets all elements to zero.

Sets each element to zero.

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

References X, Y, and Z.

Referenced by BaseInteractable::BaseInteractable(), BaseInteraction::BaseInteraction(), BaseParticle::BaseParticle(), Coil::Coil(), ChuteWithPeriodicInflow::computeInternalForces(), FrictionInteraction::FrictionInteraction(), HorizontalScrew::HorizontalScrew(), BaseCluster::makeDataAnalysis(), MindlinInteraction::MindlinInteraction(), MindlinRollingTorsionInteraction::MindlinRollingTorsionInteraction(), BaseInteractable::resetForceTorque(), Screw::Screw(), CGFields::GradVelocityField::setZero(), CGFields::StandardFields::setZero(), SlidingFrictionInteraction::SlidingFrictionInteraction(), StatisticsPoint< T >::StatisticsPoint(), testCGHandler(), Vec3D(), CFile::writeP4C(), and CFile::writeP4W().

◆ signedSquare()

Vec3D Vec3D::signedSquare ( ) const

inline

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

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

◆ sqrt()

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.

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

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

◆ square()

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.

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

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

Referenced by CGFields::GradVelocityField::getSquared(), and CGFields::StandardFields::getSquared().

◆ x() [1/2]

Mdouble& Vec3D::x ( )

inline

RW reference to X.

361 { return X; }

References X.

Referenced by MeshTriangle::getVelocityAtContact(), DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::read(), DPMBase::readNextDataFile(), DPMBase::readOld(), WallHandler::readTriangleWall(), set(), DPMBase::setMax(), DPMBase::setMin(), setX(), DPMBase::setXMax(), DPMBase::setXMin(), and Vec3D().

◆ x() [2/2]

Mdouble Vec3D::x ( ) const

inline

RO reference to X.

367 { return X; }

References X.

◆ y() [1/2]

Mdouble& Vec3D::y ( )

inline

RW reference to Y.

373 { return Y; }

References Y.

Referenced by MeshTriangle::getVelocityAtContact(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::read(), DPMBase::readNextDataFile(), DPMBase::readOld(), WallHandler::readTriangleWall(), set(), DPMBase::setMax(), DPMBase::setMin(), setY(), DPMBase::setYMax(), DPMBase::setYMin(), and Vec3D().

◆ y() [2/2]

Mdouble Vec3D::y ( ) const

inline

RO reference to Y.

379 { return Y; }

References Y.

◆ z() [1/2]

Mdouble& Vec3D::z ( )

inline

RW reference to Z.

385 { return Z; }

References Z.

Referenced by MeshTriangle::getVelocityAtContact(), DPMBase::getZMax(), DPMBase::getZMin(), DPMBase::read(), DPMBase::readNextDataFile(), DPMBase::readOld(), WallHandler::readTriangleWall(), set(), DPMBase::setMax(), DPMBase::setMin(), setZ(), DPMBase::setZMax(), DPMBase::setZMin(), and Vec3D().

◆ z() [2/2]

Mdouble Vec3D::z ( ) const

inline

RO reference to Z.

391 { return Z; }

References Z.

Friends And Related Function Documentation

◆ operator*

Vec3D operator*	(	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

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

◆ operator-

Vec3D operator- ( const Vec3D & a )

friend

Reverts the direction of a vector.

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

◆ operator<<

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

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

◆ operator>>

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

 {
     //TW: clearing the stream avoids the nasty problem that the failbit is set to true if numbers below DBL_MIN=1e-308 are read.
     is >> a.X;
     if (is.fail()) {
         logger(VERBOSE,"Failed to read x-value %", a.X);
         //a.X = 0;
         is.clear();
     }
     is >> a.Y;
     if (is.fail()) {
         logger(VERBOSE,"Failed to read y-value %", a.Y);
         //a.Y = 0;
         is.clear();
     }
     is >> a.Z;
     if (is.fail()) {
         logger(VERBOSE,"Failed to read z-value %", a.Z);
         //a.Z = 0;
         is.clear();
     }
     return is;
 }

Member Data Documentation

◆ X

Mdouble Vec3D::X

the vector components

◆ Y

Mdouble Vec3D::Y

◆ Z

Mdouble Vec3D::Z

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

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Constructor & Destructor Documentation

◆ Vec3D() [1/4]

◆ Vec3D() [2/4]

◆ Vec3D() [3/4]

◆ Vec3D() [4/4]

Member Function Documentation

◆ cross()

◆ divideElementwise()

◆ dot()

◆ getComponent()

◆ getCylindricalCoordinates()

◆ getCylindricalTensorField()

◆ getDistance()

◆ getDistanceSquared()

◆ getFromCylindricalCoordinates()

◆ getLength() [1/2]

◆ getLength() [2/2]

◆ getLengthSquared() [1/2]

◆ getLengthSquared() [2/2]

◆ getRadialCoordinate()

◆ getRadialCoordinateSquared()

◆ getUnitVector()

◆ getX()

◆ getY()

◆ getZ()

◆ isEqualTo()

◆ isNaN()

◆ isZero()

◆ max() [1/2]

◆ max() [2/2]

◆ min() [1/2]

◆ min() [2/2]

◆ multiplyElementwise()

◆ normalise()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator<()

◆ operator==()

◆ operator>=()

◆ set()

◆ setComponent()

◆ setLength()

◆ setNaN()

◆ setX()

◆ setY()

◆ setZ()

◆ setZero()

◆ signedSquare()

◆ sqrt()

◆ square()

◆ x() [1/2]

◆ x() [2/2]

◆ y() [1/2]

◆ y() [2/2]

◆ z() [1/2]

◆ z() [2/2]

Friends And Related Function Documentation

◆ operator*

◆ operator-

◆ operator<<

◆ operator>>

Member Data Documentation

◆ X

◆ Y

◆ Z