belfem::Communicator Class Reference

Global MPI communicator manager. More...

#include <cl_Communicator.hpp>

Public Member Functions
	Communicator ()
	Communicator (int argc, char **argv)
	~Communicator ()
	Communicator (const Communicator &)=delete
Communicator &	operator= (const Communicator &)=delete
	Communicator (Communicator &&)=delete
Communicator &	operator= (Communicator &&)=delete
void	init (int &argc, char **&argv)
int	finalize ()
COMM_TYPE &	world ()
const std::string &	exec_path ()
const std::string &	workdir ()
const std::string &	argument_string ()
Cell< std::string > &	arguments ()
void	set_arguments (const string &aArguments)
	overrides the argument string assembled by init(); no framework caller today ( the Arguments-object call was retired )
proc_t	rank () const
proc_t	size () const
proc_t	node_size () const
	returns the number of MPI ranks on this node
std::mt19937 &	random ()
int	max_tag () const
Cell< CommunicationObject * > &	objects ()

Detailed Description

Global MPI communicator manager.

See also

BELFEM Communication Module - Usage Guide

Constructor & Destructor Documentation

Communicator() [1/4]

belfem::Communicator::Communicator ( )

inline

Communicator() [2/4]

belfem::Communicator::Communicator	(	int	argc,
		char **	argv )

~Communicator()

belfem::Communicator::~Communicator

(

)

Communicator() [3/4]

belfem::Communicator::Communicator ( const Communicator & )

delete

Communicator() [4/4]

belfem::Communicator::Communicator ( Communicator && )

delete

Member Function Documentation

argument_string()

const std::string & belfem::Communicator::argument_string

(

)

arguments()

Cell< std::string > & belfem::Communicator::arguments

(

)

exec_path()

const std::string & belfem::Communicator::exec_path

(

)

finalize()

int belfem::Communicator::finalize

(

)

init()

void belfem::Communicator::init	(	int &	argc,
		char **&	argv )

max_tag()

int belfem::Communicator::max_tag ( ) const

inline

node_size()

proc_t belfem::Communicator::node_size ( ) const

inline

returns the number of MPI ranks on this node

objects()

Cell< CommunicationObject * > & belfem::Communicator::objects ( )

inline

operator=() [1/2]

Communicator & belfem::Communicator::operator= ( Communicator && )

delete

operator=() [2/2]

Communicator & belfem::Communicator::operator= ( const Communicator & )

delete

random()

std::mt19937 & belfem::Communicator::random ( )

inline

rank()

proc_t belfem::Communicator::rank ( ) const

inline

set_arguments()

void belfem::Communicator::set_arguments

(

const string &

aArguments

)

overrides the argument string assembled by init(); no framework caller today ( the Arguments-object call was retired )

Parameters

aArguments

size()

proc_t belfem::Communicator::size ( ) const

inline

workdir()

const std::string & belfem::Communicator::workdir

(

)

world()

COMM_TYPE & belfem::Communicator::world

(

)

---

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

• src/comm/cl_Communicator.hpp
• src/comm/cl_Communicator.cpp