IMP logo
IMP Reference Guide  develop.182d9373c4,2021/04/12
The Integrative Modeling Platform
IMP::core::WeightedDerivativesToRefined Class Reference

Copy the derivatives from a coarse particle to its refined particles. More...

#include <IMP/core/WeightedDerivativesToRefined.h>

+ Inheritance diagram for IMP::core::WeightedDerivativesToRefined:

Detailed Description

Copy the derivatives from a coarse particle to its refined particles.

See Also
DerivativesFromRefined
DerivativesToRefined
Centroid
atom::CenterOfMass

Definition at line 29 of file WeightedDerivativesToRefined.h.

Public Member Functions

 WeightedDerivativesToRefined (Refiner *r, FloatKey w=FloatKey(), FloatKeys keys=XYZ::get_xyz_keys())
 
virtual void apply_index (Model *m, ParticleIndex pi) const
 Copies weighted derivatives to fine particles. More...
 
virtual void apply_indexes (Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound) const
 
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const
 Overload this method to specify the inputs. More...
 
virtual ModelObjectsTemp do_get_outputs (Model *m, const ParticleIndexes &pis) const
 Overload this method to specify the outputs. More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::SingletonModifier
 SingletonModifier (std::string name="SingletonModifier %1%")
 
- Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp get_inputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects read when the given list of particles is used. More...
 
- Public Member Functions inherited from IMP::ParticleOutputs
ModelObjectsTemp get_outputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects changed when the given list of particles is used. 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)
 

Additional Inherited Members

- Public Types inherited from IMP::SingletonModifier
typedef ParticleArgument
 
typedef ParticleIndex IndexArgument
 
- 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::core::WeightedDerivativesToRefined::WeightedDerivativesToRefined ( Refiner r,
FloatKey  w = FloatKey(),
FloatKeys  keys = XYZ::get_xyz_keys() 
)

Constructs a weighted derivatives-to-refined modifier that copies derivatives from the coarse particle to its refinement Constructs a weighted derivatives-to-refined modifier that copies derivatives from the coarse particle to its refinement. The modifier copy the derivatives of keys to the particles returned by r, using weights w, divided by weight of pi.

Parameters
ra refiner to get fine particles for particle
wthe key for the weight given to derivatives of the fine particle (to be divided by the weight of the coarse particle). If w equals FloatKey(), then a default weight of [1.0 / N] is used, for N equals the number of particles returned by r.
keysthe keys whose derivatives are to be copied.

Member Function Documentation

virtual void IMP::core::WeightedDerivativesToRefined::apply_index ( Model m,
ParticleIndex  pi 
) const
virtual

Copies weighted derivatives to fine particles.

Copy ks to the particles returned by the refiner r, using weights w, divided by weight of pi, all as indicated in the constructor

Parameters
mthe model
pithe coarse grained particle

Implements IMP::SingletonModifier.

virtual void IMP::core::WeightedDerivativesToRefined::apply_indexes ( Model m,
const ParticleIndexes o,
unsigned int  lower_bound,
unsigned int  upper_bound 
) const
virtual

Apply the function to a collection of ParticlesTemp If bounds are passed, only apply to ones between the upper and lower bounds.

Reimplemented from IMP::SingletonModifier.

Definition at line 73 of file WeightedDerivativesToRefined.h.

virtual ModelObjectsTemp IMP::core::WeightedDerivativesToRefined::do_get_inputs ( Model m,
const ParticleIndexes pis 
) const
virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

virtual ModelObjectsTemp IMP::core::WeightedDerivativesToRefined::do_get_outputs ( Model m,
const ParticleIndexes pis 
) const
virtual

Overload this method to specify the outputs.

Implements IMP::ParticleOutputs.

virtual ::IMP::VersionInfo IMP::core::WeightedDerivativesToRefined::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 75 of file WeightedDerivativesToRefined.h.


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