Surface::HelicalBoundaryConditions Class Reference

Functor: helical boundary conditions.

List of all members.

Public Member Functions
	HelicalBoundaryConditions (Surface::Lattice::iterator first, Surface::Lattice::size_type size)
	Constructor.
Site *	operator() (const Site *site_ptr, Interactions::TwoBody::RelativeIndexContainer::value_type offset)
	Apply the boundary conditions.

---

Constructor & Destructor Documentation

Surface::HelicalBoundaryConditions::HelicalBoundaryConditions	(	Surface::Lattice::iterator	first,
		Surface::Lattice::size_type	size
	)			[inline]

Parameters:

[in]	first	iterator to the first element of the lattice
[in]	size	of the lattice

---

Member Function Documentation

Site* Surface::HelicalBoundaryConditions::operator()	(	const Site *	site_ptr,
		Interactions::TwoBody::RelativeIndexContainer::value_type	offset
	)

Parameters:

[in]	site_ptr	site from which to look for neighbors
[in]	offset	of the neirhbor

Returns:

a pointer to a site on the lattice at position offset from site_ptr

---

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

• Lattice.hpp