YetAnotherCoupler 2.4.3
Macros | Typedefs | Functions
core.h File Reference
#include <mpi.h>
#include <yaxt.h>
#include "core/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)
 
#define die(msg)    SymPrefix(abort)(SymPrefix(default_comm), (msg), __FILE__, __LINE__)
 

Typedefs

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

Functions

 SymPrefix (abort_func) SymPrefix(abort)
 
void SymPrefix() restore_default_abort_handler (void)
 
MPI_Comm SymPrefix (default_comm)
 
void SymPrefix() abort_default (MPI_Comm comm, const char *msg, const char *source, int line) __attribute__((noreturn))
 
void SymPrefix() set_default_comm (MPI_Comm comm)
 

Detailed Description

— interface to user-adjustable core routines of scales ppm

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 63 of file core.h.

◆ die

#define die (   msg)     SymPrefix(abort)(SymPrefix(default_comm), (msg), __FILE__, __LINE__)

Definition at line 115 of file core.h.

◆ UNUSED

#define UNUSED (   x)    (void)(x)
Examples
test_grid.c, and test_instance_parallel2.c.

Definition at line 66 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 74 of file core.h.

◆ yac_int

typedef Xt_int yac_int
Examples
test_interp_weights_parallel.c, and test_point_sphere_part.c.

Definition at line 69 of file core.h.

Function Documentation

◆ abort_default()

void SymPrefix() abort_default ( MPI_Comm  comm,
const char *  msg,
const char *  source,
int  line 
)

This function prints the message argument and file and line of the error to standard error, and calls either MPI_Abort or abort depending on wether MPI is initialized.

Parameters
commMPI communcator object to use on call to MPI_Abort
msgmessage text to print
sourcestring describing source file name
lineline number of caller

Definition at line 74 of file core.c.

◆ restore_default_abort_handler()

void SymPrefix() restore_default_abort_handler ( void  )

Restore default abort handler.

◆ set_default_comm()

void SymPrefix() set_default_comm ( MPI_Comm  comm)

change default communicator object

Definition at line 68 of file core.c.

Here is the call graph for this function:

◆ SymPrefix() [1/2]

SymPrefix ( abort_func  )

Unless modified, this function pointer will reference PPM_abort_default.

Definition at line 86 of file core.c.

◆ SymPrefix() [2/2]

MPI_Comm SymPrefix ( default_comm  )

communicator object to use by default