MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
Public Member Functions | List of all members
mfem::MPI_Session Class Reference

A simple convenience class based on the Mpi singleton class above. Preserved for backward compatibility. New code should use Mpi::Init() and other Mpi methods instead. More...

#include <communication.hpp>

Public Member Functions

 MPI_Session ()
 
 MPI_Session (int &argc, char **&argv)
 
int WorldRank () const
 Return MPI_COMM_WORLD's rank.
 
int WorldSize () const
 Return MPI_COMM_WORLD's size.
 
bool Root () const
 Return true if WorldRank() == 0.
 

Detailed Description

A simple convenience class based on the Mpi singleton class above. Preserved for backward compatibility. New code should use Mpi::Init() and other Mpi methods instead.

Definition at line 115 of file communication.hpp.

Constructor & Destructor Documentation

◆ MPI_Session() [1/2]

mfem::MPI_Session::MPI_Session ( )
inline

Definition at line 118 of file communication.hpp.

◆ MPI_Session() [2/2]

mfem::MPI_Session::MPI_Session ( int &  argc,
char **&  argv 
)
inline

Definition at line 119 of file communication.hpp.

Member Function Documentation

◆ Root()

bool mfem::MPI_Session::Root ( ) const
inline

Return true if WorldRank() == 0.

Definition at line 125 of file communication.hpp.

◆ WorldRank()

int mfem::MPI_Session::WorldRank ( ) const
inline

Return MPI_COMM_WORLD's rank.

Definition at line 121 of file communication.hpp.

◆ WorldSize()

int mfem::MPI_Session::WorldSize ( ) const
inline

Return MPI_COMM_WORLD's size.

Definition at line 123 of file communication.hpp.


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