IMP logo
IMP Reference Guide  2.11.1
The Integrative Modeling Platform
force_fields.h
Go to the documentation of this file.
1 /**
2  * \file IMP/atom/force_fields.h
3  * \brief Define functions to add bonds and radii to atoms.
4  *
5  * Copyright 2007-2019 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPATOM_FORCE_FIELDS_H
10 #define IMPATOM_FORCE_FIELDS_H
11 
12 #include <IMP/atom/atom_config.h>
13 #include "Hierarchy.h"
14 #include "ForceFieldParameters.h"
15 #include "CHARMMParameters.h"
16 
17 #include <string>
18 
19 IMPATOM_BEGIN_NAMESPACE
20 
21 /**
22  Add bonds using definitions from given force field parameters. Note
23  that, at the moment, all added bonds are reported as
24  IMP::Bond::SINGLE, whether or not they actually are.
25 
26  \see Hierarchy
27  \see ForceFieldParameters
28 */
29 IMPATOMEXPORT void add_bonds(Hierarchy d, const ForceFieldParameters* ffp =
31 
32 /**
33  Add vdW radius from given force field.
34 
35  \see Hierarchy
36  \see ForceFieldParameters
37 */
38 IMPATOMEXPORT void add_radii(Hierarchy d, const ForceFieldParameters* ffp =
40  FloatKey radius_key = FloatKey("radius"));
41 
42 IMPATOM_END_NAMESPACE
43 
44 #endif /* IMPATOM_FORCE_FIELDS_H */
Key< 0 > FloatKey
The type used to identify float attributes in the Particles.
Definition: base_types.h:32
access to CHARMM force field parameters
void add_radii(Hierarchy d, const ForceFieldParameters *ffp=get_all_atom_CHARMM_parameters(), FloatKey radius_key=FloatKey("radius"))
force field base class
Decorator for helping deal with a hierarchy of molecules.
CHARMMParameters * get_all_atom_CHARMM_parameters()
void add_bonds(Hierarchy d, const ForceFieldParameters *ffp=get_all_atom_CHARMM_parameters())