A decorator for a particle with x,y,z coordinates.
More...
#include <IMP/core/XYZ.h>
A decorator for a particle with x,y,z coordinates.
Using the decorator one can get and set coordinates and modify derivatives.
13 p0 = m.add_particle(
"xyz0")
16 p1 = m.add_particle(
"xyz1")
- See Also
- XYZR
- Examples:
- core/simple.cpp.
Definition at line 30 of file XYZ.h.
Add something to the derivative of the ith coordinate.
Definition at line 75 of file XYZ.h.
Add something to the derivative of the coordinates.
Definition at line 79 of file XYZ.h.
Float IMP::core::XYZ::get_coordinate |
( |
int |
i | ) |
const |
Get the ith coordinate.
Definition at line 69 of file XYZ.h.
Convert it to a vector.
Somewhat suspect based on wanting a Point/Vector differentiation but we don't have points
Definition at line 106 of file XYZ.h.
bool IMP::core::XYZ::get_coordinates_are_optimized |
( |
| ) |
const |
Get whether the coordinates are optimized.
- Returns
- true only if all of them are optimized.
Definition at line 86 of file XYZ.h.
Float IMP::core::XYZ::get_derivative |
( |
int |
i | ) |
const |
Get the ith coordinate derivative.
Definition at line 73 of file XYZ.h.
Get the vector of derivatives.
Somewhat suspect based on wanting a Point/Vector differentiation but we don't have points
Definition at line 113 of file XYZ.h.
Get the vector from this particle to another.
Definition at line 99 of file XYZ.h.
static const FloatKeys& IMP::core::XYZ::get_xyz_keys |
( |
| ) |
|
|
static |
Get a vector containing the keys for x,y,z.
This is quite handy for initializing movers and things.
void IMP::core::XYZ::set_coordinate |
( |
unsigned int |
i, |
|
|
Float |
v |
|
) |
| |
set the ith coordinate
Definition at line 58 of file XYZ.h.
void IMP::core::XYZ::set_coordinates_are_optimized |
( |
bool |
tf | ) |
const |
Set whether the coordinates are optimized.
Definition at line 92 of file XYZ.h.
Setup the particle so that it can be used with this decorator
Definition at line 52 of file XYZ.h.
- See Also
- setup_particle(m, pi, v )
Definition at line 52 of file XYZ.h.
The documentation for this class was generated from the following file: