NewMadeleine

Documentation

nm_mpi_config.h File Reference

declarations for MPI environmental management More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define MPI_VERSION   4
 
#define MPI_SUBVERSION   0
 

Functions

Functions: Environmental management
int MPI_Init (int *argc, char ***argv)
 This routine must be called before any other MPI routine. More...
 
int MPI_Init_thread (int *argc, char ***argv, int required, int *provided)
 The following function may be used to initialize MPI, and initialize the MPI thread environment, instead of MPI_Init(). More...
 
int MPI_Query_thread (int *provided)
 Return the level of thread support provided by the MPI library. More...
 
int MPI_Initialized (int *flag)
 Indicates whether MPI_Init has been called. More...
 
int MPI_Finalize (void)
 This routine must be called by each process before it exits. More...
 
int MPI_Finalized (int *flag)
 Indicates whether MPI_Finalize has been called. More...
 
int MPI_Abort (MPI_Comm comm, int errorcode)
 This routine makes a `‘best attempt’' to abort all tasks in the group of comm. More...
 
int MPI_Get_processor_name (char *name, int *resultlen)
 This routine returns the name of the processor on which it was called at the moment of the call. More...
 
double MPI_Wtime (void)
 Returns a floating-point number of seconds, representing elapsed wall-clock time since some time in the past. More...
 
double MPI_Wtick (void)
 Returns the resolution of MPI_Wtime() in seconds. More...
 
int MPI_Error_string (int errorcode, char *string, int *resultlen)
 Returns the error string associated with an error code or class. More...
 
int MPI_Error_class (int errorcode, int *errorclass)
 
int MPI_Add_error_class (int *errorclass)
 
int MPI_Add_error_code (int errorclass, int *errorcode)
 
int MPI_Add_error_string (int errorcode, const char *string)
 
int MPI_Get_version (int *version, int *subversion)
 Returns the version. More...
 
int MPI_Get_library_version (char *version, int *resultlen)
 Returns the version of madmpi. More...
 
int MPI_Pcontrol (const int level,...)
 
int MPI_Errhandler_create (MPI_Handler_function *function, MPI_Errhandler *errhandler)
 
int MPI_Errhandler_set (MPI_Comm comm, MPI_Errhandler errhandler)
 
int MPI_Errhandler_get (MPI_Comm comm, MPI_Errhandler *errhandler)
 
int MPI_Errhandler_free (MPI_Errhandler *errhandler)
 
int MPI_Comm_create_errhandler (MPI_Comm_errhandler_function *function, MPI_Errhandler *errhandler)
 
int MPI_Comm_set_errhandler (MPI_Comm comm, MPI_Errhandler errhandler)
 
int MPI_Comm_get_errhandler (MPI_Comm comm, MPI_Errhandler *errhandler)
 
int MPI_Comm_call_errhandler (MPI_Comm comm, int errorcode)
 
int MPI_Get_address (void *location, MPI_Aint *address)
 Returns the byte address of location. More...
 
int MPI_Address (void *location, MPI_Aint *address)
 Returns the byte address of location. More...
 
int MPI_Alloc_mem (MPI_Aint size, MPI_Info info, void *baseptr)
 Allocate memory for message passing. More...
 
int MPI_Free_mem (void *base)
 Free memory allocated with MPI_Alloc_mem. More...
 

Detailed Description

declarations for MPI environmental management

Definition in file nm_mpi_config.h.

Macro Definition Documentation

◆ MPI_SUBVERSION

#define MPI_SUBVERSION   0

Definition at line 28 of file nm_mpi_config.h.

◆ MPI_VERSION

#define MPI_VERSION   4

Definition at line 27 of file nm_mpi_config.h.

Function Documentation

◆ MPI_Abort()

int MPI_Abort ( MPI_Comm  comm,
int  errorcode 
)

This routine makes a `‘best attempt’' to abort all tasks in the group of comm.

Parameters
commcommunicator of tasks to abort
errorcodeerror code to return to invoking environment
Returns
MPI status

◆ MPI_Add_error_class()

int MPI_Add_error_class ( int *  errorclass)

◆ MPI_Add_error_code()

int MPI_Add_error_code ( int  errorclass,
int *  errorcode 
)

◆ MPI_Add_error_string()

int MPI_Add_error_string ( int  errorcode,
const char *  string 
)

◆ MPI_Address()

int MPI_Address ( void *  location,
MPI_Aint address 
)

Returns the byte address of location.

Parameters
locationlocation in caller memory
addressaddress of location
Returns
MPI status

◆ MPI_Alloc_mem()

int MPI_Alloc_mem ( MPI_Aint  size,
MPI_Info  info,
void *  baseptr 
)

Allocate memory for message passing.

◆ MPI_Comm_call_errhandler()

int MPI_Comm_call_errhandler ( MPI_Comm  comm,
int  errorcode 
)

◆ MPI_Comm_create_errhandler()

int MPI_Comm_create_errhandler ( MPI_Comm_errhandler_function function,
MPI_Errhandler errhandler 
)

◆ MPI_Comm_get_errhandler()

int MPI_Comm_get_errhandler ( MPI_Comm  comm,
MPI_Errhandler errhandler 
)

◆ MPI_Comm_set_errhandler()

int MPI_Comm_set_errhandler ( MPI_Comm  comm,
MPI_Errhandler  errhandler 
)

◆ MPI_Errhandler_create()

int MPI_Errhandler_create ( MPI_Handler_function function,
MPI_Errhandler errhandler 
)

◆ MPI_Errhandler_free()

int MPI_Errhandler_free ( MPI_Errhandler errhandler)

◆ MPI_Errhandler_get()

int MPI_Errhandler_get ( MPI_Comm  comm,
MPI_Errhandler errhandler 
)

◆ MPI_Errhandler_set()

int MPI_Errhandler_set ( MPI_Comm  comm,
MPI_Errhandler  errhandler 
)

◆ MPI_Error_class()

int MPI_Error_class ( int  errorcode,
int *  errorclass 
)

◆ MPI_Error_string()

int MPI_Error_string ( int  errorcode,
char *  string,
int *  resultlen 
)

Returns the error string associated with an error code or class.

The argument string must represent storage that is at least MPI_MAX_ERROR_STRING characters long.

Parameters
errorcodeerror code returned by an MPI routine
stringtext that corresponds to the errorcode
resultlenlength (in printable characters) of the result returned in string
Returns
MPI status.

◆ MPI_Finalize()

int MPI_Finalize ( void  )

This routine must be called by each process before it exits.

The call cleans up all MPI state.

Returns
MPI status

◆ MPI_Finalized()

int MPI_Finalized ( int *  flag)

Indicates whether MPI_Finalize has been called.

Parameters
flaga pointer to an int set to 1 if MPI_Finalize has been called, 0 otherwise.

◆ MPI_Free_mem()

int MPI_Free_mem ( void *  base)

Free memory allocated with MPI_Alloc_mem.

◆ MPI_Get_address()

int MPI_Get_address ( void *  location,
MPI_Aint address 
)

Returns the byte address of location.

Parameters
locationlocation in caller memory
addressaddress of location
Returns
MPI status

◆ MPI_Get_library_version()

int MPI_Get_library_version ( char *  version,
int *  resultlen 
)

Returns the version of madmpi.

Parameters
versionmadmpi version string
resultlenresultlen size of version string
Returns
MPI status.

◆ MPI_Get_processor_name()

int MPI_Get_processor_name ( char *  name,
int *  resultlen 
)

This routine returns the name of the processor on which it was called at the moment of the call.

Parameters
nameunique specifier for the actual (as opposed to virtual) node
resultlenlength (in printable characters) of the result returned in name
Returns
MPI status

◆ MPI_Get_version()

int MPI_Get_version ( int *  version,
int *  subversion 
)

Returns the version.

Parameters
versionversion number
subversionsubversion number
Returns
MPI status.

◆ MPI_Init()

int MPI_Init ( int *  argc,
char ***  argv 
)

This routine must be called before any other MPI routine.

It must be called at most once; subsequent calls are erroneous.

Parameters
argca pointer to the process argc.
argva pointer to the process argv.
Returns
MPI status

◆ MPI_Init_thread()

int MPI_Init_thread ( int *  argc,
char ***  argv,
int  required,
int *  provided 
)

The following function may be used to initialize MPI, and initialize the MPI thread environment, instead of MPI_Init().

Parameters
argca pointer to the process argc.
argva pointer to the process argv.
requiredlevel of thread support (integer).
providedlevel of thread support (integer).
Returns
MPI status

◆ MPI_Initialized()

int MPI_Initialized ( int *  flag)

Indicates whether MPI_Init has been called.

Parameters
flaga pointer to an int set to 1 if MPI_Init has been called, 0 otherwise.

◆ MPI_Pcontrol()

int MPI_Pcontrol ( const int  level,
  ... 
)

◆ MPI_Query_thread()

int MPI_Query_thread ( int *  provided)

Return the level of thread support provided by the MPI library.

◆ MPI_Wtick()

double MPI_Wtick ( void  )

Returns the resolution of MPI_Wtime() in seconds.

Returns
resolution of MPI_Wtime() in seconds

◆ MPI_Wtime()

double MPI_Wtime ( void  )

Returns a floating-point number of seconds, representing elapsed wall-clock time since some time in the past.

Returns
floating-point number of seconds