Surface::Bridge Class Reference

Bridge sites. More...

List of all members.

Public Types
typedef std::string	Name
	Define name.
Public Member Functions
	Bridge (const Name &name, const Interactions::TwoBody::Geometry &two_body1, const Interactions::TwoBody::Geometry &two_body2)
	Constructor.
Name	name () const
	Accessor to name.
double	InteractionEnergy (const Surface::Site *const site_ptr1, const Surface::Site *const site_ptr2) const
	Compute interaction energy at this bridge site, defined by the common neighbors of the two sites provided as arguments.
Public Attributes
Interactions::TwoBody::EnergyContainer	interaction_energy_container
	Container of interaction energy.

---

Detailed Description

Bridge sites are defined as the common neighbors of two sites, which neighbors to consider is defined by the Interactions::TwoBody::Geometry arguments passed

Author:

Mathias Laurin <mathias_laurin@users.sourceforge.net>

Date:

2008-10-30

---

Constructor & Destructor Documentation

Surface::Bridge::Bridge	(	const Name &	name,
		const Interactions::TwoBody::Geometry &	two_body1,
		const Interactions::TwoBody::Geometry &	two_body2
	)			[inline]

Parameters:

[in]	name	the brige site, e.g., "1st nearest bridge"
[in]	two_body1
[in]	two_body2

---

Member Function Documentation

double Surface::Bridge::InteractionEnergy	(	const Surface::Site *const	site_ptr1,
		const Surface::Site *const	site_ptr2
	)			const

Parameters:

[in]	site_ptr1
[in]	site_ptr2

---

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

• Bridge.hpp