A structure to represent 3d vectors. More...

#include <point.h>

Collaboration diagram for util::Point:

Public Member Functions
	Point ()
	Constructor.

template<class T >
	Point (T x, T y, T z)
	Constructor.

template<class T >
	Point (T x[3])
	Constructor.

	Point (const std::vector< double > &p)
	Constructor.

	Point (const Point &p)
	Copy constructor.

std::string	printStr (int nt=0, int lvl=0) const
	Returns the string containing printable information about the object.

void	print (int nt=0, int lvl=0) const
	Prints the information about the object.

double	length () const
	Computes the Euclidean length of the vector.

double	lengthSq () const
	Computes the Euclidean length of the vector.

double	dot (const Point &b) const
	Computes the dot product of this vector with another point.

double	dist (const Point &b) const
	Computes the distance between a given point from this point.

Point	cross (const Point &b) const
	Computes the cross product between this vector and given vector.

Point	project (const Point &b, bool is_unit=false) const
	Computes projection of vector on this vector.

Point	projectNormal (const Point &b, bool is_unit=false) const
	Computes projection of vector on plane with normal as this vector.

Data Fields
double	d_x
	the x coordinate

double	d_y
	the y coordinate

double	d_z
	the z coordinate

Group operators
Point &	operator+= (const double b)
	Addition by scalar operator.

Point &	operator-= (const double b)
	Subtraction by scalar operator.

Point &	operator*= (const double b)
	Multiplication by scalar operator.

Point &	operator+= (const Point &b)
	Addition operator.

Point &	operator-= (const Point &b)
	Subtraction operator.

Point &	operator*= (const Point &b)
	Multiplication (pointwise/elementwise) operator.

Point &	operator/= (const double b)
	Division by scalar operator.

double &	operator[] (size_t i)
	Access operator.

const double &	operator[] (size_t i) const
	Access operator.

Point	operator+ (Point lhs, const Point &rhs)
	Addition operator.

Point	operator- (Point lhs, const Point &rhs)
	Subtraction operator.

double	operator* (Point lhs, const Point rhs)
	Multiplication (dot) operator.

Point	operator* (Point lhs, const double rhs)
	Scalar product operator.

Point	operator+ (Point lhs, const double rhs)
	Addition by scalar operator.

Point	operator+ (const double lhs, Point rhs)
	Addition by scalar operator.

Point	operator- (Point lhs, const double rhs)
	Subtraction by scalar operator.

Point	operator- (const double lhs, Point rhs)
	Subtraction by scalar operator.

Point	operator* (const double lhs, Point rhs)
	Multiplication by scalar operator.

Point	operator/ (Point lhs, const double rhs)
	Division by scalar operator.

Detailed Description

A structure to represent 3d vectors.

Definition at line 30 of file point.h.

Constructor & Destructor Documentation

◆ Point() [1/5]

util::Point::Point ( )

inline

Constructor.

Definition at line 44 of file point.h.

44: d_x(0.), d_y(0.), d_z(0.){};

util::Point::d_y

double d_y

the y coordinate

Definition point.h:36

util::Point::d_z

double d_z

the z coordinate

Definition point.h:39

util::Point::d_x

double d_x

the x coordinate

Definition point.h:33

Referenced by projectNormal().

Here is the caller graph for this function:

◆ Point() [2/5]

template<class T >

util::Point::Point	(	T	x,
		T	y,
		T	z
	)

inline

Constructor.

Parameters

x	The x coordinate
y	The y coordinate
z	The z coordinate

Definition at line 52 of file point.h.

52: d_x(x), d_y(y), d_z(z){};

◆ Point() [3/5]

template<class T >

util::Point::Point ( T x[3] )

inlineexplicit

Constructor.

Parameters

x	The coordinate vector

Definition at line 59 of file point.h.

59: d_x(x[0]), d_y(x[1]), d_z(x[2]){};

◆ Point() [4/5]

util::Point::Point ( const std::vector< double > & p )

