BALL::SolventDescriptor Class Reference
[Solvation methods]

Solvent Description. More...

#include <solventDescriptor.h>

List of all members.

Public Member Functions
Constructors and destructor
	SolventDescriptor ()
	Default constructor.
	SolventDescriptor (const SolventDescriptor &solvent)
	Copy constructor.
	SolventDescriptor (const String &name, float number_density, const std::vector< SolventAtomDescriptor > &atom_list)
	Detailed constructor.
virtual	~SolventDescriptor ()
	Destructor.
Assignment
const SolventDescriptor &	operator= (const SolventDescriptor &descriptor)
	Assignment operator.
void	clear ()
	Clear function.
Accessors
void	setName (const String &name)
	Set the name.
const String &	getName () const
	Get the name.
void	setNumberDensity (float number_density)
	Set the number density.
float	getNumberDensity () const
	Get the number density of this solvent (in $ A^{-3}$).
void	setSolventAtomDescriptorList (const std::vector< SolventAtomDescriptor > &solvent_atoms)
	Set the list of solvent atom descriptors.
const std::vector < SolventAtomDescriptor > &	getSolventAtomDescriptorList () const
	Get the list of atom descriptors.
std::vector < SolventAtomDescriptor > &	getSolventAtomDescriptorList ()
	Get the list of atom descriptors.
Size	getNumberOfAtomTypes () const
	Get the number of different atom types within a solvent molecule.
const SolventAtomDescriptor &	getAtomDescriptor (Position index) const throw (Exception::IndexOverflow)
	Get atom decriptions by index.
SolventAtomDescriptor &	getAtomDescriptor (Position index) throw (Exception::IndexOverflow)
	Get atom decriptions by index.
Predicates
bool	isValid () const
	Validity.
bool	operator== (const SolventDescriptor &descriptor) const
	Equality operator.
Protected Attributes
String	name_
float	number_density_
std::vector < SolventAtomDescriptor >	solvent_atoms_
bool	valid_

---

Detailed Description

Solvent Description.

The calculation of van-der-Waals energies requires information about the solvent which is stored in this structure.