Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
protocols::canonical_sampling::AsyncMPITemperingBase Class Referenceabstract

#include <AsyncMPITemperingBase.hh>

Inheritance diagram for protocols::canonical_sampling::AsyncMPITemperingBase:
Inheritance graph
[legend]

Classes

class  ExchangeRequest
 

Public Member Functions

 AsyncMPITemperingBase ()
 
 AsyncMPITemperingBase (AsyncMPITemperingBase const &)
 
AsyncMPITemperingBaseoperator= (AsyncMPITemperingBase const &)
 
 ~AsyncMPITemperingBase () override
 
void apply (core::pose::Pose &) override
 Main Method. More...
 
void initialize_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover, core::Size cycle) override
 callback executed before any Monte Carlo trials More...
 
void initialize_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover, core::Size level, core::Real temperature, core::Size cycle) override
 
void finalize_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover) override
 callback executed after all Monte Carlo trials More...
 
bool finished_simulation (core::Size trials, core::Size ntrials) override
 Return true if the simulation has been completed. More...
 
- Public Member Functions inherited from protocols::canonical_sampling::TemperingBase
 TemperingBase ()
 Default constructor. More...
 
void apply (core::pose::Pose &) override
 No-op implemented only to satisfy the Mover interface. More...
 
std::string get_name () const override
 Return the name of this class. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
 
void initialize_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover, core::Size cycle) override
 Callback executed before any Monte Carlo trials are attempted. More...
 
void initialize_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover, core::Size level, core::Real temperature, core::Size cycle) override
 
void observe_after_metropolis (protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover) override
 Callback executed after the Metropolis criterion is evaluated. More...
 
void finalize_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover) override
 Callback executed after all Monte Carlo trials are completed. More...
 
core::Real temperature () const override
 Return the temperature of the underlying MonteCarlo object. More...
 
core::Real temperature (core::Size level) const override
 Return the temperature of the given level. More...
 
core::Size temperature_level () const override
 Return the current temperature level. More...
 
core::Size n_temp_levels () const override
 Return the number of temperature levels used by this controller. More...
 
- Public Member Functions inherited from protocols::canonical_sampling::TemperatureController
 TemperatureController ()
 Default constructor. More...
 
 TemperatureController (TemperatureController const &)
 Copy constructor. More...
 
TemperatureControlleroperator= (TemperatureController const &)=default
 This has substantially different behavior than the copy constructor. More...
 
bool reinitialize_for_each_job () const override
 Return false. This class does not need to be reinitialized for each job. More...
 
bool reinitialize_for_new_input () const override
 Return false. This class does not need to be reinitialized for new input. More...
 
virtual core::Real temperature_move (core::Real score)=0
 Execute the temperature move. More...
 
virtual core::Real temperature_move (core::pose::Pose &pose)
 Execute a temperature move which depends on the current pose. More...
 
virtual GridCoord level_2_grid_coord (core::Size level) const
 
virtual core::Size exchange_grid_dim () const
 
virtual core::Size nlevels_per_dim (core::Size) const
 
protocols::moves::MonteCarloCOP monte_carlo () const
 Return const access to the MonteCarlo object being controlled. More...
 
virtual void set_monte_carlo (protocols::moves::MonteCarloOP monte_carlo)
 Set the MonteCarlo object to be controlled. More...
 
- Public Member Functions inherited from protocols::canonical_sampling::ThermodynamicObserver
 ThermodynamicObserver ()
 Default constructor. More...
 
 ~ThermodynamicObserver () override
 Destructor. More...
 
void apply (core::pose::Pose &) override
 Callback executed after each move is made. More...
 
virtual bool restart_simulation (core::pose::Pose &, MetropolisHastingsMover &, core::Size &, core::Size &, core::Real &)
 Attempt to restart the last simulation that was recorded by this observer. More...
 
virtual bool requires_pose ()
 Return false if this observer does not require a valid pose. TrialCounterObserver is an example of such an observer. More...
 
- 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 MoverOP clone () const
 Return a clone of the Mover object. 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
 
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...
 

Protected Member Functions

bool time_for_temp_move () override
 Return true if a temperature move should be made on this iteration. More...
 
int rank ()
 
virtual core::Size next_exchange_level () const =0
 
void find_exchange_partner (int &partner, bool &is_master)
 
- Protected Member Functions inherited from protocols::canonical_sampling::TemperingBase
void set_defaults ()
 Help the constructor initialize the object. More...
 
