artdaq_mpich_plugin  v1_00_02
artdaq::MPISentry Class Reference

The MPISentry class initializes and finalizes the MPI context that the artdaq applciations run in. More...

#include <artdaq-mpich-plugin/Application/MPISentry.hh>

Public Member Functions

 MPISentry (int *argc_ptr, char ***argv_ptr)
 MPISentry Constructor. More...
 
 MPISentry (int *argc_ptr, char ***argv_ptr, int threading_level)
 MPISentry Constructor. More...
 
 MPISentry (int *argc_ptr, char ***argv_ptr, int threading_level, artdaq::TaskType type, MPI_Comm &local_group_comm)
 MPISentry Constructor. More...
 
 ~MPISentry ()
 MPISentry Destructor. Calls MPI_Finalize.
 
int threading_level () const
 Get the actual threading level. More...
 
int rank () const
 Get the MPI rank of the application. More...
 
int procs () const
 The number of processes in the MPI context. More...
 

Detailed Description

The MPISentry class initializes and finalizes the MPI context that the artdaq applciations run in.

Definition at line 15 of file MPISentry.hh.

Constructor & Destructor Documentation

artdaq::MPISentry::MPISentry ( int *  argc_ptr,
char ***  argv_ptr 
)

MPISentry Constructor.

Parameters
argc_ptrPointer to the main argc
argv_ptrPointer to the main argv

Definition at line 10 of file MPISentry.cc.

artdaq::MPISentry::MPISentry ( int *  argc_ptr,
char ***  argv_ptr,
int  threading_level 
)

MPISentry Constructor.

Parameters
argc_ptrPointer to the main argc
argv_ptrPointer to the main argv
threading_levelRequested MPI threading level

Definition at line 21 of file MPISentry.cc.

artdaq::MPISentry::MPISentry ( int *  argc_ptr,
char ***  argv_ptr,
int  threading_level,
artdaq::TaskType  type,
MPI_Comm &  local_group_comm 
)

MPISentry Constructor.

Parameters
argc_ptrPointer to the main argc
argv_ptrPointer to the main argv
threading_levelRequested MPI threading level
typeThe application type of this application.
local_group_commThe local communicatior for this application

Definition at line 49 of file MPISentry.cc.

Member Function Documentation

int artdaq::MPISentry::procs ( ) const

The number of processes in the MPI context.

Returns
The number of processes in the MPI context

Definition at line 120 of file MPISentry.cc.

int artdaq::MPISentry::rank ( ) const

Get the MPI rank of the application.

Returns
The MPI rank of the application

Definition at line 113 of file MPISentry.cc.

int artdaq::MPISentry::threading_level ( ) const

Get the actual threading level.

Returns
The actual threading level provided by MPI

Definition at line 106 of file MPISentry.cc.


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