Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

QuadraticBondStretch Class Reference
[Force Field Parameters]

QuadraticBondStretch. More...

#include <quadraticBondStretch.h>

Inheritance diagram for QuadraticBondStretch:

ParameterSection List of all members.

Public Types

enum  { UNKNOWN }

Public Member Functions

 QuadraticBondStretch ()
 Default constructor.
virtual ~QuadraticBondStretch () throw ()
 Destructor.
virtual void clear () throw ()
 Clear method.
virtual bool extractSection (ForceFieldParameters &parameters, const String &section_name)
 Reads a parameter section from an INI file.
virtual bool extractSection (Parameters &parameters, const String &section_name)
 Reads a parameter section from an INI file.
bool hasParameters (Atom::Type I, Atom::Type J) const
 Queries whether a parameter set is defined for the given atom types.
QuadraticBondStretch::Values getParameters (Atom::Type I, Atom::Type J) const
 Returns the parameters for a given atom type combination.
bool assignParameters (QuadraticBondStretch::Values &parameters, Atom::Type I, Atom::Type J) const
 Assign the parameters for a given atom type combination.

Protected Attributes

Size number_of_atom_types_
float * k_
float * r0_
bool * is_defined_
Stringnames_

Detailed Description

QuadraticBondStretch.

Molecular Mechanics Parameter: class describing the parameters required for a harmonic stretch potential.


Constructor & Destructor Documentation

QuadraticBondStretch::QuadraticBondStretch  ) 
 

Default constructor.

virtual QuadraticBondStretch::~QuadraticBondStretch  )  throw () [virtual]
 

Destructor.


Member Function Documentation

bool QuadraticBondStretch::assignParameters QuadraticBondStretch::Values &  parameters,
Atom::Type  I,
Atom::Type  J
const
 

Assign the parameters for a given atom type combination.

If no parameters are defined for this combination, false is returned and nothing is changed.

virtual bool QuadraticBondStretch::extractSection Parameters parameters,
const String section_name
[virtual]
 

Reads a parameter section from an INI file.

This method reads the section given in section_name from ini_file, interprets (if given) a format line, reads the data from this section according to the format, and builds some datastructures for fast and easy acces to the data.

Parameters:
parameters the parameters defining the inifile to be read from
section_name the name of the section to be read (without the squared brackets)
Returns:
bool - true if the section could be read, false otherwise

Reimplemented from ParameterSection.

virtual bool QuadraticBondStretch::extractSection ForceFieldParameters parameters,
const String section_name
[virtual]
 

Reads a parameter section from an INI file.

This method reads the section given in section_name from ini_file, interprets (if given) a format line, reads the data from this section according to the format, and builds some datastructures for fast and easy acces this data.

QuadraticBondStretch::Values QuadraticBondStretch::getParameters Atom::Type  I,
Atom::Type  J
const
 

Returns the parameters for a given atom type combination.

bool QuadraticBondStretch::hasParameters Atom::Type  I,
Atom::Type  J
const
 

Queries whether a parameter set is defined for the given atom types.