Interactions::TwoBody::Geometry Class Reference

Geometry of the interactions. More...

List of all members.

Public Types
typedef std::vector < Surface::Site * >	NeighborContainer
	Define container for pointers to the neighboring sites.
typedef std::string	Name
	Define type for the name.
Public Member Functions
	Geometry (const Name &name)
	Constructor.
double	InteractionEnergy () const
	Compute interaction energy on the associate site.
Accessors
Name	name () const
	Name accessor.
const NeighborContainer &	neighbor_container () const
	Accessor to the container of neighboring sites.
Modifiers
void	set_interaction_energy_container (const EnergyContainer &energy_container)
	Set interaction energy.
Friends
class	LinkSites

---

Detailed Description

• First, define the interaction energy on any site by providing an InteractionEnergyContainer
• Second, associate these interaction energies with the sites on the lattice using the functor LinkSites

Author:

Mathias Laurin <mathias_laurin@users.sourceforge.net>

Date:

2008-10-30

---

Constructor & Destructor Documentation

Interactions::TwoBody::Geometry::Geometry

(

const Name &

name

)

[inline]

Parameters:

[in]

name

of the interactions, e.g., "1st nearest neighbors"

---

Member Function Documentation

double Interactions::TwoBody::Geometry::InteractionEnergy

(

)

const

Returns:

interaction energy

---

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

• Geometry.hpp