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

#include <BALL/MOLMEC/PARAMETER/quadraticBondStretch.h>

Inheritance diagram for BALL::QuadraticBondStretch:
BALL::ParameterSection

Classes

struct  Data
struct  Values

Public Types

enum  { UNKNOWN }
- Public Types inherited from BALL::ParameterSection
enum  { MAX_FIELDS = 20 }

Public Member Functions

 QuadraticBondStretch ()
virtual ~QuadraticBondStretch ()
virtual void clear ()
virtual bool extractSection (ForceFieldParameters &parameters, const String &section_name)
virtual bool extractSection (Parameters &parameters, const String &section_name)
bool hasParameters (Atom::Type I, Atom::Type J) const
QuadraticBondStretch::Values getParameters (Atom::Type I, Atom::Type J) const
bool assignParameters (QuadraticBondStretch::Values &parameters, Atom::Type I, Atom::Type J) const
- Public Member Functions inherited from BALL::ParameterSection
 ParameterSection ()
 ParameterSection (const ParameterSection &parameter_section)
virtual ~ParameterSection ()
const StringgetSectionName () const
const StringgetValue (const String &key, const String &variable) const
bool has (const String &key, const String &variable) const
bool has (const String &key) const
bool hasVariable (const String &variable) const
Position getColumnIndex (const String &variable) const
Size getNumberOfVariables () const
Size getNumberOfKeys () const
const StringgetValue (Position key_index, Position variable_index) const
const StringgetKey (Position key_index) const
const ParameterSectionoperator= (const ParameterSection &section)
virtual bool isValid () const
bool operator== (const ParameterSection &parameter_section) const

Protected Attributes

Size number_of_atom_types_
floatk_
floatr0_
boolis_defined_
Stringnames_
- Protected Attributes inherited from BALL::ParameterSection
String section_name_
String format_line_
StringHashMap< Indexsection_entries_
StringHashMap< Indexvariable_names_
std::vector< Stringentries_
std::vector< Stringkeys_
Size number_of_variables_
std::vector< floatversion_
bool valid_

Additional Inherited Members

- Public Attributes inherited from BALL::ParameterSection
Options options
- Static Public Attributes inherited from BALL::ParameterSection
static const String UNDEFINED

Detailed Description

QuadraticBondStretch.

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

Definition at line 25 of file quadraticBondStretch.h.

Member Enumeration Documentation

anonymous enum
Enumerator:
UNKNOWN 

Definition at line 30 of file quadraticBondStretch.h.

Constructor & Destructor Documentation

BALL::QuadraticBondStretch::QuadraticBondStretch ( )

Default constructor.

virtual BALL::QuadraticBondStretch::~QuadraticBondStretch ( )
virtual

Destructor.

Member Function Documentation

bool BALL::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 void BALL::QuadraticBondStretch::clear ( )
virtual

Clear method

Reimplemented from BALL::ParameterSection.

virtual bool BALL::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.

virtual bool BALL::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
parametersthe parameters defining the inifile to be read from
section_namethe name of the section to be read (without the squared brackets)
Returns
bool - true if the section could be read, false otherwise

Reimplemented from BALL::ParameterSection.

QuadraticBondStretch::Values BALL::QuadraticBondStretch::getParameters ( Atom::Type  I,
Atom::Type  J 
) const

Returns the parameters for a given atom type combination.

bool BALL::QuadraticBondStretch::hasParameters ( Atom::Type  I,
Atom::Type  J 
) const

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

Member Data Documentation

bool* BALL::QuadraticBondStretch::is_defined_
protected

Definition at line 96 of file quadraticBondStretch.h.

float* BALL::QuadraticBondStretch::k_
protected

Definition at line 92 of file quadraticBondStretch.h.

String* BALL::QuadraticBondStretch::names_
protected

Definition at line 98 of file quadraticBondStretch.h.

Size BALL::QuadraticBondStretch::number_of_atom_types_
protected

Definition at line 90 of file quadraticBondStretch.h.

float* BALL::QuadraticBondStretch::r0_
protected

Definition at line 94 of file quadraticBondStretch.h.