IMP  2.4.0
The Integrative Modeling Platform
VolumeRestraint.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/VolumeRestraint.h
3  * \brief A restraint that prevents spheres from inter-penetrating
4  *
5  * Copyright 2007-2015 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPCORE_VOLUME_RESTRAINT_H
9 #define IMPCORE_VOLUME_RESTRAINT_H
10 
11 #include <IMP/core/core_config.h>
12 #include <IMP/SingletonContainer.h>
13 #include <IMP/kernel/Restraint.h>
14 #include <IMP/UnaryFunction.h>
15 
16 IMPCORE_BEGIN_NAMESPACE
17 #if defined(IMP_CORE_USE_IMP_CGAL) || defined(IMP_DOXYGEN)
18 //! A restraint that prevents spheres from inter-penetrating
19 /** \note This restraint does not support derivatives.
20  \note This restraint requires CGAL.*/
21 class IMPCOREEXPORT VolumeRestraint : public kernel::Restraint {
24  double volume_;
25 
26  public:
27  VolumeRestraint(UnaryFunction *f, SingletonContainer *sc, double volume);
28 
29  virtual double unprotected_evaluate(IMP::kernel::DerivativeAccumulator *accum)
30  const IMP_OVERRIDE;
33 };
34 #endif
35 
36 IMPCORE_END_NAMESPACE
37 
38 #endif /* IMPCORE_VOLUME_RESTRAINT_H */
Class for adding derivatives from restraints to the model.
Import IMP/kernel/SingletonContainer.h in the namespace.
A smart pointer to a ref-counted Object that is a class member.
Definition: Pointer.h:147
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
Import IMP/kernel/UnaryFunction.h in the namespace.
Abstract single variable functor class for score functions.
Abstract base class for all restraints.
A restraint that prevents spheres from inter-penetrating.
A restraint is a term in an IMP ScoringFunction.
virtual ModelObjectsTemp do_get_inputs() const =0
A shared container for Singletons.
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.