Representation of a Lattice site. More...

Public Member Functions
	LatticeSite ()
	Construct an uninitialized lattice site object.

	LatticeSite (const int a0, const int a1, const int a2, const int b)
	Construct a well-defined lattice site. More...

bool	operator== (const LatticeSite &rhs) const
	Comparison operator. More...

bool	operator!= (const LatticeSite &rhs) const
	Negative comparison operator. More...

Public Attributes
int	a0
	Coordinate in units of the first Bravais lattice vector.

int	a1
	Coordinate in units of the second Bravais lattice vector.

int	a2
	Coordinate in units of the third Bravais lattice vector.

int	b
	Basis site index.

Detailed Description

Representation of a Lattice site.

Constructor & Destructor Documentation

LatticeModelFactory::LatticeSite::LatticeSite	(	const int	a0,
		const int	a1,
		const int	a2,
		const int	b
	)

Construct a well-defined lattice site.

Parameters

a0	Coordinate in units of the first Bravais lattice vector.
a1	Coordinate in units of the second Bravais lattice vector.
a2	Coordinate in units of the third Bravais lattice vector.
b	Basis site index.

bool LatticeModelFactory::LatticeSite::operator!= ( const LatticeSite & rhs ) const

Negative comparison operator.

Parameters

rhs	Right hand side operand.

Returns: bool Returns false if both objects desribe the same lattice site. Returns true otherwise.

bool LatticeModelFactory::LatticeSite::operator== ( const LatticeSite & rhs ) const

Comparison operator.

Parameters

rhs	Right hand side operand.

Returns: bool Returns true if both objects desribe the same lattice site. Returns false otherwise.

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