glotzmd::DzugutovPotential Class Reference

implements the Dzugutov pair potential More...

#include <DzugutovPotential.h>

Inheritance diagram for glotzmd::DzugutovPotential:

glotzmd::Potential glotzmd::BaseObject glotzutil::Listable glotzutil::Serializable

List of all members.

Public Member Functions

 DzugutovPotential ()
 ~DzugutovPotential ()
DzugutovPotentialClone ()
 Clone constructor.
void ComputeForce (InteractingObject *const, InteractingObject *const, const glotz_vec &, const glotz_flt)
void ComputeShiftedForce (InteractingObject *const, InteractingObject *const, const glotz_vec &, const glotz_flt, const glotz_flt)
glotz_flt GetCutoff () const
 Gets the interaction cutoff.
glotz_flt GetOverlapCutoff () const
 Gets the overlap cutoff.

Private Attributes

const glotz_flt mCutoff
const glotz_flt mCutoffSq


Detailed Description

implements the Dzugutov pair potential

Author:
Aaron Keys
Note:
the Dzugutov potential involves expensive exp() calculations; therefore, it is more efficient to implement it as a table lookup.

Constructor & Destructor Documentation

glotzmd::DzugutovPotential::DzugutovPotential (  ) 

glotzmd::DzugutovPotential::~DzugutovPotential (  ) 


Member Function Documentation

DzugutovPotential * glotzmd::DzugutovPotential::Clone (  )  [virtual]

Clone constructor.

Reimplemented from glotzmd::Potential.

void glotzmd::DzugutovPotential::ComputeForce ( InteractingObject * const  obj1,
InteractingObject * const  obj2,
const glotz_vec rij,
const   glotz_flt 
) [inline, virtual]

Implements glotzmd::Potential.

void glotzmd::DzugutovPotential::ComputeShiftedForce ( InteractingObject * const  obj1,
InteractingObject * const  obj2,
const glotz_vec rij,
const   glotz_flt,
const   glotz_flt 
) [inline, virtual]

Implements glotzmd::Potential.

glotz_flt glotzmd::DzugutovPotential::GetCutoff (  )  const [virtual]

Gets the interaction cutoff.

Returns:
the potential cutoff
Note:
if no cutoff is defined by the inherited potential default the cutoff is 1e6

Reimplemented from glotzmd::Potential.

glotz_flt glotzmd::DzugutovPotential::GetOverlapCutoff (  )  const [virtual]

Gets the overlap cutoff.

This function is used in interpolation

Returns:
the overlap cutoff
Note:
if no overlap cutoff is defined, will return 0.0.

Reimplemented from glotzmd::Potential.


Member Data Documentation

const glotz_flt glotzmd::DzugutovPotential::mCutoff [private]

const glotz_flt glotzmd::DzugutovPotential::mCutoffSq [private]


The documentation for this class was generated from the following files:
Generated on Tue Feb 24 20:54:20 2009 by  doxygen 1.5.3