BALL  1.4.79
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
BALL::AmberNonBonded Class Reference

#include <BALL/MOLMEC/AMBER/amberNonBonded.h>

Inheritance diagram for BALL::AmberNonBonded:
BALL::ForceFieldComponent BALL::ScoringComponent

Public Member Functions

void enableStoreInteractions (bool b=true)
 
void setAdvancedElectrostatic (AdvancedElectrostatic *advES)
 
Constructors and Destructors
 AmberNonBonded ()
 
 AmberNonBonded (ForceField &force_field)
 
 AmberNonBonded (const AmberNonBonded &amber_non_bonded)
 
virtual ~AmberNonBonded ()
 
const AmberNonBondedoperator= (const AmberNonBonded &anb)
 
virtual void clear ()
 
bool operator== (const AmberNonBonded &anb)
 
Setup Methods
virtual bool setup () throw (Exception::TooManyErrors)
 
bool setup (Options &options, ForceFieldParameters &par)
 
Accessors
virtual double updateEnergy ()
 
virtual void updateForces ()
 
virtual void update () throw (Exception::TooManyErrors)
 
void update (const std::vector< std::pair< Atom *, Atom * > > &atom_vector)
 
virtual double getElectrostaticEnergy () const
 
virtual double getVdwEnergy () const
 
Neighbourhood and Parameter calculations
virtual
MolmecSupport::PairListAlgorithmType 
determineMethodOfAtomPairGeneration ()
 
virtual void buildVectorOfNonBondedAtomPairs (const std::vector< std::pair< Atom *, Atom * > > &atom_vector, const LennardJones &lennard_jones, const Potential1210 &hydrogen_bond) throw (Exception::TooManyErrors)
 
- Public Member Functions inherited from BALL::ForceFieldComponent
 ForceFieldComponent ()
 
 ForceFieldComponent (ForceField &force_field)
 
 ForceFieldComponent (const ForceFieldComponent &force_field_component)
 
virtual ~ForceFieldComponent ()
 
ForceFieldgetForceField () const
 
void setForceField (ForceField &force_field)
 
void setName (const String &name)
 
String getName () const
 
bool isEnabled () const
 
void setEnabled (bool state)
 
virtual double getEnergy () const
 
double updateScore ()
 
- Public Member Functions inherited from BALL::ScoringComponent
 ScoringComponent ()
 
 ScoringComponent (const ScoringComponent &sc)
 
 ScoringComponent (ScoringFunction &sf)
 
void selectBaseFunction (String function)
 
virtual ~ScoringComponent ()
 
virtual void setupLigand ()
 
ScoringFunctiongetScoringFunction () const
 
void setScoringFunction (ScoringFunction &sf)
 
String getName () const
 
void setName (const String &name)
 
const StringgetTypeName ()
 
double getRawScore () const
 
double getScaledScore () const
 
virtual void setLigandIntraMolecular (bool b)
 
bool isLigandIntraMolecular ()
 
bool isGridable ()
 
bool isAtomPairwise ()
 
void setCoefficient (const double &coeff)
 
const doublegetCoefficient ()
 
void setNormalizationParameters (double stddev, double mean)
 
void getNormalizationParameters (double &stddev, double &mean)
 
bool isEnabled ()
 
void enable ()
 
void disable ()
 

Static Public Attributes

static const double ELECTROSTATIC_FACTOR
 

Protected Attributes

double electrostatic_energy_
 
double vdw_energy_
 
- Protected Attributes inherited from BALL::ForceFieldComponent
ForceFieldforce_field_
 
double energy_
 
- Protected Attributes inherited from BALL::ScoringComponent
bool ligand_intra_molecular_
 
bool gridable_
 
bool atom_pairwise_
 
ScoringFunctionscoring_function_
 
ScoringBaseFunctionbase_function_
 
double score_
 
double coefficient_
 
double stddev_
 
double mean_
 
bool enabled_
 
String type_name_
 

Additional Inherited Members

- Protected Member Functions inherited from BALL::ScoringComponent
double scaleScore (double score) const
 

Detailed Description

Amber NonBonded (VdW + Electrostatic) component

Definition at line 38 of file amberNonBonded.h.

Constructor & Destructor Documentation

BALL::AmberNonBonded::AmberNonBonded ( )

Default constructor.

BALL::AmberNonBonded::AmberNonBonded ( ForceField force_field)

Constructor.

BALL::AmberNonBonded::AmberNonBonded ( const AmberNonBonded amber_non_bonded)

Copy constructor

virtual BALL::AmberNonBonded::~AmberNonBonded ( )
virtual

Destructor.

Member Function Documentation

virtual void BALL::AmberNonBonded::buildVectorOfNonBondedAtomPairs ( const std::vector< std::pair< Atom *, Atom * > > &  atom_vector,
const LennardJones lennard_jones,
const Potential1210 hydrogen_bond 
)
throw (Exception::TooManyErrors
)
virtual

Build a vector of non-bonded atom pairs with the vdw parameters

virtual void BALL::AmberNonBonded::clear ( )
virtual

Clear method

Reimplemented from BALL::ScoringComponent.

virtual MolmecSupport::PairListAlgorithmType BALL::AmberNonBonded::determineMethodOfAtomPairGeneration ( )
virtual

Computes the most efficient way to calculate the non-bonded atom pairs

void BALL::AmberNonBonded::enableStoreInteractions ( bool  b = true)
virtual double BALL::AmberNonBonded::getElectrostaticEnergy ( ) const
virtual

Return the electrostatic energy.

virtual double BALL::AmberNonBonded::getVdwEnergy ( ) const
virtual

Return the Van-der-Waals energy.

const AmberNonBonded& BALL::AmberNonBonded::operator= ( const AmberNonBonded anb)

AssignmentAssignment operator

bool BALL::AmberNonBonded::operator== ( const AmberNonBonded anb)

PredicatesEquality operator

void BALL::AmberNonBonded::setAdvancedElectrostatic ( AdvancedElectrostatic advES)
virtual bool BALL::AmberNonBonded::setup ( )
throw (Exception::TooManyErrors
)
virtual

Setup method.

Reimplemented from BALL::ForceFieldComponent.

bool BALL::AmberNonBonded::setup ( Options options,
ForceFieldParameters par 
)

Setup this component according to the given options and store the ForceFieldParameters in par

virtual void BALL::AmberNonBonded::update ( )
throw (Exception::TooManyErrors
)
virtual

Update the pair list. This method is called by the force field whenever ForceField::update is called. It is used to recalculate the nonbonded pair list.

Reimplemented from BALL::ForceFieldComponent.

void BALL::AmberNonBonded::update ( const std::vector< std::pair< Atom *, Atom * > > &  atom_vector)
virtual

Update this component using the given atom-pairs only

Reimplemented from BALL::ScoringComponent.

virtual double BALL::AmberNonBonded::updateEnergy ( )
virtual

Calculates and returns the component's energy.

Reimplemented from BALL::ForceFieldComponent.

virtual void BALL::AmberNonBonded::updateForces ( )
virtual

Calculates and returns the component's forces.

Reimplemented from BALL::ForceFieldComponent.

Member Data Documentation

double BALL::AmberNonBonded::electrostatic_energy_
protected

Definition at line 186 of file amberNonBonded.h.

const double BALL::AmberNonBonded::ELECTROSTATIC_FACTOR
static

Definition at line 47 of file amberNonBonded.h.

double BALL::AmberNonBonded::vdw_energy_
protected

Definition at line 190 of file amberNonBonded.h.