LatticeBond Objects
A LatticeBond is a simple struct which represents an interaction bond in a lattice model. It does not have to be a nearest-neighbor bond only, and can represent interactions of various distances and types.
Functions such as squareLattice
and triangularLattice
return a std::vector of LatticeBond objects which can be
iterated over in a range-based for loop. For more information
about these functions see Functions for Making Lattices.
Synopsis
int Nx = 10;
int Ny = 10;
auto lattice = squareLattice(Nx,Ny);
// lattice is a std::vector<LatticeBond>
for(auto& bnd : lattice) // bnd is of type LatticeBond
{
printfln("Bond from site %d -> %d",bnd.s1,bnd.s2);
printfln(" Connecting points (%s,%s) -> (%s,%s)",bnd.x1,bnd.y1,bnd.x2,bnd.y2);
printfln(" This bond is of type \"%s\"",bnd.type);
}
LatticeBond Data Members
s1
(int) — site number of the first sites2
(int) — site number of the second sitex1
(Real) — x coordinate of the first sitey1
(Real) — y coordinate of the first sitex2
(Real) — x coordinate of the second sitey2
(Real) — y coordinate of the second sitetype
(string) — string labeling the type of the bond - see Functions for Making Lattices for more information of the LatticeBond types returned by each function
Back to Classes
Back to Main