colvarproxy_replicas Class Reference

Methods for multiple-replica communication. More...

#include <colvarproxy_replicas.h>

Inheritance diagram for colvarproxy_replicas:

Public Member Functions
	colvarproxy_replicas ()
	Constructor.
virtual	~colvarproxy_replicas ()
	Destructor.
virtual void	set_replicas_mpi_communicator (replicas_mpi_comm_t comm)
	Set the multiple replicas communicator.
virtual int	check_replicas_enabled ()
	Indicate if multi-replica support is available and active. More...
virtual int	replica_index ()
	Index of this replica. More...
virtual int	num_replicas ()
	Total number of replicas. More...
virtual void	replica_comm_barrier ()
	Synchronize replica with others. More...
virtual int	replica_comm_recv (char *msg_data, int buf_len, int src_rep)
	Receive data from other replica. More...
virtual int	replica_comm_send (char *msg_data, int msg_len, int dest_rep)
	Send data to other replica. More...

Protected Attributes
replicas_mpi_comm_t	replicas_mpi_comm
	MPI communicator containint 1 root proc from each world.
int	replicas_mpi_rank = 0
	Index (rank) of this replica in the MPI implementation.
int	replicas_mpi_num = 1
	Number of replicas in the MPI implementation.

Detailed Description

Methods for multiple-replica communication.

Member Function Documentation

check_replicas_enabled()

int colvarproxy_replicas::check_replicas_enabled ( )

virtual

Indicate if multi-replica support is available and active.

Reimplemented in colvarproxy_namd.

num_replicas()

int colvarproxy_replicas::num_replicas ( )

virtual

Total number of replicas.

Reimplemented in colvarproxy_namd.

replica_comm_barrier()

void colvarproxy_replicas::replica_comm_barrier ( )

virtual

Synchronize replica with others.

Reimplemented in colvarproxy_namd.

replica_comm_recv()

int colvarproxy_replicas::replica_comm_recv ( char *  msg_data, int  buf_len, int  src_rep  )

virtual

Receive data from other replica.

Reimplemented in colvarproxy_namd.

replica_comm_send()

int colvarproxy_replicas::replica_comm_send ( char *  msg_data, int  msg_len, int  dest_rep  )

virtual

Send data to other replica.

Reimplemented in colvarproxy_namd.

replica_index()

int colvarproxy_replicas::replica_index ( )

virtual

Index of this replica.

Reimplemented in colvarproxy_namd.

---

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

• colvarproxy_replicas.h
• colvarproxy_replicas.cpp