virtual void init_from_options ()
 Assign user-specified command-line values to data members. More...
 
virtual bool initialize_from_file (std::string const &filename)
 Initialize temperatures and weights from a file. More...
 
virtual void write_to_file (std::string const &file_in, std::string const &output_name, utility::vector1< core::Real > const &wcounts)
 Save temperatures and weights to a file. More...
 
bool check_temp_consistency ()
 Assert that the current temperature of the MonteCarlo object agrees with the current temperature level of this object. More...
 
void reset_temp_counter ()
 
core::Size current_temp () const
 Return the current temperature level. Identical to temperature_level() as far as I can tell. More...
 
void clear ()
 Forget all temperature levels and return to an uninitialized state. More...
 
void set_temperatures (utility::vector1< core::Real > const &)
 Explicitly set the temperature levels. More...
 
virtual void set_current_temp (core::Size new_temp)
 Set the temperature to the given level. More...
 
bool stats_line_output () const
 Return true if a statistics summary should be written. More...
 
bool stats_silent_output () const
 Return true if a statistics summary should be inserted into a silent file. More...
 
std::string const & stats_file () const
 Return the name of the silent file into which statistics should be recorded. More...
 
void generate_temp_range (core::Real temp_low, core::Real temp_high, core::Size n_levels, InterpolationType interpolation=linear)
 Explicitly set the temperature levels by interpolating the given parameters. More...
 
MultiTemperatureTrialCountertrial_counter ()
 
- Protected Member Functions inherited from protocols::canonical_sampling::TemperatureController
protocols::moves::MonteCarloOP monte_carlo ()
 Return non-const access to the MonteCarlo object being controlled. 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...
 

Private Types

typedef TemperingBase Parent
 
typedef std::map< core::Size,
ExchangeRequest
ExchangeRequestMap
 
typedef utility::vector1
< std::pair< ExchangeRequest,
ExchangeRequest > > 
MatchList
 

Private Member Functions

void process_match_list (MatchList const &list)
 
void send_swap_invites (ExchangeRequest const &request1, ExchangeRequest const &request2)
 
void process_matching_exchange_requests ()
 
bool receive_exchange_requests ()
 
void remove_cycles_from_request_list ()
 
void start_listening ()
 
void listen_for_rank (int other_rank)
 
void allocate_buffers ()
 
void deallocate_buffers ()
 

Private Attributes

int rank_
 
int comm_size_
 
bool ready_for_exchange_
 
bool finished_
 
int * recv_level_buffer_
 
int * send_level_buffer_
 
int * swap_invite_send_buffer_
 
int * swap_invite_recv_buffer_
 
int * finished_recv_buffer_
 
int * finished_send_buffer_
 
ExchangeRequestMap exchange_requests_
 

Friends

std::ostream & operator<< (std::ostream &os, AsyncMPITemperingBase::ExchangeRequest const &er)
 

Additional Inherited Members

- Public Types inherited from protocols::canonical_sampling::TemperatureController
typedef utility::vector1
< core::Size
GridCoord
 
- 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::canonical_sampling::TemperingBase
static void attributes_for_tempering_base (utility::tag::AttributeList &, utility::tag::XMLSchemaDefinition &)
 
static void register_options ()
 Register the options used by this mover with the global options system. More...
 
- 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 Attributes inherited from protocols::canonical_sampling::TemperingBase
utility::vector1< core::Realtemperatures_
 Temperature levels. More...
 
core::Size temperature_stride_
 Frequency for attempting temperature moves (e.g. once every io_stride_ steps). More...
 
core::Size io_stride_
 Frequency with which statistics should be written (e.g. once every io_stride_ steps). More...
 
bool trust_current_temp_
 If false, look for current temperature in monte_carlo_ before each move. Set to true by default. More...
 
bool stats_line_output_
 If true, a statistics summary will be written. More...
 
bool stats_silent_output_
 If true, the statistics summary will be inserted in a silent file. More...
 
std::string stats_file_
 Name of the silent file used for writing statistics. More...
 
bool instance_initialized_
 If false, init_from_options() will be called before the simulation starts. More...
 
core::Size current_temp_
 Current temperature level. Not the current temperature! More...
 
core::Size temp_trial_count_
 Number of times time_for_temp_move() has been called. This method is meant to be called every time temperature_move() is called. More...
 
MultiTemperatureTrialCounter trial_counter_
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::canonical_sampling::AsyncMPITemperingBase::AsyncMPITemperingBase ( )

References allocate_buffers().

