IMP logo
IMP Reference Guide  2.12.0
The Integrative Modeling Platform
RemoveRigidMotionOptimizerState.h
Go to the documentation of this file.
1 /**
2  * \file IMP/atom/RemoveRigidMotionOptimizerState.h
3  * \brief Remove rigid rotation and translation during molecular dynamics.
4  *
5  * Copyright 2007-2019 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPATOM_REMOVE_RIGID_MOTION_OPTIMIZER_STATE_H
10 #define IMPATOM_REMOVE_RIGID_MOTION_OPTIMIZER_STATE_H
11 
12 #include <IMP/atom/atom_config.h>
13 #include <IMP/Particle.h>
14 #include <IMP/base_types.h>
15 #include <IMP/OptimizerState.h>
16 
17 IMPATOM_BEGIN_NAMESPACE
18 
19 //! Removes rigid translation and rotation from the particles.
20 class IMPATOMEXPORT RemoveRigidMotionOptimizerState : public OptimizerState {
21  public:
24 
25  //! Set the particles to use.
26  void set_particles(const Particles &pis) { pis_ = pis; }
27 
28  //! Remove rigid motion now
29  void remove_rigid_motion() const;
30 
32 
33  protected:
34  virtual void do_update(unsigned int call) IMP_OVERRIDE;
35 
36  private:
37  void remove_linear() const;
38  void remove_angular() const;
39  Particles pis_;
40 };
41 
43 
44 IMPATOM_END_NAMESPACE
45 
46 #endif /* IMPATOM_REMOVE_RIGID_MOTION_OPTIMIZER_STATE_H */
Basic types used by IMP.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
virtual void do_update(unsigned int)
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
Removes rigid translation and rotation from the particles.
void set_particles(const Particles &pis)
Set the particles to use.
Classes to handle individual model particles. (Note that implementation of inline functions is in int...
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing lists of object pointers.
Definition: object_macros.h:44
Shared optimizer state that is invoked upon commitment of new coordinates.
Shared optimizer state.
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.