IMP logo
IMP Reference Guide  develop.ba5ef9f91e,2024/02/26
The Integrative Modeling Platform
IMP::spb::PbcBoxedRigidBodyMover Class Reference

Modify the transformation of a rigid body. More...

#include <IMP/spb/PbcBoxedRigidBodyMover.h>

+ Inheritance diagram for IMP::spb::PbcBoxedRigidBodyMover:

Detailed Description

Modify the transformation of a rigid body.

The transformation of a rigid body is moved in a ball of given size. The probability distribution is uniform over the ball.

See Also

Definition at line 25 of file PbcBoxedRigidBodyMover.h.

Public Member Functions

 PbcBoxedRigidBodyMover (core::RigidBody d, Particles ps, Float max_translation, Float max_rotation, algebra::Vector3Ds centers, algebra::Transformation3Ds transformations, Particle *px, Particle *py, Particle *pz)
virtual std::string get_type_name () const override
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
void show (std::ostream &out=std::cout) const
- Public Member Functions inherited from IMP::core::MonteCarloMover
 MonteCarloMover (Model *m, std::string name)
void accept ()
 Accept/commit any changes made to the Particles. More...
MonteCarloMoverResult propose ()
 Propose a modification. More...
void reject ()
 Roll back any changes made to the Particles. More...
unsigned int get_number_of_proposed () const
unsigned int get_number_of_accepted () const
void reset_statistics ()
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
bool get_has_required_score_states () const
 Return whether score states are computed. More...
ModelObjectsTemp get_inputs () const
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
Modelget_model () const
ModelObjectsTemp get_outputs () const
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
CheckLevel get_check_level () const
LogLevel get_log_level () const
void set_check_level (CheckLevel l)
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
void set_was_used (bool tf) const
void show (std::ostream &out=std::cout) const
const std::string & get_name () const
void set_name (std::string name)

Protected Member Functions

virtual IMP::ModelObjectsTemp do_get_inputs () const override
virtual core::MonteCarloMoverResult do_propose () override
 Implement propose_move() More...
virtual void do_reject () override
 Implement reset_proposed_move() More...
- Protected Member Functions inherited from IMP::core::MonteCarloMover
virtual void do_accept ()
 Implement accept_proposed_move(); default implementation is empty. More...
virtual ModelObjectsTemp do_get_outputs () const override
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
virtual void handle_set_has_required_score_states (bool)
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
virtual void do_destroy ()

Constructor & Destructor Documentation

IMP::spb::PbcBoxedRigidBodyMover::PbcBoxedRigidBodyMover ( core::RigidBody  d,
Particles  ps,
Float  max_translation,
Float  max_rotation,
algebra::Vector3Ds  centers,
algebra::Transformation3Ds  transformations,
Particle px,
Particle py,
Particle pz 

The rigid body is rotated and translated to move

[in]dthe rigid body decorator
[in]max_translationmaximum translation during a step
[in]max_rotationmaximum rotation angle in radians

Member Function Documentation

virtual IMP::ModelObjectsTemp IMP::spb::PbcBoxedRigidBodyMover::do_get_inputs ( ) const

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::ModelObject.

virtual core::MonteCarloMoverResult IMP::spb::PbcBoxedRigidBodyMover::do_propose ( )

Implement propose_move()

Implements IMP::core::MonteCarloMover.

virtual void IMP::spb::PbcBoxedRigidBodyMover::do_reject ( )

Implement reset_proposed_move()

Implements IMP::core::MonteCarloMover.

virtual ::IMP::VersionInfo IMP::spb::PbcBoxedRigidBodyMover::get_version_info ( ) const

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 42 of file PbcBoxedRigidBodyMover.h.

The documentation for this class was generated from the following file: