Point Class Reference

Class used to pass a single wavevector.

#include <points.h>

Public Member Functions
	Point (Points &points_, const int &index_, const Eigen::Vector3d &umklappVector=Eigen::Vector3d::Zero())
	Constructor. More...
	Point (const Point &that)
	copy constructor
Point &	operator= (const Point &that)
	copy assignment operator
Eigen::Vector3d	getCoordinates (const int &basis=crystalCoordinates_, const bool &inWignerSeitz=false) const
	Get the coordinates of the k-point. More...
Point	operator+ (Point &b)
	Sum of two wavevectors (this + b) The vector is folded in the Wigner Seitz zone with an Umklapp vector.
Point	operator- (Point &b)
	Difference of two wavevectors (this-b). More...
bool	hasUmklapp ()
	checks whether the Point has been constructed with an Umklapp vector
int	getIndex () const
	Get the index of the wavevector in the referenced Points object.

Constructor & Destructor Documentation

Point()

Point::Point	(	Points &	points_,
		const int &	index_,
		const Eigen::Vector3d &	umklappVector = Eigen::Vector3d::Zero()
	)

Parameters

index	integer index of the wavevector in the Points object.
umklappVector	the crystal coordinates of a possible umklapp vector, used for example in sum or differences between wavevectors.
points	the points object that this Point object belongs to.

Member Function Documentation

getCoordinates()

Eigen::Vector3d Point::getCoordinates	(	const int &	basis = crystalCoordinates_,
		const bool &	inWignerSeitz = false
	)		const

Parameters

basis	either "cartesian" or "crystal"
inWignerSeitz	default false, if true, folds point in WS cell.

Returns

coordinates: a 3d vector of coordinates

Here is the call graph for this function:

Here is the caller graph for this function:

operator-()

Point Point::operator-

(

Point &

b

)

The vector is folded in the Wigner Seitz zone with an Umklapp vector.

Here is the call graph for this function: