Rosetta 3.4
Public Types | Public Member Functions
core::scoring::methods::ResidualDipolarCouplingEnergy Class Reference

#include <ResidualDipolarCouplingEnergy.hh>

Inheritance diagram for core::scoring::methods::ResidualDipolarCouplingEnergy:
Inheritance graph
[legend]
Collaboration diagram for core::scoring::methods::ResidualDipolarCouplingEnergy:
Collaboration graph
[legend]

List of all members.

Public Types

typedef WholeStructureEnergy parent

Public Member Functions

 ResidualDipolarCouplingEnergy ()
virtual EnergyMethodOP clone () const
virtual void setup_for_scoring (pose::Pose &, ScoreFunction const &) const
virtual void setup_for_minimizing (pose::Pose &, ScoreFunction const &, kinematics::MinimizerMapBase const &) const
 Called at the beginning of atom tree minimization, this method allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose's Energies object's "use_nblist()" method returns true.
void finalize_total_energy (pose::Pose &pose, ScoreFunction const &, EnergyMap &totals) const
 called by the ScoreFunction at the end of energy evaluation. The derived class has the opportunity to accumulate a score into the pose's total_energy EnergyMap. WholeStructure energies operate within this method; any method using a NeighborList during minimization would also operate within this function call.
void indicate_required_context_graphs (utility::vector1< bool > &) const
 Indicate in the context-graphs-required list which context-graphs this energy method requires that the Pose maintain when doing neighbor evaluation. Context graphs are allowed.
virtual void eval_atom_derivative (id::AtomID const &id, pose::Pose const &pose, kinematics::DomainMap const &domain_map, ScoreFunction const &sfxn, EnergyMap const &weights, Vector &F1, Vector &F2) const
 Evaluate the XYZ derivative for an atom in the pose. Called during the atomtree derivative calculation, atom_tree_minimize.cc, through the ScoreFunction::eval_atom_derivative intermediary. F1 and F2 should not zeroed, rather, this class should accumulate its contribution from this atom's XYZ derivative.

Member Typedef Documentation


Constructor & Destructor Documentation

core::scoring::methods::ResidualDipolarCouplingEnergy::ResidualDipolarCouplingEnergy ( )

Referenced by clone().


Member Function Documentation

EnergyMethodOP core::scoring::methods::ResidualDipolarCouplingEnergy::clone ( ) const [virtual]
void core::scoring::methods::ResidualDipolarCouplingEnergy::eval_atom_derivative ( id::AtomID const &  id,
pose::Pose const &  pose,
kinematics::DomainMap const &  domain_map,
ScoreFunction const &  sfxn,
EnergyMap const &  emap,
Vector F1,
Vector F2 
) const [virtual]

Evaluate the XYZ derivative for an atom in the pose. Called during the atomtree derivative calculation, atom_tree_minimize.cc, through the ScoreFunction::eval_atom_derivative intermediary. F1 and F2 should not zeroed, rather, this class should accumulate its contribution from this atom's XYZ derivative.

The derivative scheme is based on that of Abe, Braun, Noguti and Go (1984) "Rapid Calculation of First and Second Derivatives of Conformational Energy with Respect to Dihedral Angles for Proteins. General Recurrent Equations" Computers & Chemistry 8(4) pp. 239-247. F1 and F2 correspond roughly to Fa and Ga, respectively, of equations 7a & 7b in that paper.

default implementation does not alter either the F1 or F2 vectors.

Reimplemented from core::scoring::methods::EnergyMethod.

References core::conformation::Residue::atom_name(), core::scoring::ResidualDipolarCoupling::get_RDC_data(), core::id::AtomID_Map< T >::has(), core::scoring::rdc, core::pose::Pose::residue(), core::scoring::retrieve_RDC_from_pose(), and core::pose::Pose::xyz().

void core::scoring::methods::ResidualDipolarCouplingEnergy::finalize_total_energy ( pose::Pose pose,
ScoreFunction const &  sfxn,
EnergyMap total_energy 
) const [virtual]

called by the ScoreFunction at the end of energy evaluation. The derived class has the opportunity to accumulate a score into the pose's total_energy EnergyMap. WholeStructure energies operate within this method; any method using a NeighborList during minimization would also operate within this function call.

called at the end of energy evaluation

Reimplemented from core::scoring::methods::EnergyMethod.

References core::scoring::rdc.

void core::scoring::methods::ResidualDipolarCouplingEnergy::indicate_required_context_graphs ( utility::vector1< bool > &  context_graphs_required) const [inline, virtual]

Indicate in the context-graphs-required list which context-graphs this energy method requires that the Pose maintain when doing neighbor evaluation. Context graphs are allowed.

Implements core::scoring::methods::EnergyMethod.

void core::scoring::methods::ResidualDipolarCouplingEnergy::setup_for_minimizing ( pose::Pose pose,
ScoreFunction const &  ,
kinematics::MinimizerMapBase const &   
) const [virtual]

Called at the beginning of atom tree minimization, this method allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose's Energies object's "use_nblist()" method returns true.

Reimplemented from core::scoring::methods::EnergyMethod.

References core::id::AtomID_Map< T >::get(), core::scoring::ResidualDipolarCoupling::get_RDC_data(), core::pose::Pose::residue(), core::scoring::retrieve_RDC_from_pose(), core::id::AtomID_Map< T >::set(), and core::scoring::methods::tr().

void core::scoring::methods::ResidualDipolarCouplingEnergy::setup_for_scoring ( pose::Pose pose,
ScoreFunction const &   
) const [virtual]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines