Surface Namespace Reference

Everything concerning the surface.

Classes
class	Bridge
	Bridge sites. More...
class	Lattice
	The lattice. More...
class	HelicalBoundaryConditions
	Functor: helical boundary conditions. More...
class	OrderParameter
	Functor: Compute order parameters on the Lattice. More...
class	Site
	Site on the lattice. More...
class	Species
	Species/adsorbates. More...
Temperature of the lattice
unsigned	temperature_
unsigned	temperature ()
	Accessor.
void	set_temperature (unsigned temperature)
	Modifier.
Define names for the sites on the lattice
std::vector< Site::Name >	name_set_
Site::Name	fcc
Site::Name	hcp
Site::Name	bridge
Site::Name	any
std::vector< Site::Name >	name_set ()
	Accessor.
std::vector< Site::Name > ::size_type	multiplicity ()
	Return multiplicity of the lattice.
Functions
bool	operator== (const Surface::Species &lhs, const Surface::Species &rhs)
	Equality operator.
bool	operator!= (const Surface::Species &lhs, const Surface::Species &rhs)
	Non-equality operator.
bool	operator< (const Surface::Species &lhs, const Surface::Species &rhs)
	Less-than operator.
Actions over a lattice or sublattice, use with std::for_each
void	Populate (Lattice::iterator first, Lattice::iterator last, double coverage, const Species &species)
	Populate the lattice.
void	Clean (Lattice::iterator first, Lattice::iterator last)
	Remove all species on the lattice.
void	SetBridge (Lattice::iterator first, Lattice::iterator last, const Bridge &bridge)
	Set bridge sites on the lattice.

---

Function Documentation

void Surface::Clean	(	Lattice::iterator	first,
		Lattice::iterator	last
	)

Parameters:

[in]	first	lattice iterator
[in]	last	lattice iterator

void Surface::Populate	(	Lattice::iterator	first,
		Lattice::iterator	last,
		double	coverage,
		const Species &	species
	)

Parameters:

[in]	first	lattice iterator
[in]	last	lattice iterator
[in]	coverage	up to which lattice should be populated
[in]	species	with which to populate the lattice

void Surface::SetBridge	(	Lattice::iterator	first,
		Lattice::iterator	last,
		const Bridge &	bridge
	)

Parameters:

[in]	first	lattice iterator
[in]	last	lattice iterator
[in]	bridge	type of bridge to consider