#include <FA_ElecEnergyAroAll.hh>
Inheritance diagram for core::energy_methods::FA_ElecEnergyAroAll:
Public Types | |
| typedef core::scoring::elec::FA_ElecEnergy | parent |
| typedef core::scoring::methods::ContextIndependentTwoBodyEnergy | grandparent |
 Public Types inherited from core::scoring::methods::ContextIndependentTwoBodyEnergy | |
| typedef ShortRangeTwoBodyEnergy | parent |
| Public Types inherited from core::scoring::methods::ShortRangeTwoBodyEnergy | |
| typedef TwoBodyEnergy | parent |
| Public Types inherited from core::scoring::methods::TwoBodyEnergy | |
| typedef EnergyMethod | parent |
| Public Types inherited from core::scoring::methods::EnergyMethod | |
| typedef utility::VirtualBase | parent |
Public Member Functions | |
| FA_ElecEnergyAroAll (core::scoring::methods::EnergyMethodOptions const &options) | |
| FA_ElecEnergyAroAll (FA_ElecEnergyAroAll const &src) | |
| core::scoring::methods::EnergyMethodOP | clone () const override |
| clone More... | |
| void | setup_for_derivatives (pose::Pose &pose, core::scoring::ScoreFunction const &) const override |
| Called immediately before atom- and DOF-derivatives are calculated allowing the derived class a chance to prepare for future calls. More... | |
| void | setup_for_scoring (pose::Pose &pose, core::scoring::ScoreFunction const &) const override |
| 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... | |
| void | setup_for_packing (pose::Pose &pose, utility::vector1< bool > const &, utility::vector1< bool > const &) const override |
| 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... | |
| void | prepare_rotamers_for_packing (pose::Pose const &pose, conformation::RotamerSetBase &set) const override |
| overrides parent class implementation which would have created several tries More... | |
| void | update_residue_for_packing (pose::Pose &pose, Size resid) const override |
| overrides parent class implementation which would have updated a trie More... | |
| void | residue_pair_energy (conformation::Residue const &rsd1, conformation::Residue const &rsd2, pose::Pose const &pose, core::scoring::ScoreFunction const &, core::scoring::EnergyMap &emap) const override |
| Evaluate the interaction between a given residue pair accumulating the unweighted energies in an EnergyMap. More... | |
| bool | minimize_in_whole_structure_context (pose::Pose const &) const override |
| Returns "true" because this energy method has not been updated to use the new derivative evaluation machinery. Note that this class requires the definition of this method because it's parent class, FA_ElecEnergy, HAS been updated to use the new derivative evaluation machinery, and, if this class did not return "true", it would be asked to evaluate derivatives in ways it cannot yet evaluate them in. More... | |
| void | eval_intrares_energy (conformation::Residue const &, pose::Pose const &, core::scoring::ScoreFunction const &, core::scoring::EnergyMap &) const override |
| Evaluate the intra-residue energy for a given residue. More... | |
| void | evaluate_rotamer_pair_energies (conformation::RotamerSetBase const &set1, conformation::RotamerSetBase const &set2, pose::Pose const &pose, core::scoring::ScoreFunction const &sfxn, core::scoring::EnergyMap const &weights, ObjexxFCL::FArray2D< core::PackerEnergy > &energy_table) const override |
| Batch computation of rotamer pair energies. Need not be overriden in derived class – by default, iterates over all pairs of rotamers, and calls the derived class's residue_pair_energy method. More... | |
| void | evaluate_rotamer_background_energies (conformation::RotamerSetBase const &set, conformation::Residue const &residue, pose::Pose const &pose, core::scoring::ScoreFunction const &sfxn, core::scoring::EnergyMap const &weights, utility::vector1< core::PackerEnergy > &energy_vector) const override |
| Batch computation of rotamer/background energies. Need not be overriden in derived class – by default, iterates over all rotamers in the set, and calls derived class's residue_pair_energy method for each one against the background rotamr. More... | |
| void | eval_atom_derivative (id::AtomID const &atom_id, pose::Pose const &pose, kinematics::DomainMap const &domain_map, core::scoring::ScoreFunction const &, core::scoring::EnergyMap const &weights, Vector &F1, Vector &F2) const override |
| 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... | |
| bool | defines_intrares_energy (core::scoring::EnergyMap const &) const override |
| Two body energies are able to define intra-residue energies, and to do so only in the presence of certain non-zero weights. The ScoreFunction will hand over its weight set as it asks whether the energy method defines an intraresidue energy or not. More... | |
| void | indicate_required_context_graphs (utility::vector1< bool > &context_graphs_required) const override |
| FA_ElecEnergyAroAll is context independent; no context graphs required. More... | |
| Real | residue_pair_energy_aro_aro (conformation::Residue const &rsd1, conformation::Residue const &rsd2, core::scoring::EnergyMap &emap) const |
| void | eval_atom_derivative_aro_aro (conformation::Residue const &rsd1, Size const &i, conformation::Residue const &rsd2, core::scoring::EnergyMap const &weights, Vector &F1, Vector &F2) const |
| core::Size | version () const override |
| Return the version of the energy method. More... | |
| Public Member Functions inherited from core::scoring::elec::FA_ElecEnergy | |
| FA_ElecEnergy ()=delete | |
| FA_ElecEnergy (methods::EnergyMethodOptions const &options) | |
| FA_ElecEnergy (FA_ElecEnergy const &src) | |
| void | initialize () |
| Initilize constants. More... | |
| methods::EnergyMethodOP | clone () const override |
| clone More... | |
| void | setup_for_minimizing (pose::Pose &pose, ScoreFunction const &sfxn, kinematics::MinimizerMapBase const &min_map) const override |
| stashes nblist if use_nblist is true More... | |
| void | setup_for_derivatives (pose::Pose &pose, ScoreFunction const &) const override |
| Called immediately before atom- and DOF-derivatives are calculated allowing the derived class a chance to prepare for future calls. More... | |
| void | setup_for_scoring (pose::Pose &pose, ScoreFunction const &) const override |
| 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... | |
| void | setup_for_packing (pose::Pose &pose, utility::vector1< bool > const &, utility::vector1< bool > const &) const override |
| 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... | |
| void | prepare_rotamers_for_packing (pose::Pose const &pose, conformation::RotamerSetBase &set) const override |
| 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... | |
| void | update_residue_for_packing (pose::Pose &pose, Size resid) const override |
| 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... | |
| void | residue_pair_energy (conformation::Residue const &rsd1, conformation::Residue const &rsd2, pose::Pose const &pose, ScoreFunction const &, EnergyMap &emap) const override |
| Evaluate the interaction between a given residue pair accumulating the unweighted energies in an EnergyMap. More... | |
| bool | minimize_in_whole_structure_context (pose::Pose const &pose) const override |
| Returns true if we're using neighborlist-autoupdate. More... | |
| bool | defines_score_for_residue_pair (conformation::Residue const &res1, conformation::Residue const &res2, bool res_moving_wrt_eachother) const override |
| During minimization, energy methods are allowed to decide that they say nothing about a particular residue pair (e.g. no non-zero energy) and as a result they will not be queried for a derivative or an energy. The default implementation returns "true" for all residue pairs. Context-dependent two-body energies have the option of behaving as if they are context-independent by returning "false" for residue pairs that do no move wrt each other. More... | |
| bool | use_extended_residue_pair_energy_interface () const override |
| Rely on the extended version of the residue_pair_energy function during score-function evaluation in minimization? The extended version (below) takes a ResPairMinimizationData in which the derived base class has (or should have) cached a piece of data that will make residue-pair energy evaluation faster than its absense (e.g. a neighbor list). Derived energy methods should return 'true' from this function to use the extended interface. The default method implemented in this class returns 'false'. More... | |
| void | residue_pair_energy_ext (conformation::Residue const &rsd1, conformation::Residue const &rsd2, ResPairMinimizationData const &min_data, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap &emap) const override |
| Evaluate the two-body energies for a particular residue, in the context of a given Pose, and with the help of a piece of cached data for minimization, increment those two body energies into the input EnergyMap. The calling function must guarantee that this EnergyMethod has had the opportunity to update the input ResPairMinimizationData object for the given residues in a call to setup_for_minimizing_for_residue_pair before this function is invoked. This function should not be called unless the use_extended_residue_pair_energy_interface() method returns "true". Default implementation provided by this base class calls utility::exit(). More... | |
| bool | requires_a_setup_for_scoring_for_residue_opportunity_during_minimization (pose::Pose const &) const override |
| Does this EnergyMethod require the opportunity to examine the residue before scoring begins? Not all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. More... | |
| void | setup_for_scoring_for_residue (conformation::Residue const &rsd, pose::Pose const &, ScoreFunction const &sfxn, ResSingleMinimizationData &resdata) const override |
| Do any setup work should the coordinates of this residue (who is still guaranteed to be of the same residue type as when setup_for_minimizing_for_residue was called) have changed so dramatically as to possibly require some amount of setup work before scoring should proceed. This function is used for both intra-residue setup and pre-inter-residue setup. More... | |
| bool | requires_a_setup_for_derivatives_for_residue_opportunity (pose::Pose const &) const override |
| Does this EnergyMethod require the opportunity to examine each residue before derivative evaluation begins? Not all energy methods would. The ScoreFunction will not ask energy methods to examine residue pairs that are uninterested in doing so. More... | |
| void | setup_for_derivatives_for_residue (conformation::Residue const &rsd, pose::Pose const &pose, ScoreFunction const &sfxn, ResSingleMinimizationData &min_data, basic::datacache::BasicDataCache &) const override |
| Do any setup work necessary before evaluating the derivatives for this residue. More... | |
| void | setup_for_minimizing_for_residue (conformation::Residue const &rsd, pose::Pose const &pose, ScoreFunction const &scorefxn, kinematics::MinimizerMapBase const &min_map, basic::datacache::BasicDataCache &, ResSingleMinimizationData &resdata) const override |
| Called at the beginning of minimization, allowing this energy method to cache data pertinent for a single residue in the the ResPairMinimizationData that is used for a particular residue in the context of a particular Pose. This base class provides a noop implementation for this function if there is nothing that the derived class needs to perform in this setup phase. More... | |
| void | setup_for_minimizing_for_residue_pair (conformation::Residue const &rsd1, conformation::Residue const &rsd2, pose::Pose const &pose, ScoreFunction const &sfxn, kinematics::MinimizerMapBase const &minmap, ResSingleMinimizationData const &res1_data_cache, ResSingleMinimizationData const &res2_data_cache, ResPairMinimizationData &data_cache) const override |
| Called at the beginning of minimization, allowing this energy method to cache data pertinent for a single residue in the the ResPairMinimizationData that is used for a particular residue in the context of a particular Pose. This base class provides a noop implementation for this function if there is nothing that the derived class needs to perform in this setup phase. More... | |
| void | eval_residue_pair_derivatives (conformation::Residue const &rsd1, conformation::Residue const &rsd2, ResSingleMinimizationData const &, ResSingleMinimizationData const &, ResPairMinimizationData const &min_data, pose::Pose const &pose, EnergyMap const &weights, utility::vector1< DerivVectorPair > &r1_atom_derivs, utility::vector1< DerivVectorPair > &r2_atom_derivs) const override |
| Evaluate the atom derivative f1/f2 vectors for all atoms on rsd1 in response to the atoms on rsd2, and all the atoms on rsd2 as they in response to the atoms on rsd1. This method is used with the MinimizationGraph and when nblist_autoupdate is not in use. More... | |
| void | eval_atom_derivative (id::AtomID const &atom_id, pose::Pose const &pose, kinematics::DomainMap const &domain_map, ScoreFunction const &, EnergyMap const &weights, Vector &F1, Vector &F2) const override |
| Evaluate the derivative vectors for a particular atom in a given (asymmetric) pose when nblist_autoupdate is being used. nblist_autoupdate cannot be used with symmetric poses, in rtmin, or in minpack. More... | |
| void | eval_intrares_derivatives (conformation::Residue const &rsd, ResSingleMinimizationData const &min_data, pose::Pose const &pose, EnergyMap const &weights, utility::vector1< DerivVectorPair > &atom_derivs) const override |
| Evaluate the derivative for the intra-residue component of this energy method for all the atoms in a residue in the context of a particular pose, and increment the F1 and F2 vectors held in the atom_derivs vector1. This base class provides a default noop implementation of this function. The calling function must guarantee that this EnergyMethod has had the opportunity to update the input ResSingleMinimizationData object for the given residue in a call to prepare_for_minimization before this function is invoked. The calling function must also guarantee that there are at least as many entries in the atom_derivs vector1 as there are atoms in the input rsd. More... | |
| void | backbone_backbone_energy (conformation::Residue const &rsd1, conformation::Residue const &rsd2, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap &emap) const override |
| Evaluate the interaction between the backbone of rsd1 and the backbone of rsd2 and accumulate the unweighted energies. The sum bb_bb(r1,r2) + bb_sc(r1,r2) + bb_sc(r2,r1) + sc_sc( r1,r2) must equal the weighted result of a call to residue_pair_energy. By default, bb_bb & bb_sc return 0 and sc_sc returns residue pair energy. More... | |
| void | backbone_sidechain_energy (conformation::Residue const &rsd1, conformation::Residue const &rsd2, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap &emap) const override |
| Evaluate the interaction between the backbone of rsd1 and the sidechain of rsd2 and accumulate the unweighted energies. The sum bb_bb(r1,r2) + bb_sc(r1,r2) + bb_sc(r2,r1) + sc_sc( r1,r2) must equal the unweighted result of a call to residue_pair_energy. By default, bb_bb & bb_sc return 0 and sc_sc returns residue pair energy. More... | |
| void | sidechain_sidechain_energy (conformation::Residue const &rsd1, conformation::Residue const &rsd2, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap &emap) const override |
| Evaluate the interaction between the sidechain of rsd1 and the sidechain of rsd2 and accumulate the unweighted energies. The sum bb_bb(r1,r2) + bb_sc(r1,r2) + bb_sc(r2,r1) + sc_sc( r1,r2) must equal the unweighted result of a call to residue_pair_energy. By default, bb_bb & bb_sc return 0 and sc_sc returns residue pair energy. More... | |
| void | finalize_total_energy (pose::Pose &pose, ScoreFunction const &, EnergyMap &totals) const override |
| 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. More... | |
| void | eval_intrares_energy (conformation::Residue const &rsd, pose::Pose const &pose, ScoreFunction const &sf, EnergyMap &emap) const override |
| Evaluate the intra-residue energy for a given residue. More... | |
| void | evaluate_rotamer_pair_energies (conformation::RotamerSetBase const &set1, conformation::RotamerSetBase const &set2, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap const &weights, ObjexxFCL::FArray2D< core::PackerEnergy > &energy_table) const override |
| Batch computation of rotamer pair energies. Need not be overriden in derived class – by default, iterates over all pairs of rotamers, and calls the derived class's residue_pair_energy method. More... | |
| void | evaluate_rotamer_background_energies (conformation::RotamerSetBase const &set, conformation::Residue const &residue, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap const &weights, utility::vector1< core::PackerEnergy > &energy_vector) const override |
| Batch computation of rotamer/background energies. Need not be overriden in derived class – by default, iterates over all rotamers in the set, and calls derived class's residue_pair_energy method for each one against the background rotamr. More... | |
| void | evaluate_rotamer_intrares_energies (conformation::RotamerSetBase const &set, pose::Pose const &pose, ScoreFunction const &sfxn, utility::vector1< core::PackerEnergy > &energies) const override |
| Batch computation of rotamer intrares energies. Need not be overriden in derived class – by default, iterates over all rotamers, and calls derived class's intrares _energy method. More... | |
| bool | defines_intrares_energy (EnergyMap const &) const override |
| Two body energies are able to define intra-residue energies, and to do so only in the presence of certain non-zero weights. The ScoreFunction will hand over its weight set as it asks whether the energy method defines an intraresidue energy or not. More... | |
| etable::count_pair::CountPairFunctionCOP | get_intrares_countpair (conformation::Residue const &, pose::Pose const &, ScoreFunction const &sf) const |
| Interface function for class NeighborList. More... | |
| etable::count_pair::CountPairFunctionCOP | get_count_pair_function (Size const, Size const, pose::Pose const &, ScoreFunction const &) const |
| Interface function for class NeighborList. More... | |
| etable::count_pair::CountPairFunctionCOP | get_count_pair_function (conformation::Residue const &rsd1, conformation::Residue const &rsd2) const |
| Returns a regular count-pair function as opposed to a CountPairRepresentative function. More... | |
| Distance | atomic_interaction_cutoff () const override |
| FA_ElecEnergy distance cutoff. More... | |
| bool | divides_backbone_and_sidechain_energetics () const override |
| A derived class should return true for this function if it implements its own versions of the backbone_backbone_energy, backbone_sidechain_energy and sidechain_sidechain_energy functions. The default sidechain_sidechain_energy implemented by the TwoBodyEnergy base class calls residue_pair_energy. If the derived class implements its own versions of these functions, then calling code may avoid calling it on pairs of residues that are "provably distant" based on a pair of bounding spheres for a sidechains and backbones and this method's atomic_interaction_cutoff energy method. More... | |
| void | indicate_required_context_graphs (utility::vector1< bool > &context_graphs_required) const override |
| FA_ElecEnergy. More... | |
| bool | has_atomistic_pairwise_energies () const override |
| fa_elec has pairwise energies, but not single atom energies More... | |
| void | atomistic_pair_energy (core::Size, conformation::Residue const &, core::Size, conformation::Residue const &, pose::Pose const &, ScoreFunction const &, EnergyMap &) const override |
| Evaluate the energy for a particular pair of atoms This function may be fed the same residue with different atom numbers NOTE: all the cautions of EnergyMethod::has_atomistic_energies() apply here. For most terms this is likely a no-op. Terms which implement this non-trivially should return true from has_atomistic_pairwise_energies() More... | |
| Real | hydrogen_interaction_cutoff2 () const |
| How close two heavy atoms have to be such that their hydrogen atoms might interact, squared. More... | |
| Real | hydrogen_interaction_cutoff () const |
| How close two heavy atoms have to be such that their hydrogen atoms might interact. More... | |
| bool | eval_intrares_ST_only () const |
| Real | elec_weight (bool intra_res, bool at1isbb, bool at2isbb, weight_triple const &wts) const |
| core::Size | get_countpair_representative_atom (core::chemical::ResidueType const &restype, core::Size atm_i) const |
| etable::coulomb::Coulomb const & | coulomb () const |
| Public Member Functions inherited from core::scoring::methods::ContextIndependentTwoBodyEnergy | |
| ContextIndependentTwoBodyEnergy (EnergyMethodCreatorOP) | |
| Constructor with an EnergyMethodCreator to inform the ancestor EnergyMethod class which ScoreTypes this EnergyMethod is responsible for computing. More... | |
| ~ContextIndependentTwoBodyEnergy () override | |
| EnergyMethodType | method_type () const override |
| Return one of the 7 kinds of energy methods that exist: e.g. context-dependent-one-body vs whole-structure. More... | |
| Public Member Functions inherited from core::scoring::methods::ShortRangeTwoBodyEnergy | |
| ShortRangeTwoBodyEnergy (EnergyMethodCreatorOP) | |
| Constructor with EnergyMethodCreator to provide to the EnergyMethod grandparent the list of the ScoreTypes this EnergyMethod is responsible for computing. More... | |
| ~ShortRangeTwoBodyEnergy () override | |
| void | evaluate_rotamer_pair_energies (conformation::RotamerSetBase const &set1, conformation::RotamerSetBase const &set2, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap const &weights, ObjexxFCL::FArray2D< core::PackerEnergy > &energy_table) const override |
| Batch computation of rotamer pair energies. Need not be overriden in derived class – by default, iterates over all pairs of rotamers, and calls derived class's residue_pair_energy method. Since short range rotamer pairs may not need calculation, the default method looks at blocks of residue type pairs and only calls the residue_pair_energy method if the rotamer pairs are within range. More... | |
| void | evaluate_rotamer_background_energies (conformation::RotamerSetBase const &set, conformation::Residue const &residue, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap const &weights, utility::vector1< core::PackerEnergy > &energy_vector) const override |
| Batch computation of rotamer/background energies. Need not be overriden in derived class – by default, iterates over all rotamers in the set, and calls derived class's residue_pair_energy method for each one against the background rotamer Since short range rotamer pairs may not need calculation, the default method looks at blocks of residue type pairs and only calls the residue_pair_energy method if the rotamer pairs are within range. More... | |
| void | evaluate_rotamer_background_energy_maps (conformation::RotamerSetBase const &set, conformation::Residue const &residue, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap const &weights, utility::vector1< EnergyMap > &emaps) const override |
| Batch computation of rotamer/background energies. Need not be overriden in derived class – by default, iterates over all rotamers in the set, and calls derived class's residue_pair_energy method for each one against the background rotamer Since short range rotamer pairs may not need calculation, the default method looks at blocks of residue type pairs and only calls the residue_pair_energy method if the rotamer pairs are within range. More... | |
| Public Member Functions inherited from core::scoring::methods::TwoBodyEnergy | |
| TwoBodyEnergy (EnergyMethodCreatorOP) | |
| Constructor, requiring an EnergyMethodCreator. No default constructor provided to force EnergyMethod writers to provide an energy-method-creator at construction time. More... | |
| ~TwoBodyEnergy () override | |
| virtual bool | requires_a_setup_for_scoring_for_residue_pair_opportunity (pose::Pose const &pose) const |
| Does this EnergyMethod require the opportunity to examine each residue pair before scoring begins? Not all energy methods would. The ScoreFunction will not ask energy methods to examine residue pairs that are uninterested in doing so. More... | |
| virtual void | setup_for_scoring_for_residue_pair (conformation::Residue const &rsd1, conformation::Residue const &rsd2, ResSingleMinimizationData const &minsingle_data1, ResSingleMinimizationData const &minsingle_data2, pose::Pose const &pose, ScoreFunction const &sfxn, ResPairMinimizationData &data_cache) const |
| Do any setup work should the coordinates of a pair of residues, who are still guaranteed to be of the same residue type as when setup_for_minimizing_for_residue was called, have changed so dramatically as to possibly require some amount of setup work before scoring should proceed. More... | |
| virtual bool | requires_a_setup_for_derivatives_for_residue_pair_opportunity (pose::Pose const &pose) const |
| Does this EnergyMethod require the opportunity to examine each residue pair before derivative evaluation begins? Not all energy methods would. The ScoreFunction will not ask energy methods to examine residue pairs that are uninterested in doing so. More... | |
| virtual void | setup_for_derivatives_for_residue_pair (conformation::Residue const &rsd1, conformation::Residue const &rsd2, ResSingleMinimizationData const &minsingle_data1, ResSingleMinimizationData const &minsingle_data2, pose::Pose const &pose, ScoreFunction const &sfxn, ResPairMinimizationData &data_cache) const |
| Do any setup work necessary before evaluating the derivatives for this residue pair. More... | |
| virtual bool | defines_intrares_energy_for_residue (conformation::Residue const &res) const |
| If a score function defines no intra-residue scores for a particular residue, then it may opt-out of being asked during minimization to evaluate the score for this residue. More... | |
| virtual bool | use_extended_intrares_energy_interface () const |
| Derived classes wishing to invoke the alternate, extended interface for eval_intrares_energy during minimization routines should return "true" when this function is invoked on them. This class provides a default "return false" implementation so that classes not desiring to take advantage of this alternate interface need to do nothing. More... | |
| virtual void | eval_intrares_energy_ext (conformation::Residue const &rsd, ResSingleMinimizationData const &data_cache, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap &emap) const |
| Evaluate the intra-residue energy for a given residue using the data held within the ResSingleMinimizationData object. This function should be invoked only on derived instances of this class if they return "true" in a call to their use_extended_intrares_energy_interface method. This base class provides a noop implementation for classes that do not implement this interface, or that do not define intrares energies. More... | |
| virtual bool | defines_intrares_dof_derivatives (pose::Pose const &p) const |
| Use the dof_derivative interface for this energy method when calculating derivatives? It is possible to define both dof_derivatives and atom-derivatives; they are not mutually exclusive. More... | |
| virtual utility::vector1< id::PartialAtomID > | atoms_with_dof_derivatives (conformation::Residue const &res, pose::Pose const &p) const |
| For a particular residue, list which atoms go into defining the DOF derivatives, including any atoms on adjacent residues. The Pose is provided for context, but there is no requirement that res be a member of that Pose. More... | |
| virtual Real | eval_intraresidue_dof_derivative (conformation::Residue const &rsd, ResSingleMinimizationData const &min_data, id::DOF_ID const &dof_id, id::TorsionID const &torsion_id, pose::Pose const &pose, ScoreFunction const &sfxn, EnergyMap const &weights) const |
| Evaluate the DOF derivative for a particular residue. The Pose merely serves as context, and the input residue is not required to be a member of the Pose. More... | |
| virtual void | bump_energy_full (conformation::Residue const &, conformation::Residue const &, pose::Pose const &, ScoreFunction const &, EnergyMap &) const |
| virtual void | bump_energy_backbone (conformation::Residue const &, conformation::Residue const &, pose::Pose const &, ScoreFunction const &, EnergyMap &) const |
| virtual void | evaluate_rotamer_intrares_energy_maps (conformation::RotamerSetBase const &set, pose::Pose const &pose, ScoreFunction const &sfxn, utility::vector1< EnergyMap > &emaps) const |
| Batch computation of rotamer intrares energy map. Need not be overriden in derived class – by default, iterates over all rotamers, and calls derived class's intrares _energy method. More... | |
| virtual void | setup_for_scoring_for_residue (conformation::Residue const &rsd, pose::Pose const &pose, ScoreFunction const &sfxn, basic::datacache::BasicDataCache &residue_data_cache) const |
| Do any setup work before scoring, caching any slow-to-compute data that will be used during energy evaluation inside of the input Residue object's data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.) More... | |
| Public Member Functions inherited from core::scoring::methods::EnergyMethod | |
| EnergyMethod (EnergyMethodCreatorOP creator) | |
| Constructor with EnergyMethodCreator, which lists the score types that this energy method is responsible for. More... | |
| virtual void | setup_for_packing_with_rotsets (pose::Pose &pose, pack_basic::RotamerSetsBaseOP const &rotsets, ScoreFunction const &sfxn) const |
| if an energy method needs to cache data in the Energies object, before packing begins and requires access to the RotamerSets object, then it does so during this function. The default behavior is to do nothing. More... | |
| virtual bool | requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring (pose::Pose const &pose) const |
| Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false. More... | |
| virtual void | setup_for_scoring_for_residue (conformation::Residue const &rsd, pose::Pose const &pose, ScoreFunction const &sfxn, basic::datacache::BasicDataCache &residue_data_cache) const |
| Do any setup work before scoring, caching any slow-to-compute data that will be used during energy evaluation inside of the input Residue object's data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.) More... | |
| virtual void | finalize_after_minimizing (pose::Pose &pose) const |
| Called after minimization, allowing a derived class to do some teardown steps. More... | |
| virtual void | finalize_after_derivatives (pose::Pose &, ScoreFunction const &) const |
| called at the end of derivatives evaluation 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 bool | has_atomistic_energies () const |
| Does this EnergyMethod have a non-trivial implementation of the (one body) atomistic energy method? Note that this may return false even if the score term theoretically could support atomistic energies. And even if this function returns true, it's not necessarily the case that all atoms will get assigned an energy, or that the sum over all atoms (or atom pairs) will result in the same energy as the residue-level approach. The atomistic functions are intended for supplemental informational purposes only. The residue-level energies are the main interface for EnergyMethods. More... | |
| virtual void | atomistic_energy (core::Size atmno, conformation::Residue const &rsd, pose::Pose const &pose, ScoreFunction const &scorefxn, EnergyMap &emap) const |
| Evaluate the (one body) energy associated with a particular atom This may be a "self" energy, or it may be the single atom contribution from a whole structure term. NOTE: all the cautions of EnergyMethod::has_atomistic_energies() apply here. For most terms this is likely a no-op. Terms which implement this non-trivially should return true from has_atomistic_energies() 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... | |
| virtual void | provide_citation_info (basic::citation_manager::CitationCollectionList &) const |
| Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More... | |
Additional Inherited Members | |
| Public Attributes inherited from core::scoring::elec::FA_ElecEnergy | |
| __pad0__:ContextIndependentTwoBodyEnergy parent | |
| Protected Member Functions inherited from core::scoring::methods::EnergyMethod | |
| 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... | |
Member Typedef Documentation
◆ grandparent
| typedef core::scoring::methods::ContextIndependentTwoBodyEnergy core::energy_methods::FA_ElecEnergyAroAll::grandparent |
◆ parent
Constructor & Destructor Documentation
◆ FA_ElecEnergyAroAll() [1/2]
| core::energy_methods::FA_ElecEnergyAroAll::FA_ElecEnergyAroAll | ( | core::scoring::methods::EnergyMethodOptions const & | options | ) |
◆ FA_ElecEnergyAroAll() [2/2]
| core::energy_methods::FA_ElecEnergyAroAll::FA_ElecEnergyAroAll | ( | FA_ElecEnergyAroAll const & | src | ) |
Member Function Documentation
◆ clone()
|
overridevirtual |
clone
Implements core::scoring::methods::EnergyMethod.
◆ defines_intrares_energy()
|
inlineoverridevirtual |
Two body energies are able to define intra-residue energies, and to do so only in the presence of certain non-zero weights. The ScoreFunction will hand over its weight set as it asks whether the energy method defines an intraresidue energy or not.
For example, the Etable method defines intra-residue energies only when one or more of the fa_intra_{atr,rep,sol} weights are non-zero.
Implements core::scoring::methods::TwoBodyEnergy.
◆ eval_atom_derivative()
|
overridevirtual |
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::atomic_charge(), core::id::AtomID::atomno(), core::pose::Pose::energies(), core::scoring::Energies::energy_graph(), eval_atom_derivative_aro_aro(), core::conformation::Residue::is_aromatic(), core::pose::Pose::residue(), and core::id::AtomID::rsd().
◆ eval_atom_derivative_aro_aro()
| void core::energy_methods::FA_ElecEnergyAroAll::eval_atom_derivative_aro_aro | ( | conformation::Residue const & | rsd1, |
| Size const & | i, | ||
| conformation::Residue const & | rsd2, | ||
| core::scoring::EnergyMap const & | weights, | ||
| Vector & | F1, | ||
| Vector & | F2 | ||
| ) | const |
References core::energy_methods::atom_is_aro2(), core::conformation::Residue::atomic_charge(), core::scoring::elec::FA_ElecEnergy::coulomb(), core::scoring::etable::count_pair::CP_CROSSOVER_4, core::scoring::etable::coulomb::Coulomb::eval_dfa_elecE_dr_over_r(), core::scoring::fa_elec_aro_all, core::conformation::Residue::natoms(), and core::conformation::Residue::xyz().
Referenced by eval_atom_derivative().
◆ eval_intrares_energy()
|
inlineoverridevirtual |
Evaluate the intra-residue energy for a given residue.
Implements core::scoring::methods::TwoBodyEnergy.
◆ evaluate_rotamer_background_energies()
|
overridevirtual |
Batch computation of rotamer/background energies. Need not be overriden in derived class – by default, iterates over all rotamers in the set, and calls derived class's residue_pair_energy method for each one against the background rotamr.
Reimplemented from core::scoring::methods::TwoBodyEnergy.
References core::scoring::methods::ShortRangeTwoBodyEnergy::evaluate_rotamer_background_energies(), and core::conformation::Residue::is_aromatic().
◆ evaluate_rotamer_pair_energies()
|
overridevirtual |
Batch computation of rotamer pair energies. Need not be overriden in derived class – by default, iterates over all pairs of rotamers, and calls the derived class's residue_pair_energy method.
Reimplemented from core::scoring::methods::TwoBodyEnergy.
References core::scoring::methods::ShortRangeTwoBodyEnergy::evaluate_rotamer_pair_energies(), core::conformation::RotamerSetBase::num_rotamers(), and core::conformation::RotamerSetBase::rotamer().
◆ indicate_required_context_graphs()
|
overridevirtual |
FA_ElecEnergyAroAll is context independent; no context graphs required.
Implements core::scoring::methods::EnergyMethod.
◆ minimize_in_whole_structure_context()
|
inlineoverridevirtual |
Returns "true" because this energy method has not been updated to use the new derivative evaluation machinery. Note that this class requires the definition of this method because it's parent class, FA_ElecEnergy, HAS been updated to use the new derivative evaluation machinery, and, if this class did not return "true", it would be asked to evaluate derivatives in ways it cannot yet evaluate them in.
Reimplemented from core::scoring::methods::EnergyMethod.
◆ prepare_rotamers_for_packing()
|
overridevirtual |
overrides parent class implementation which would have created several tries
Reimplemented from core::scoring::methods::EnergyMethod.
◆ residue_pair_energy()
|
overridevirtual |
Evaluate the interaction between a given residue pair accumulating the unweighted energies in an EnergyMap.
Implements core::scoring::methods::TwoBodyEnergy.
References core::conformation::Residue::is_aromatic(), and residue_pair_energy_aro_aro().
◆ residue_pair_energy_aro_aro()
| Real core::energy_methods::FA_ElecEnergyAroAll::residue_pair_energy_aro_aro | ( | conformation::Residue const & | rsd1, |
| conformation::Residue const & | rsd2, | ||
| core::scoring::EnergyMap & | emap | ||
| ) | const |
References core::energy_methods::atom_is_aro2(), core::conformation::Residue::atomic_charge(), core::scoring::elec::FA_ElecEnergy::coulomb(), core::scoring::etable::count_pair::CP_CROSSOVER_4, core::scoring::etable::coulomb::Coulomb::eval_atom_atom_fa_elecE(), core::scoring::fa_elec_aro_all, core::conformation::Residue::natoms(), protocols::hybridization::score, core::scoring::total_score, and core::conformation::Residue::xyz().
Referenced by residue_pair_energy().
◆ setup_for_derivatives()
|
overridevirtual |
Called immediately before atom- and DOF-derivatives are calculated allowing the derived class a chance to prepare for future calls.
default implementation noop
Reimplemented from core::scoring::methods::EnergyMethod.
References core::pose::Pose::update_residue_neighbors().
◆ setup_for_packing()
|
overridevirtual |
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.
default implementation noop
Reimplemented from core::scoring::methods::EnergyMethod.
◆ setup_for_scoring()
|
overridevirtual |
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.
Reimplemented from core::scoring::methods::EnergyMethod.
References core::pose::Pose::update_residue_neighbors().
◆ update_residue_for_packing()
|
overridevirtual |
overrides parent class implementation which would have updated a trie
Reimplemented from core::scoring::methods::EnergyMethod.
◆ version()
|
overridevirtual |
Return the version of the energy method.
Implements core::scoring::methods::EnergyMethod.
The documentation for this class was generated from the following files:
- src/core/energy_methods/FA_ElecEnergyAroAll.hh
- src/core/energy_methods/FA_ElecEnergyAroAll.cc
