Yet Another eXchange Tool 0.11.2
Loading...
Searching...
No Matches
xt_core.h File Reference

base definitions header file More...

#include <inttypes.h>
#include <limits.h>
#include <mpi.h>
Include dependency graph for xt_core.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  Xt_pos_ext
 
struct  Xt_offset_ext
 
struct  Xt_aoffset_ext
 
struct  Xt_com_list
 

Macros

#define Xt_int_dt   (XT_INT_MPIDT)
 
#define Xt_uint_dt   (XT_UINT_MPIDT)
 
#define XT_INT_MAX   CONF_XT_INT_MAX
 
#define XT_INT_MIN   CONF_XT_INT_MIN
 
#define XT_INT_FMT   CONF_XT_INT_FMT
 

Typedefs

typedef XT_INT Xt_int
 
typedef unsigned XT_INT Xt_uint
 
typedef uint64_t Xt_uid
 
typedef struct Xt_idxlist_Xt_idxlist
 
typedef struct Xt_xmap_Xt_xmap
 
typedef struct Xt_redist_Xt_redist
 

Functions

void xt_initialize (MPI_Comm default_comm)
 
void xt_finalize (void)
 
int xt_initialized (void)
 
int xt_finalized (void)
 

Detailed Description

base definitions header file

contains types used throughout the library and general initialization

Author
Jörg Behrens behre.nosp@m.ns@d.nosp@m.krz.d.nosp@m.e Moritz Hanke hanke.nosp@m.@dkr.nosp@m.z.de Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Definition in file xt_core.h.

Macro Definition Documentation

◆ Xt_int_dt

#define Xt_int_dt   (XT_INT_MPIDT)

Definition at line 73 of file xt_core.h.

◆ XT_INT_FMT

#define XT_INT_FMT   CONF_XT_INT_FMT

Use this in calls to printf, scanf etc. for data of type Xt_int

Definition at line 82 of file xt_core.h.

◆ XT_INT_MAX

#define XT_INT_MAX   CONF_XT_INT_MAX

Definition at line 77 of file xt_core.h.

◆ XT_INT_MIN

#define XT_INT_MIN   CONF_XT_INT_MIN

Definition at line 78 of file xt_core.h.

◆ Xt_uint_dt

#define Xt_uint_dt   (XT_UINT_MPIDT)

Definition at line 75 of file xt_core.h.

Typedef Documentation

◆ Xt_idxlist

typedef struct Xt_idxlist_* Xt_idxlist

Definition at line 84 of file xt_core.h.

◆ Xt_int

typedef XT_INT Xt_int

Distributed elements are enumerated with numbers of this signed integral type.

Definition at line 72 of file xt_core.h.

◆ Xt_redist

typedef struct Xt_redist_* Xt_redist

Definition at line 86 of file xt_core.h.

◆ Xt_uid

typedef uint64_t Xt_uid

Definition at line 76 of file xt_core.h.

◆ Xt_uint

typedef unsigned XT_INT Xt_uint

Definition at line 74 of file xt_core.h.

◆ Xt_xmap

typedef struct Xt_xmap_* Xt_xmap
Examples
test_xmap_intersection_parallel.c.

Definition at line 85 of file xt_core.h.

Function Documentation

◆ xt_finalize()

void xt_finalize ( void )

finalize library

Note
this call only deallocates resources allocated via xt_initialize and not objects explicitly created by xt_*_new calls.
Examples
test_idxempty.c, test_idxlist_collection.c, test_idxmod.c, test_idxsection.c, test_idxstripes.c, test_idxvec.c, test_initialized_finalized.c, test_mpi_generate_datatype.c, test_redist_collection.c, test_redist_collection_parallel.c, test_redist_collection_static.c, test_redist_collection_static_parallel.c, test_redist_p2p.c, test_redist_p2p_parallel.c, test_redist_repeat.c, test_redist_repeat_parallel.c, test_redist_single_array_base.c, test_redist_single_array_base_parallel.c, test_request_parallel.c, test_uid.c, test_xmap_all2all_fail.c, test_xmap_common.c, test_xmap_common_parallel.c, test_xmap_dist_dir_intercomm_parallel.c, and test_xmap_intersection_parallel.c.

Definition at line 92 of file xt_init.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ xt_finalized()

int xt_finalized ( void )
Returns
1 if xt_finalized has been called, zero otherwise
Examples
test_initialized_finalized.c.

Definition at line 191 of file xt_core_f.f90.

Here is the caller graph for this function:

◆ xt_initialize()

void xt_initialize ( MPI_Comm default_comm)

initialize library

Parameters
[in]default_commcommunicator to use for collective aborts
Examples
rrobin.c, test_idxempty.c, test_idxlist_collection.c, test_idxmod.c, test_idxsection.c, test_idxstripes.c, test_idxvec.c, test_initialized_finalized.c, test_mpi_generate_datatype.c, test_redist_collection.c, test_redist_collection_parallel.c, test_redist_collection_static.c, test_redist_collection_static_parallel.c, test_redist_p2p.c, test_redist_p2p_parallel.c, test_redist_repeat.c, test_redist_repeat_parallel.c, test_redist_single_array_base.c, test_redist_single_array_base_parallel.c, test_request_parallel.c, test_uid.c, test_xmap_all2all_fail.c, test_xmap_common.c, test_xmap_common_parallel.c, and test_xmap_intersection_parallel.c.

Definition at line 70 of file xt_init.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ xt_initialized()

int xt_initialized ( void )
Returns
1 if xt_initialize has been called, zero otherwise
Examples
test_initialized_finalized.c.

Definition at line 186 of file xt_core_f.f90.

Here is the caller graph for this function: