Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::antibody::LHRepulsiveRamp Class Reference

#include <LHRepulsiveRamp.hh>

Inheritance diagram for protocols::antibody::LHRepulsiveRamp:
Inheritance graph
[legend]

Public Member Functions

 LHRepulsiveRamp ()
 default constructor More...
 
 LHRepulsiveRamp (docking::DockJumps const movable_jumps, core::scoring::ScoreFunctionCOP dock_scorefxn, core::scoring::ScoreFunctionCOP pack_scorefxn)
 constructor with arguments More...
 
protocols::moves::MoverOP clone () const override
 Return a clone of the Mover object. More...
 
 ~LHRepulsiveRamp () override
 default destructor More...
 
void set_default ()
 
void set_dock_score_func (core::scoring::ScoreFunctionCOP dock_scorefxn)
 
void set_pack_score_func (core::scoring::ScoreFunctionCOP pack_scorefxn)
 
void apply (core::pose::Pose &pose) override
 ramping up the fullatom repulsive weight slowly to allow the partners to relieve clashes and make way for each other More...
 
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
 
void set_task_factory (core::pack::task::TaskFactoryCOP tf)
 
void set_move_map (core::kinematics::MoveMapCOP movemap)
 
void set_dock_jump (docking::DockJumps jump)
 
core::Real set_rot_mag (core::Real rot_mag)
 
core::Real set_trans_mag (core::Real trans_mag)
 
void set_sc_min (bool sc_min)
 
void set_rt_min (bool rt_min)
 
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
 
virtual MoverOP create ()
 
MoverCOP get_self_ptr () const
 
MoverOP get_self_ptr ()
 
MoverCAP get_self_weak_ptr () const
 
MoverAP get_self_weak_ptr ()
 
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
 
virtual void test_move (Pose &pose)
 : Unit test support function. Apply one move to a given pose. Allows extra test specific functions to be called before applying More...
 
