grid_library.h File Reference

#include "grid_constants.h"
#include "grid_sphere_cache.h"
#include <stdbool.h>

Go to the source code of this file.

Data Structures
struct	grid_library_config
	Configuration of the grid library. More...

Enumerations
enum	grid_library_kernel { GRID_COLLOCATE_ORTHO = 0 , GRID_INTEGRATE_ORTHO = 1 , GRID_COLLOCATE_GENERAL = 2 , GRID_INTEGRATE_GENERAL = 3 }
	Various kernels provided by the grid library. More...

Functions
void	grid_library_init (void)
	Initializes the grid library. More...
void	grid_library_finalize (void)
	Finalizes the grid library. More...
void	grid_library_set_config (const enum grid_backend backend, const bool validate, const bool apply_cutoff)
	Configures the grid library. More...
grid_library_config	grid_library_get_config (void)
	Returns the library config. More...
void	grid_library_print_stats (void(*mpi_sum_func)(long *, int), int mpi_comm, void(*print_func)(char *, int), int output_unit)
	Prints statistics gathered by the grid library. More...
grid_sphere_cache *	grid_library_get_sphere_cache (void)
	Returns a pointer to the thread local sphere cache. More...
void	grid_library_counter_add (const int lp, const enum grid_backend backend, const enum grid_library_kernel kern, const int increment)
	Adds given increment to counter specified by lp, backend, and kernel. More...

Enumeration Type Documentation

grid_library_kernel

enum grid_library_kernel

Various kernels provided by the grid library.

Author

Ole Schuett

Enumerator
GRID_COLLOCATE_ORTHO
GRID_INTEGRATE_ORTHO
GRID_COLLOCATE_GENERAL
GRID_INTEGRATE_GENERAL

Definition at line 65 of file grid_library.h.

Function Documentation

grid_library_init()

void grid_library_init

(

void

)

Initializes the grid library.

Author

Ole Schuett

Definition at line 49 of file grid_library.c.

Here is the caller graph for this function:

grid_library_finalize()

void grid_library_finalize

(

void

)

Finalizes the grid library.

Author

Ole Schuett

Definition at line 83 of file grid_library.c.

Here is the call graph for this function:

Here is the caller graph for this function:

grid_library_set_config()

void grid_library_set_config	(	const enum grid_backend	backend,
		const bool	validate,
		const bool	apply_cutoff
	)

Configures the grid library.

Author

Ole Schuett

Definition at line 112 of file grid_library.c.

grid_library_get_config()

grid_library_config grid_library_get_config

(

void

)

Returns the library config.

Author

Ole Schuett

Definition at line 123 of file grid_library.c.

Here is the caller graph for this function:

grid_library_print_stats()

void grid_library_print_stats	(	void(*)(long *, int)	mpi_sum_func,
		const int	mpi_comm,
		void(*)(char *, int)	print_func,
		const int	output_unit
	)

Prints statistics gathered by the grid library.

Author

Ole Schuett

Definition at line 155 of file grid_library.c.

Here is the call graph for this function:

Here is the caller graph for this function:

grid_library_get_sphere_cache()

grid_sphere_cache* grid_library_get_sphere_cache

(

void

)

Returns a pointer to the thread local sphere cache.

Author

Ole Schuett

Definition at line 102 of file grid_library.c.

Here is the caller graph for this function:

grid_library_counter_add()

void grid_library_counter_add	(	const int	lp,
		const enum grid_backend	backend,
		const enum grid_library_kernel	kernel,
		const int	increment
	)

Adds given increment to counter specified by lp, backend, and kernel.

Author

Ole Schuett

Definition at line 129 of file grid_library.c.

Here is the caller graph for this function: