core.h File Reference

#include <mpi.h>
#include <yaxt.h>
#include "ppm/symprefix.h"

Include dependency graph for core.h:

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

Go to the source code of this file.

Macros
#define	__attribute__(x)   /*NOTHING*/
#define	UNUSED(x)   (void)(x)

Typedefs
typedef void(*)(MPI_Comm comm, const char *msg, const char *source, int line) symprefi	(abort_func)) ((noreturn))

Functions
void symprefix	abort (MPI_Comm comm, const char *msg, const char *source, int line) __attribute__((noreturn))
void symprefix	abort_message (char const *msg, const char *source, int line)
void symprefix	restore_default_abort_handler (void)
void symprefix	set_abort_handler (symprefix(abort_func) custom_abort)
	symprefix (abort_func) symprefix(get_abort_handler)(void)
void symprefix	set_default_comm (MPI_Comm comm)
int symprefix	mpi_calls_are_allowed (void)

Detailed Description

--- interface to user-adjustable core routines of scales ppm

Copyright

(C) 2010 Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Author

Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Definition in file core.h.

Macro Definition Documentation

__attribute__

#define __attribute__

(

x

)

/*NOTHING*/

Definition at line 70 of file core.h.

UNUSED

#define UNUSED

(

x

)

(void)(x)

Definition at line 73 of file core.h.

Typedef Documentation

(abort_func)

typedef void(*)(MPI_Comm comm, const char *msg, const char *source, int line) symprefi (abort_func)) ((noreturn))

functions used as error handler must conform to this interface

Definition at line 78 of file core.h.

Function Documentation

abort()

void symprefix abort	(	MPI_Comm	comm,
		const char *	msg,
		const char *	source,
		int	line )

Calls the currently set abort handler (symprefix(abort_default) by default)

Parameters

[in]	comm	MPI communicator used to call MPI_Abort
[in]	msg	message text to print
[in]	source	string describing source file name
[in]	line	line number of caller

Here is the caller graph for this function:

abort_message()

void symprefix abort_message	(	char const *	msg,
		const char *	source,
		int	line )

Call the symprefix(abort) function (providing the default communicator for the comm argument).

Parameters

msg	message text to print
source	string describing source file name
line	line number of caller

Definition at line 100 of file core.c.

Here is the caller graph for this function:

mpi_calls_are_allowed()

int symprefix mpi_calls_are_allowed

(

void

)

checks whether MPI calls are allowed

Definition at line 126 of file core.c.

Here is the caller graph for this function:

restore_default_abort_handler()

void symprefix restore_default_abort_handler

(

void

)

Restore default abort handler.

Definition at line 106 of file core.c.

Here is the call graph for this function:

set_abort_handler()

void symprefix set_abort_handler

(

symprefix(abort_func)

custom_abort

)

Set custom abort handler.

Parameters

[in]

custom_abort

custom abort handler

Definition at line 112 of file core.c.

set_default_comm()

void symprefix set_default_comm ( MPI_Comm comm )

extern

change default communicator object

Definition at line 72 of file core.c.

symprefix()

symprefix

(

abort_func

)

Get abort handler.

Returns

currently set abort handler

Get default abort handler.

Returns

currently set abort handler