ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
Communicator Struct Reference

#include <communication.hpp>

Public Member Functions

 Communicator ()
 
void init_comm_cart ()
 
void full_initialization ()
 
Utils::Vector3i calc_node_index () const
 Calculate the node index in the Cartesian topology.
 
void set_node_grid (Utils::Vector3i const &value)
 Set new Cartesian topology.
 

Public Attributes

boost::mpi::communicator & comm
 
Utils::Vector3i node_grid
 
int & this_node
 The MPI rank.
 
int size
 The MPI world size.
 

Detailed Description

Definition at line 62 of file core/communication.hpp.

Constructor & Destructor Documentation

◆ Communicator()

Communicator::Communicator ( )

Definition at line 92 of file communication.cpp.

Member Function Documentation

◆ calc_node_index()

Utils::Vector3i Communicator::calc_node_index ( ) const

Calculate the node index in the Cartesian topology.

Definition at line 116 of file communication.cpp.

References comm, and this_node.

Referenced by System::System::update_local_geo().

◆ full_initialization()

void Communicator::full_initialization ( )

Definition at line 103 of file communication.cpp.

References init_comm_cart(), node_grid, size, and this_node.

Referenced by Communication::init().

◆ init_comm_cart()

void Communicator::init_comm_cart ( )

Definition at line 95 of file communication.cpp.

References Utils::Mpi::cart_create(), comm, node_grid, and this_node.

Referenced by full_initialization(), and set_node_grid().

◆ set_node_grid()

void Communicator::set_node_grid ( Utils::Vector3i const &  value)

Set new Cartesian topology.

Definition at line 111 of file communication.cpp.

References init_comm_cart(), and node_grid.

Referenced by ScriptInterface::CellSystem::CellSystem::CellSystem().

Member Data Documentation

◆ comm

boost::mpi::communicator& Communicator::comm

Definition at line 63 of file core/communication.hpp.

Referenced by calc_node_index(), and init_comm_cart().

◆ node_grid

◆ size

int Communicator::size

The MPI world size.

Definition at line 68 of file core/communication.hpp.

Referenced by cuda_gather_gpus(), and full_initialization().

◆ this_node

int& Communicator::this_node

The MPI rank.

Definition at line 66 of file core/communication.hpp.

Referenced by calc_node_index(), full_initialization(), and init_comm_cart().


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