virtual bool reinitialize_for_each_job () const
 Inform the Job Distributor (August '08 vintage) whether this object needs to be freshly regenerated on each use. More...
 
virtual bool reinitialize_for_new_input () const
 Inform the Job Distributor (August '08 vintage) whether this object needs to be regenerated when the input pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose). More...
 
virtual MoverOP fresh_instance () const
 Generates a new Mover object freshly created with the default ctor. More...
 
MoverStatus get_last_move_status () const
 end parser interface, start Job Distributor interface///////////// More...
 
void reset_status ()
 resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s. More...
 
virtual core::pose::PoseOP get_additional_output ()
 Mechanism by which a mover may return multiple output poses from a single input pose. More...
 
void set_type (std::string const &setting)
 Set the 'type' string. More...
 
std::string get_type () const
 
void type (const std::string &type_in)
 Set the 'type' string. More...
 
std::string const & type () const
 Get the set 'type' string. More...
 
virtual void set_input_pose (PoseCOP pose)
 setter for poses contained for rms More...
 
virtual void set_native_pose (PoseCOP pose)
 setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...
 
PoseCOP get_input_pose () const
 
PoseCOP get_native_pose () const
 
virtual void parse_my_tag (TagCOP tag, basic::datacache::DataMap &data)
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () const
 
virtual void set_current_tag (std::string const &new_tag)
 
std::string get_current_tag () const
 A tag is a unique identifier used to identify structures produced by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor. More...
 
virtual void show (std::ostream &output=std::cout) const
 Outputs details about the Mover, including current settings. More...
 
virtual core::Real last_proposal_density_ratio ()
 
virtual void clear_info ()
 Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file. More...
 
virtual Stringsinfo ()
 non-const accessor More...
 
virtual Strings const & info () const
 const accessor 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...
 

Private Member Functions

void init ()
 
void repulsive_ramp (core::pose::Pose &pose_in, loops::Loops loops_in)
 

Private Attributes

bool user_defined_
 
bool benchmark_
 
core::Size rep_ramp_cycles_
 
core::Real rot_mag_
 
core::Real trans_mag_
 
core::Size num_repeats_
 
core::scoring::ScoreFunctionOP dock_scorefxn_
 
core::scoring::ScoreFunctionOP pack_scorefxn_
 
docking::DockJumps jump_
 
core::pack::task::TaskFactoryOP tf_
 
core::kinematics::MoveMapOP movemap_
 
bool sc_min_
 
bool rt_min_
 

Additional Inherited Members

- Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagCOP TagCOP
 
typedef core::pose::Pose Pose
 
typedef core::pose::PoseCOP PoseCOP
 
typedef std::list< std::string > Strings
 
- Static Public Member Functions inherited from protocols::moves::Mover
static std::string name ()
 
static void register_options ()
 Overload this static method if you access options within the mover. More...
 
- Protected Member Functions inherited from protocols::moves::Mover
void set_last_move_status (MoverStatus status)
 nonvirtual setter for MoverStatus last_status_. Protected means that only the mover itself will be able to change its own status. The job distributor (august 08 vintage) is aware of status set with this function and will do what the MoverStatus says. More...
 

Constructor & Destructor Documentation

protocols::antibody::LHRepulsiveRamp::LHRepulsiveRamp ( )

default constructor

protocols::antibody::LHRepulsiveRamp::LHRepulsiveRamp ( docking::DockJumps const  movable_jumps,
core::scoring::ScoreFunctionCOP  dock_scorefxn,
core::scoring::ScoreFunctionCOP  pack_scorefxn 
)

constructor with arguments

References dock_scorefxn_, init(), jump_, pack_scorefxn_, and user_defined_.

protocols::antibody::LHRepulsiveRamp::~LHRepulsiveRamp ( )
overridedefault

default destructor

Member Function Documentation

void protocols::antibody::LHRepulsiveRamp::apply ( core::pose::Pose pose)
overridevirtual

ramping up the fullatom repulsive weight slowly to allow the partners to relieve clashes and make way for each other

This routine is specially targetted to the coupled optimization of docking partners and the loop region. The loop modelling & all previous steps involve mainly centroid mode .On switching on fullatom mode, one is bound to end up with clashes.To relieve the clashes, it is essential to slowly dial up the repulsive weight instead of turning it on to the maximum value in one single step

Parameters
[in]inputpose which is assumed to have a docking fold tree
Global Read: fa_rep : fullatom repulsive weight
Remarks
A particular portion is commented out,which can be uncommented if one uses a low resolution homology model. Check details in the beginning of the commented out region

Implements protocols::moves::Mover.

References benchmark_, dock_scorefxn_, core::scoring::fa_rep, jump_, movemap_, num_repeats_, pack_scorefxn_, rep_ramp_cycles_, rot_mag_, sc_min_, tf_, and protocols::antibody::TR().

protocols::moves::MoverOP protocols::antibody::LHRepulsiveRamp::clone ( ) const
overridevirtual

Return a clone of the Mover object.

clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.

Reimplemented from protocols::moves::Mover.

std::string protocols::antibody::LHRepulsiveRamp::get_name ( ) const
overridevirtual

Each derived class must specify its name. The class name.

Implements protocols::moves::Mover.

void protocols::antibody::LHRepulsiveRamp::init ( void  )
private

References set_default().

Referenced by LHRepulsiveRamp().

void protocols::antibody::LHRepulsiveRamp::repulsive_ramp ( core::pose::Pose pose_in,
loops::Loops  loops_in 
)
private
void protocols::antibody::LHRepulsiveRamp::set_default ( )
void protocols::antibody::LHRepulsiveRamp::set_dock_jump ( docking::DockJumps  jump)

References jump_.

void protocols::antibody::LHRepulsiveRamp::set_dock_score_func ( core::scoring::ScoreFunctionCOP  dock_scorefxn)
inline

References dock_scorefxn_.

void protocols::antibody::LHRepulsiveRamp::set_move_map ( core::kinematics::MoveMapCOP  movemap)

References movemap_.

void protocols::antibody::LHRepulsiveRamp::set_pack_score_func ( core::scoring::ScoreFunctionCOP  pack_scorefxn)
inline

References pack_scorefxn_.

core::Real protocols::antibody::LHRepulsiveRamp::set_rot_mag ( core::Real  rot_mag)
inline

References rot_mag_.

void protocols::antibody::LHRepulsiveRamp::set_rt_min ( bool  rt_min)
inline

References rt_min_.

void protocols::antibody::LHRepulsiveRamp::set_sc_min ( bool  sc_min)
inline

References sc_min_.

void protocols::antibody::LHRepulsiveRamp::set_task_factory ( core::pack::task::TaskFactoryCOP  tf)

References tf_.

core::Real protocols::antibody::LHRepulsiveRamp::set_trans_mag ( core::Real  trans_mag)
inline

References trans_mag_.

Member Data Documentation

bool protocols::antibody::LHRepulsiveRamp::benchmark_
private

Referenced by apply(), and set_default().

core::scoring::ScoreFunctionOP protocols::antibody::LHRepulsiveRamp::dock_scorefxn_
private
docking::DockJumps protocols::antibody::LHRepulsiveRamp::jump_
private
core::kinematics::MoveMapOP protocols::antibody::LHRepulsiveRamp::movemap_
private

Referenced by apply(), and set_move_map().

core::Size protocols::antibody::LHRepulsiveRamp::num_repeats_
private

Referenced by apply(), and set_default().

core::scoring::ScoreFunctionOP protocols::antibody::LHRepulsiveRamp::pack_scorefxn_
private
core::Size protocols::antibody::LHRepulsiveRamp::rep_ramp_cycles_
private

Referenced by apply(), and set_default().

core::Real protocols::antibody::LHRepulsiveRamp::rot_mag_
private

Referenced by apply(), set_default(), and set_rot_mag().

bool protocols::antibody::LHRepulsiveRamp::rt_min_
private

Referenced by set_default(), and set_rt_min().

bool protocols::antibody::LHRepulsiveRamp::sc_min_
private

Referenced by apply(), set_default(), and set_sc_min().

core::pack::task::TaskFactoryOP protocols::antibody::LHRepulsiveRamp::tf_
private

Referenced by apply(), and set_task_factory().

core::Real protocols::antibody::LHRepulsiveRamp::trans_mag_
private

Referenced by set_default(), and set_trans_mag().

bool protocols::antibody::LHRepulsiveRamp::user_defined_
private

Referenced by LHRepulsiveRamp(), and set_default().


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