Collective Variables Module - Developer Documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
colvarproxy_replicas Class Reference

Methods for multiple-replica communication. More...

#include <colvarproxy.h>

Inheritance diagram for colvarproxy_replicas:
Inheritance graph
[legend]

Public Member Functions

 colvarproxy_replicas ()
 Constructor.
 
virtual ~colvarproxy_replicas ()
 Destructor.
 
virtual int replica_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...
 

Detailed Description

Methods for multiple-replica communication.

Member Function Documentation

◆ num_replicas()

int colvarproxy_replicas::num_replicas ( )
virtual

Total number of replicas.

Reimplemented in colvarproxy_lammps, and colvarproxy_namd.

◆ replica_comm_barrier()

void colvarproxy_replicas::replica_comm_barrier ( )
virtual

Synchronize replica with others.

Reimplemented in colvarproxy_lammps, and 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_lammps, and 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_lammps, and colvarproxy_namd.

◆ replica_enabled()

int colvarproxy_replicas::replica_enabled ( )
virtual

Indicate if multi-replica support is available and active.

Reimplemented in colvarproxy_lammps, and colvarproxy_namd.

◆ replica_index()

int colvarproxy_replicas::replica_index ( )
virtual

Index of this replica.

Reimplemented in colvarproxy_lammps, and colvarproxy_namd.


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