![]() |
Rosetta
3.8
|
#include <SSElementMotifContactEnergy.hh>
Public Types | |
typedef WholeStructureEnergy | parent |
![]() | |
typedef EnergyMethod | parent |
![]() | |
typedef utility::pointer::ReferenceCount | parent |
Public Member Functions | |
SSElementMotifContactEnergy () | |
virtual EnergyMethodOP | clone () const |
utility::vector1< std::pair < Size, Size > > | get_ss_elements (const pose::Pose &pose) const |
get ss_elements More... | |
Size | which_ssElement (Size res, utility::vector1< std::pair< Size, Size > > ssElements) const |
Size | get_ssElements_in_contact_w_threshold (std::multiset< Size > ssElements_in_contact) const |
Size | get_SSelements_in_contact (Size element, utility::vector1< std::pair< Size, Size > > ssElements, const pose::Pose &pose) const |
virtual void | finalize_total_energy (pose::Pose &pose, ScoreFunction const &, EnergyMap &totals) const |
Called at the end of the energy evaluation. More... | |
virtual 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. More... | |
virtual core::Size | version () const |
Return the version of the energy method. More... | |
![]() | |
WholeStructureEnergy (EnergyMethodCreatorOP) | |
Constructor with EnergyMethodCreator to list the ScoreTypes computed by this WholeStructureEnergy. More... | |
virtual | ~WholeStructureEnergy () |
EnergyMethodType | method_type () const |
Return one of the 7 kinds of energy methods that exist: e.g. context-dependent-one-body vs whole-structure. More... | |
virtual Distance | atomic_interaction_cutoff () const |
how far apart must two heavy atoms be to have a zero interaction energy? More... | |
![]() | |
EnergyMethod (EnergyMethodCreatorOP creator) | |
Constructor with EnergyMethodCreator, which lists the score types that this energy method is responsible for. More... | |
EnergyMethod (EnergyMethod const &src) | |
Copy constructor copies over the score types of the source. More... | |
virtual | ~EnergyMethod () |
virtual void | setup_for_packing (pose::Pose &, utility::vector1< bool > const &, utility::vector1< bool > const &) const |
if an energy method needs to cache data in the Energies object, before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing. More... | |
virtual void | prepare_rotamers_for_packing (pose::Pose const &, conformation::RotamerSetBase &) const |
If an energy method needs to cache data in a packing::RotamerSet object before rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing. More... | |
virtual void | update_residue_for_packing (pose::Pose &, Size resid) const |
If the pose changes in the middle of a packing (as happens in rotamer trials) and if an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing. More... | |
virtual void | setup_for_scoring (pose::Pose &, ScoreFunction const &) const |
if an energy method needs to cache something in the pose (e.g. in pose.energies()), before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing. More... | |
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. More... | |
virtual void | setup_for_derivatives (pose::Pose &pose, ScoreFunction const &sfxn) const |
Called immediately before atom- and DOF-derivatives are calculated allowing the derived class a chance to prepare for future calls. More... | |
virtual void | finalize_after_derivatives (pose::Pose &, ScoreFunction const &) const |
called at the end of derivatives evaluation More... | |
virtual bool | minimize_in_whole_structure_context (pose::Pose const &) const |
Should this EnergyMethod have score and derivative evaluation evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that's serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return "true" will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction's traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return "true" cannot be included in RTMin. More... | |
virtual bool | defines_high_order_terms (pose::Pose const &) const |
Should this EnergyMethod have score and derivative evaluation evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta's get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns "false". More... | |
virtual void | 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 |
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. More... | |
ScoreTypes const & | score_types () const |
Returns the score types that this energy method computes. More... | |
virtual void | show_additional_info (std::ostream &, pose::Pose &, bool) const |
show additional information of the energy method More... | |
Private Attributes | |
core::scoring::motif::MotifHashManager * | mman_ |
Additional Inherited Members | |
![]() | |
void | set_score_types (EnergyMethodCreatorOP creator) |
Override the entirety of the score types list if they were initialized incorrectly in a parent's constructor. More... | |
core::scoring::methods::SSElementMotifContactEnergy::SSElementMotifContactEnergy | ( | ) |
References mman_.
|
inlinevirtual |
Implements core::scoring::methods::EnergyMethod.
|
virtual |
Called at the end of the energy evaluation.
Reimplemented from core::scoring::methods::EnergyMethod.
References get_ss_elements(), get_SSelements_in_contact(), protocols::hybridization::score, and core::scoring::ss_contact_worst.
vector1< std::pair< Size, Size > > core::scoring::methods::SSElementMotifContactEnergy::get_ss_elements | ( | const pose::Pose & | pose | ) | const |
get ss_elements
References protocols::simple_filters::dssp(), core::scoring::dssp::Dssp::dssp_reduced(), core::scoring::dssp::Dssp::get_dssp_secstruct(), and core::pose::Pose::size().
Referenced by finalize_total_energy().
Size core::scoring::methods::SSElementMotifContactEnergy::get_SSelements_in_contact | ( | Size | element, |
utility::vector1< std::pair< Size, Size > > | ssElements, | ||
const pose::Pose & | pose | ||
) | const |
References protocols::simple_filters::dssp(), core::pose::Pose::fold_tree(), core::pose::motif::get_backbone_reference_frame(), core::scoring::dssp::Dssp::get_dssp_secstruct(), core::scoring::motif::MotifHashManager::get_xform_score_BB_BB(), mman_, core::conformation::Residue::name1(), core::pose::Pose::residue(), core::pose::Pose::size(), which_ssElement(), and core::conformation::Residue::xyz().
Referenced by finalize_total_energy().
Size core::scoring::methods::SSElementMotifContactEnergy::get_ssElements_in_contact_w_threshold | ( | std::multiset< Size > | ssElements_in_contact | ) | const |
|
inlinevirtual |
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.
|
virtual |
Return the version of the energy method.
Implements core::scoring::methods::EnergyMethod.
Size core::scoring::methods::SSElementMotifContactEnergy::which_ssElement | ( | Size | res, |
utility::vector1< std::pair< Size, Size > > | ssElements | ||
) | const |
Referenced by get_SSelements_in_contact().
|
private |
Referenced by get_SSelements_in_contact(), and SSElementMotifContactEnergy().