inlineexplicit

Constructor.

Parameters

p Vector

Definition at line 65 of file point.h.

                                             {
 
    if (p.empty())
      return;
    else if (p.size() == 1)
      d_x = p[0];
    else if (p.size() == 2) {
      d_x = p[0];
      d_y = p[1];
    } else if (p.size() == 3) {
      d_x = p[0];
      d_y = p[1];
      d_z = p[2];
    }
  };

References d_x, d_y, and d_z.

◆ Point() [5/5]

util::Point::Point ( const Point & p )

inline

Copy constructor.

Parameters

p	Another Point object

Definition at line 85 of file point.h.

85: d_x(p.d_x), d_y(p.d_y), d_z(p.d_z) {};

Member Function Documentation

◆ cross()

Point util::Point::cross ( const Point & b ) const

inline

Computes the cross product between this vector and given vector.

Parameters

b	Another vector

Returns: Vector Cross product

Definition at line 151 of file point.h.

                                    {
    return {-d_z * b.d_y + d_y * b.d_z,
            d_z * b.d_x - d_x * b.d_z,
            -d_y * b.d_x + d_x * b.d_y};
  }

References d_x, d_y, and d_z.

Referenced by util::angle().

Here is the caller graph for this function:

◆ dist()

double util::Point::dist ( const Point & b ) const

inline

Computes the distance between a given point from this point.

Parameters

b	Another point

Returns: Value Distance between the two points

Definition at line 140 of file point.h.

                                    {
    return std::sqrt((d_x - b.d_x) * (d_x - b.d_x) +
                     (d_y - b.d_y) * (d_y - b.d_y) +
                     (d_z - b.d_z) * (d_z - b.d_z));
  }

References d_x, d_y, and d_z.

Referenced by util::doubleGaussian2d(), and util::gaussian2d().

Here is the caller graph for this function:

◆ dot()

double util::Point::dot ( const Point & b ) const

inline

Computes the dot product of this vector with another point.

Parameters

b	Another vector

Returns: Value a dot product

Definition at line 132 of file point.h.

132 { return d_x * b.d_x + d_y * b.d_y + d_z * b

133 .d_z; }

References d_x, d_y, and d_z.

Referenced by material::RnpMaterial::getS(), project(), and projectNormal().

Here is the caller graph for this function:

◆ length()

double util::Point::length ( ) const

inline

Computes the Euclidean length of the vector.

Returns: Length Euclidean length of the vector

Definition at line 118 of file point.h.

118{ return std::sqrt(d_x * d_x + d_y * d_y + d_z * d_z); }

References d_x, d_y, and d_z.

Referenced by util::angle(), material::RnpMaterial::getBondForceDirection(), material::PmbMaterial::getS(), material::PdElastic::getS(), material::PdState::getS(), util::geometry::BoxPartition::isNear(), util::pointDistancePlane(), util::pointDistanceSegment(), project(), and projectNormal().

Here is the caller graph for this function:

◆ lengthSq()

double util::Point::lengthSq ( ) const

inline

Computes the Euclidean length of the vector.

Returns: Length Euclidean length of the vector

Definition at line 124 of file point.h.

124 { return d_x * d_x + d_y * d_y + d_z *

125 d_z; }

References d_x, d_y, and d_z.

Referenced by util::pointDistanceLine().

Here is the caller graph for this function:

◆ operator*=() [1/2]

Point & util::Point::operator*= ( const double b )

inline

Multiplication by scalar operator.

Parameters

b Scalar

Returns: point Vector after multiplying b to this point

Definition at line 322 of file point.h.

                                    {
 
    d_x *= b;
    d_y *= b;
    d_z *= b;
    return *this;
  }

References d_x, d_y, and d_z.

◆ operator*=() [2/2]

Point & util::Point::operator*= ( const Point & b )

inline

Multiplication (pointwise/elementwise) operator.

Parameters

b Vector

Returns: point Vector after elementwise multiplication of b with this point

Definition at line 361 of file point.h.

                                    {
 
    d_x *= b.d_x;
    d_y *= b.d_y;
    d_z *= b.d_z;
    return *this;
  }

References d_x, d_y, and d_z.

◆ operator+=() [1/2]

Point & util::Point::operator+= ( const double b )

inline

Addition by scalar operator.

Parameters

b Scalar

Returns: point Vector after adding b to this point

Definition at line 296 of file point.h.

                                    {
 
    d_x += b;
    d_y += b;
    d_z += b;
    return *this;
  }

References d_x, d_y, and d_z.

◆ operator+=() [2/2]

Point & util::Point::operator+= ( const Point & b )

inline

Addition operator.

Parameters

b	Vector to be added

Returns: point Vector after adding b to this point

Definition at line 335 of file point.h.

                                    {
 
    d_x += b.d_x;
    d_y += b.d_y;
    d_z += b.d_z;
    return *this;
  }

References d_x, d_y, and d_z.

◆ operator-=() [1/2]

Point & util::Point::operator-= ( const double b )

inline

Subtraction by scalar operator.

Parameters

b Scalar

Returns: point Vector after subtracting b from this point

Definition at line 309 of file point.h.

                                    {
 
    d_x -= b;
    d_y -= b;
    d_z -= b;
    return *this;
  }

References d_x, d_y, and d_z.

◆ operator-=() [2/2]

Point & util::Point::operator-= ( const Point & b )

inline

Subtraction operator.

Parameters

b	Vector to subtract

Returns: point Vector after subtracting b from this point

Definition at line 348 of file point.h.

                                    {
 
    d_x -= b.d_x;
    d_y -= b.d_y;
    d_z -= b.d_z;
    return *this;
  }

References d_x, d_y, and d_z.

◆ operator/=()

Point & util::Point::operator/= ( const double b )

inline

Division by scalar operator.

Parameters

b Scalar

Returns: point Vector after dividing b elementwise from this point

Definition at line 374 of file point.h.

                                    {
 
    d_x /= b;
    d_y /= b;
    d_z /= b;
    return *this;
  }

References d_x, d_y, and d_z.

◆ operator[]() [1/2]

double & util::Point::operator[] ( size_t i )

inline

Access operator.

Parameters

i	Index of element in vector to access

Returns: value Value of ith element in vector

Definition at line 387 of file point.h.

                               {
 
    if (i == 0)
      return d_x;
    else if (i == 1)
      return d_y;
    else
      return d_z;
  }

References d_x, d_y, and d_z.

◆ operator[]() [2/2]

const double & util::Point::operator[] ( size_t i ) const

inline

Access operator.

Parameters

i	Index of element in vector to access

Returns: value Value of ith element in vector

Definition at line 398 of file point.h.

                                           {
 
    if (i == 0)
      return d_x;
    else if (i == 1)
      return d_y;
    else
      return d_z;
  }

References d_x, d_y, and d_z.

◆ print()

void util::Point::print	(	int	nt = `0`,
		int	lvl = `0`
	)		const

inline

Prints the information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Definition at line 112 of file point.h.

112{ std::cout << printStr(nt, lvl); }

util::Point::printStr

std::string printStr(int nt=0, int lvl=0) const

Returns the string containing printable information about the object.

Definition point.h:94

References printStr().

Here is the call graph for this function:

◆ printStr()

std::string util::Point::printStr	(	int	nt = `0`,
		int	lvl = `0`
	)		const

inline

Returns the string containing printable information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Returns: string String containing printable information about the object

Definition at line 94 of file point.h.

                                                    {
 
    std::string tabS = "";
    for (int i = 0; i < nt; i++)
      tabS += "\t";
 
    std::ostringstream oss;
    oss << tabS << "(" << d_x << ", " << d_y << ", " << d_z << ")";
 
    return oss.str();
  }

References d_x, d_y, and d_z.

Referenced by print(), fe::QuadData::printStr(), inp::ParticleDeck::printStr(), inp::PICDeck::printStr(), and particle::ParticleTransform::printStr().

Here is the caller graph for this function:

◆ project()

Point util::Point::project	(	const Point &	b,
		bool	is_unit = `false`
	)		const

inline

Computes projection of vector on this vector.

Parameters

b	Another vector
is_unit	Specify if this is a unit vector

Returns: Vector Projection vector

Definition at line 163 of file point.h.

                                                            {
    auto l_sq = (is_unit ? 1. : this->length() * this->length());
    auto dot = this->dot(b);
    return {dot * d_x / l_sq, dot * d_y / l_sq, dot * d_z / l_sq};
  }

References d_x, d_y, d_z, dot(), and length().

Here is the call graph for this function:

◆ projectNormal()

Point util::Point::projectNormal	(	const Point &	b,
		bool	is_unit = `false`
	)		const

inline

Computes projection of vector on plane with normal as this vector.

Parameters

b	Another vector
is_unit	Specify if this is a unit vector

Returns: Vector Projection vector

Definition at line 175 of file point.h.

                                                                  {
    auto l_sq = (is_unit ? 1. : this->length() * this->length());
    auto dot = this->dot(b);
    return b - Point(dot * d_x / l_sq, dot * d_y / l_sq, dot * d_z / l_sq);
  }

References d_x, d_y, d_z, dot(), length(), and Point().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ operator* [1/3]

Point operator*	(	const double	lhs,
		Point	rhs
	)

friend

Multiplication by scalar operator.

Parameters

lhs	lhs scalar
rhs	rhs vector

Returns: point Vector after multiplying lhs to rhs pointwise

Definition at line 275 of file point.h.

                                                      {
    rhs *= lhs;
    return rhs;
  }

◆ operator* [2/3]

Point operator*	(	Point	lhs,
		const double	rhs
	)

friend

Scalar product operator.

Parameters

lhs	lhs (to be modified)
rhs	rhs scalar (to be multiplied to lhs)

Returns: point lhs after multiplying rhs to it

Definition at line 224 of file point.h.

                                                      {
    lhs *= rhs;
    return lhs;
  }

◆ operator* [3/3]

double operator*	(	Point	lhs,
		const Point	rhs
	)

friend

Multiplication (dot) operator.

Parameters

lhs	lhs
rhs	rhs

Returns: product Dot product of two vectors

Definition at line 214 of file point.h.

                                                      {
    return lhs.d_x * rhs.d_x + lhs.d_y * rhs.d_y + lhs.d_z * rhs.d_z;
  }

◆ operator+ [1/3]

Point operator+	(	const double	lhs,
		Point	rhs
	)

friend

Addition by scalar operator.

Parameters

lhs	lhs scalar
rhs	rhs (to be added to lhs)

Returns: point After adding lhs to rhs

Definition at line 245 of file point.h.

                                                      {
    return {lhs + rhs.d_x, lhs + rhs.d_y, lhs + rhs.d_z};
  }

◆ operator+ [2/3]

Point operator+	(	Point	lhs,
		const double	rhs
	)

friend

Addition by scalar operator.

Parameters

lhs	lhs (to be modified)
rhs	rhs (to be added to lhs)

Returns: point lhs after adding rhs to it

Definition at line 235 of file point.h.

                                                      {
    return {lhs.d_x + rhs, lhs.d_y + rhs, lhs.d_z + rhs};
  }

◆ operator+ [3/3]

Point operator+	(	Point	lhs,
		const Point &	rhs
	)

friend

Addition operator.

Parameters

lhs	lhs (to be modified)
rhs	rhs (to be added to lhs)

Returns: point lhs after adding rhs to it

Definition at line 192 of file point.h.

                                                      {
    lhs += rhs;
    return lhs;
  }

◆ operator- [1/3]

Point operator-	(	const double	lhs,
		Point	rhs
	)

friend

Subtraction by scalar operator.

Parameters

lhs	lhs scalar
rhs	rhs (to be subtracted from lhs)

Returns: point After subtracting rhs from lhs

Definition at line 265 of file point.h.

                                                      {
    return {lhs - rhs.d_x, lhs - rhs.d_y, lhs - rhs.d_z};
  }

◆ operator- [2/3]

Point operator-	(	Point	lhs,
		const double	rhs
	)

friend

Subtraction by scalar operator.

Parameters

lhs	lhs (to be modified)
rhs	rhs (to be subtracted from lhs)

Returns: point lhs after subtracting rhs from it

Definition at line 255 of file point.h.

                                                      {
    return {lhs.d_x - rhs, lhs.d_y - rhs, lhs.d_z - rhs};
  }

◆ operator- [3/3]

Point operator-	(	Point	lhs,
		const Point &	rhs
	)

friend

Subtraction operator.

Parameters

lhs	lhs (to be modified)
rhs	rhs (to be subtracted from lhs)

Returns: point lhs after subtracting rhs from it

Definition at line 203 of file point.h.

                                                      {
    lhs -= rhs;
    return lhs;
  }

◆ operator/

Point operator/	(	Point	lhs,
		const double	rhs
	)

friend

Division by scalar operator.

Parameters

lhs	lhs scalar
rhs	rhs vector

Returns: point Vector after dividing lhs to rhs pointwise

Definition at line 286 of file point.h.

                                                      {
    lhs /= rhs;
    return lhs;
  }

Field Documentation

◆ d_x

double util::Point::d_x

the x coordinate

Definition at line 33 of file point.h.

◆ d_y

double util::Point::d_y

the y coordinate

Definition at line 36 of file point.h.

Referenced by rw::writer::VtkWriter::appendNodes(), cross(), util::derRotate2D(), dist(), dot(), fe::QuadElem::getDerShapes(), fe::QuadElem::getShapes(), fe::TetElem::getShapes(), fe::TriElem::getShapes(), util::geometry::Ellipse::isInside(), util::geometry::BoxPartition::isNear(), util::geometry::Ellipse::isNear(), util::geometry::Square::isNearBoundary(), util::geometry::Rectangle::isNearBoundary(), util::geometry::Cube::isNearBoundary(), util::geometry::Cuboid::isNearBoundary(), util::isPointInsideBox(), util::isPointInsideCuboid(), util::isPointInsideRectangle(), util::isPointInsideRectangle(), length(), lengthSq(), fe::TetElem::mapPointToRefElem(), fe::TriElem::mapPointToRefElem(), util::Matrix3::Matrix3(), util::Matrix3::Matrix3(), operator*=(), operator*=(), operator+=(), operator+=(), operator-=(), operator-=(), operator/=(), operator[](), operator[](), Point(), printStr(), project(), projectNormal(), util::geometry::Rectangle::Rectangle(), util::rotate2D(), util::rotateCW2D(), util::geometry::Square::Square(), util::SymMatrix3::SymMatrix3(), and util::triangleArea().

◆ d_z

double util::Point::d_z

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

/home/user/project/src/util/point.h

Public Member Functions

Data Fields

Group operators

Detailed Description

Constructor & Destructor Documentation

◆ Point() [1/5]

◆ Point() [2/5]

◆ Point() [3/5]

◆ Point() [4/5]

◆ Point() [5/5]

Member Function Documentation

◆ cross()

◆ dist()

◆ dot()

◆ length()

◆ lengthSq()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ print()

◆ printStr()

◆ project()

◆ projectNormal()

Friends And Related Symbol Documentation

◆ operator* [1/3]

◆ operator* [2/3]

◆ operator* [3/3]

◆ operator+ [1/3]

◆ operator+ [2/3]

◆ operator+ [3/3]

◆ operator- [1/3]

◆ operator- [2/3]

◆ operator- [3/3]

◆ operator/

Field Documentation

◆ d_x

◆ d_y

◆ d_z