BALL::MMFF94 Class Reference
[MMFF94 Force Field.]

#include <BALL/MOLMEC/MMFF94/MMFF94.h>

Inheritance diagram for BALL::MMFF94:
BALL::ForceField

List of all members.


Classes

struct  Default
struct  Option

Public Member Functions

Constructors and Destructor
 MMFF94 ()
 MMFF94 (System &system)
 MMFF94 (System &system, const Options &options)
 MMFF94 (const MMFF94 &force_field)
virtual ~MMFF94 ()
Assignment
const MMFF94operator= (const MMFF94 &force_field)
virtual void clear ()
Setup Methods
virtual bool specificSetup () throw (Exception::TooManyErrors)
Accessors specific to the MMFF94 force field
double getStretchEnergy () const
double getBendEnergy () const
double getStretchBendEnergy () const
double getTorsionEnergy () const
double getNonbondedEnergy () const
double getESEnergy () const
double getVdWEnergy () const
double getPlaneEnergy () const
bool hasInitializedParameters () const
Size getUpdateFrequency () const
virtual String getResults () const
 

Get the current results in String form.


const vector< Bond * > getBonds () const
const vector< HashSet< Atom * > > & getRings () const
const vector< HashSet< Atom * > > & getAromaticRings () const
bool isInOneAromaticRing (const Bond &bond) const
bool assignMMFF94BondType (Bond &bond) const
const vector< MMFF94AtomType > & getAtomTypes () const
const MMFF94StretchParametersgetStretchParameters () const
const MMFF94AtomTypeEquivalencesgetEquivalences () const
bool areInOneRing (vector< Atom * > v, Size ring_size=0) const
bool areInOneAromaticRing (const vector< Atom * > &v, Size ring_size=0) const
bool checkAtomType (Atom &atom)

Protected Member Functions

void insertComponents_ ()
void transformAromaticBonds_ ()
void collectBonds_ ()
void assignBondTypes_ ()
void collectRings_ ()

Protected Attributes

String folder_
MMFF94AtomTypes atom_types_
MMFF94StretchParameters bond_parameters_
MMFF94AtomTypeEquivalences equivalences_
MMFF94ESParameters es_parameters_
vector< HashSet< Atom * > > rings_
vector< HashSet< Atom * > > aromatic_rings_
bool parameters_initialized_
vector< Bond * > bonds_
MMFF94AtomTyper atom_typer_
MMFF94ChargeProcessor charge_processor_
Kekuliser kekuliser_
HashSet< Bond * > aromatic_bonds_

Detailed Description

MMFF94 force field class.


Constructor & Destructor Documentation

BALL::MMFF94::MMFF94 (  ) 

Default constructor.

BALL::MMFF94::MMFF94 ( System system  ) 

Constructor.

BALL::MMFF94::MMFF94 ( System system,
const Options options 
)

Constructor.

BALL::MMFF94::MMFF94 ( const MMFF94 force_field  ) 

Copy constructor

virtual BALL::MMFF94::~MMFF94 (  )  [virtual]

Destructor.


Member Function Documentation

bool BALL::MMFF94::areInOneAromaticRing ( const vector< Atom * > &  v,
Size  ring_size = 0 
) const
bool BALL::MMFF94::areInOneRing ( vector< Atom * >  v,
Size  ring_size = 0 
) const
void BALL::MMFF94::assignBondTypes_ (  )  [protected]
bool BALL::MMFF94::assignMMFF94BondType ( Bond bond  )  const
bool BALL::MMFF94::checkAtomType ( Atom atom  ) 

Check wheter the atoms type is valid. If not, add it to unassigned atoms.

virtual void BALL::MMFF94::clear (  )  [virtual]

Clear method

Reimplemented from BALL::ForceField.

void BALL::MMFF94::collectBonds_ (  )  [protected]
void BALL::MMFF94::collectRings_ (  )  [protected]
const vector<HashSet<Atom*> >& BALL::MMFF94::getAromaticRings (  )  const [inline]
const vector<MMFF94AtomType>& BALL::MMFF94::getAtomTypes (  )  const [inline]
double BALL::MMFF94::getBendEnergy (  )  const

Return the angle bend contribution to the total energy

const vector<Bond*> BALL::MMFF94::getBonds (  )  const [inline]
const MMFF94AtomTypeEquivalences& BALL::MMFF94::getEquivalences (  )  const [inline]
double BALL::MMFF94::getESEnergy (  )  const

Return the electrostatic contribution to the total energy.

double BALL::MMFF94::getNonbondedEnergy (  )  const

Return the nonbonded contribution to the total energy. This energy comprises Van der Waals energy, hydrogen bond energy, and elesctrostatic energy.

double BALL::MMFF94::getPlaneEnergy (  )  const
virtual String BALL::MMFF94::getResults (  )  const [virtual]

Get the current results in String form.

Reimplemented from BALL::ForceField.

const vector<HashSet<Atom*> >& BALL::MMFF94::getRings (  )  const [inline]
double BALL::MMFF94::getStretchBendEnergy (  )  const
double BALL::MMFF94::getStretchEnergy (  )  const

Return the bond stretch contribution to the total energy

const MMFF94StretchParameters& BALL::MMFF94::getStretchParameters (  )  const [inline]
double BALL::MMFF94::getTorsionEnergy (  )  const

Return the torsion contribution to the total energy. This energy comprises proper and improper torsions.

Size BALL::MMFF94::getUpdateFrequency (  )  const [virtual]

Return the recommended number of iterations between updates. This method return 20 as a default value.

Reimplemented from BALL::ForceField.

double BALL::MMFF94::getVdWEnergy (  )  const

Return the Van der Waals and hydrogen bond contribution to the total energy.

bool BALL::MMFF94::hasInitializedParameters (  )  const

Return true, if the parameters have already been initialized

void BALL::MMFF94::insertComponents_ (  )  [protected]
bool BALL::MMFF94::isInOneAromaticRing ( const Bond bond  )  const
const MMFF94& BALL::MMFF94::operator= ( const MMFF94 force_field  ) 

Assignment operator

virtual bool BALL::MMFF94::specificSetup (  )  throw (Exception::TooManyErrors) [virtual]

Force field specific setup

Reimplemented from BALL::ForceField.

void BALL::MMFF94::transformAromaticBonds_ (  )  [protected]

Member Data Documentation

vector<HashSet<Atom*> > BALL::MMFF94::aromatic_rings_ [protected]
vector<Bond*> BALL::MMFF94::bonds_ [protected]
vector<HashSet<Atom*> > BALL::MMFF94::rings_ [protected]