protocols::canonical_sampling::AsyncMPITemperingBase::AsyncMPITemperingBase ( AsyncMPITemperingBase const &  other)

References allocate_buffers().

protocols::canonical_sampling::AsyncMPITemperingBase::~AsyncMPITemperingBase ( )
override

References deallocate_buffers().

Member Function Documentation

void protocols::canonical_sampling::AsyncMPITemperingBase::allocate_buffers ( )
private
void protocols::canonical_sampling::AsyncMPITemperingBase::apply ( core::pose::Pose )
inlineoverridevirtual
void protocols::canonical_sampling::AsyncMPITemperingBase::deallocate_buffers ( )
private
void protocols::canonical_sampling::AsyncMPITemperingBase::finalize_simulation ( core::pose::Pose pose,
protocols::canonical_sampling::MetropolisHastingsMover const &  metropolis_hastings_mover 
)
overridevirtual
void protocols::canonical_sampling::AsyncMPITemperingBase::find_exchange_partner ( int &  partner,
bool is_master 
)
protected

References rank(), and swap_invite_recv_buffer_.

bool protocols::canonical_sampling::AsyncMPITemperingBase::finished_simulation ( core::Size  trials,
core::Size  ntrials 
)
overridevirtual
void protocols::canonical_sampling::AsyncMPITemperingBase::initialize_simulation ( core::pose::Pose pose,
protocols::canonical_sampling::MetropolisHastingsMover const &  metropolis_hastings_mover,
core::Size  cycle 
)
overridevirtual
void protocols::canonical_sampling::AsyncMPITemperingBase::initialize_simulation ( core::pose::Pose pose,
protocols::canonical_sampling::MetropolisHastingsMover const &  metropolis_hastings_mover,
core::Size  level,
core::Real  temperature,
core::Size  cycle 
)
overridevirtual
void protocols::canonical_sampling::AsyncMPITemperingBase::listen_for_rank ( int  other_rank)
private
virtual core::Size protocols::canonical_sampling::AsyncMPITemperingBase::next_exchange_level ( ) const
protectedpure virtual
AsyncMPITemperingBase & protocols::canonical_sampling::AsyncMPITemperingBase::operator= ( AsyncMPITemperingBase const &  other)
void protocols::canonical_sampling::AsyncMPITemperingBase::process_match_list ( MatchList const &  list)
private
void protocols::canonical_sampling::AsyncMPITemperingBase::process_matching_exchange_requests ( )
private
int protocols::canonical_sampling::AsyncMPITemperingBase::rank ( )
inlineprotected
bool protocols::canonical_sampling::AsyncMPITemperingBase::receive_exchange_requests ( )
private
void protocols::canonical_sampling::AsyncMPITemperingBase::remove_cycles_from_request_list ( )
private
void protocols::canonical_sampling::AsyncMPITemperingBase::send_swap_invites ( ExchangeRequest const &  request1,
ExchangeRequest const &  request2 
)
private
void protocols::canonical_sampling::AsyncMPITemperingBase::start_listening ( )
private
bool protocols::canonical_sampling::AsyncMPITemperingBase::time_for_temp_move ( )
overrideprotectedvirtual

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
AsyncMPITemperingBase::ExchangeRequest const &  er 
)
friend

Member Data Documentation

int protocols::canonical_sampling::AsyncMPITemperingBase::comm_size_
private
ExchangeRequestMap protocols::canonical_sampling::AsyncMPITemperingBase::exchange_requests_
private
bool protocols::canonical_sampling::AsyncMPITemperingBase::finished_
private

Referenced by finished_simulation(), and operator=().

int* protocols::canonical_sampling::AsyncMPITemperingBase::finished_recv_buffer_
private
int* protocols::canonical_sampling::AsyncMPITemperingBase::finished_send_buffer_
private
int protocols::canonical_sampling::AsyncMPITemperingBase::rank_
private

Referenced by operator=(), and rank().

bool protocols::canonical_sampling::AsyncMPITemperingBase::ready_for_exchange_
private

Referenced by operator=(), and time_for_temp_move().

int* protocols::canonical_sampling::AsyncMPITemperingBase::recv_level_buffer_
private
int* protocols::canonical_sampling::AsyncMPITemperingBase::send_level_buffer_
private
int* protocols::canonical_sampling::AsyncMPITemperingBase::swap_invite_recv_buffer_
private
int* protocols::canonical_sampling::AsyncMPITemperingBase::swap_invite_send_buffer_
private

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