Surface::OrderParameter Class Reference

Functor: Compute order parameters on the Lattice. More...

List of all members.

Classes
class	Impl
	Implementation: Treat parameters for one species at one site.
Public Member Functions
	OrderParameter (Lattice::size_type lattice_width, int multiplicity)
	Constructor.
void	operator() (const Site *site)
	Callback on each site of the lattice.
Return order parameter per species per site
Parameters: [in]  species  [in]  site_name  Returns: order parameter
double	p2x2 (const Species &species, const Site::Name &site_name) const
	Order parameter for a superstructure.
double	p2x1 (const Species &species, const Site::Name &site_name) const
	Order parameter for a superstructure.
double	sqrt3xsqrt3 (const Species &species, const Site::Name &site_name) const
	Order parameter for a superstructure.
Information collected over the whole lattice
double	TotalEnergy () const
	Sum of the interaction energies computed on the lattice.
Lattice::size_type	Population (const Species &species) const
	Number of species on the Lattice.

---

Detailed Description

This functor is called on each Site of an hexagonal Lattice to compute order parameters

References:

• Glosi et al., Can J Phys/Rev can phys 61(11): 1515-1527 (1983)
• Piercy et al., Phys Rev B 45(4): 1869 (1992)

Usage:

 OrderParameter op(Lattice::lattice.width(), Lattice::multiplicity());
 std::for_each(Lattice::lattice.begin(), Lattice::lattice.end(), op);

Author:

Mathias Laurin <mathias_laurin@users.sourceforge.net>

Date:

2008-10-30

---

Constructor & Destructor Documentation

Surface::OrderParameter::OrderParameter	(	Lattice::size_type	lattice_width,
		int	multiplicity
	)			[inline]

Parameters:

[in]	lattice_width	of the lattice (number of columns)
[in]	multiplicity	of the lattice

---

Member Function Documentation

void Surface::OrderParameter::operator()

(

const Site *

site

)

Parameters:

[in]

site

Lattice::size_type Surface::OrderParameter::Population

(

const Species &

species

)

const

Parameters:

[in]

species

Returns:

population

double Surface::OrderParameter::TotalEnergy

(

)

const

Returns:

energy

---

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

• OrderParameter.hpp