interp_method_check.h File Reference

#include "interpolation/methods/interp_method.h"

Include dependency graph for interp_method_check.h:

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

Go to the source code of this file.

Data Structures
struct	yac_interp_method_check_config

Macros
#define	YAC_INTERP_CHECK_CONSTRUCTOR_KEY_DEFAULT   ("")
#define	YAC_INTERP_CHECK_DO_SEARCH_KEY_DEFAULT   ("")

Typedefs
typedef void(*	func_constructor) (void *user_data)
typedef void(*	func_do_search) (yac_int const *global_ids, double const (*coordinates_xyz)[3], size_t count, void *user_data)

Functions
struct interp_method *	yac_interp_method_check_new (func_constructor constructor_callback, void *constructor_user_data, func_do_search do_search_callback, void *do_search_user_data)
void	yac_interp_method_check_add_constructor_callback (func_constructor constructor_callback, void *user_data, char const *key)
void	yac_interp_method_check_get_constructor_callback (char const *key, func_constructor *constructor_callback, void **user_data)
void	yac_interp_method_check_add_do_search_callback (func_do_search do_search_callback, void *user_data, char const *key)
void	yac_interp_method_check_get_do_search_callback (char const *key, func_do_search *do_search_callback, void **user_data)
void	yac_interp_method_check_buf_free ()
struct yac_interp_method_config *	yac_interp_method_config_check_unpack (void *buffer, int buffer_size, int *position, MPI_Comm comm)
	Unpacks a check interpolation method configuration from a buffer.
struct yac_interp_method_config *	yac_interp_method_config_default_check_new (void)
	Creates a check interpolation method configuration with default parameters.

Macro Definition Documentation

YAC_INTERP_CHECK_CONSTRUCTOR_KEY_DEFAULT

#define YAC_INTERP_CHECK_CONSTRUCTOR_KEY_DEFAULT   ("")

Definition at line 12 of file interp_method_check.h.

YAC_INTERP_CHECK_DO_SEARCH_KEY_DEFAULT

#define YAC_INTERP_CHECK_DO_SEARCH_KEY_DEFAULT   ("")

Definition at line 13 of file interp_method_check.h.

Typedef Documentation

func_constructor

typedef void(* func_constructor) (void *user_data)

Definition at line 15 of file interp_method_check.h.

func_do_search

typedef void(* func_do_search) (yac_int const *global_ids, double const(*coordinates_xyz)[3], size_t count, void *user_data)

Definition at line 16 of file interp_method_check.h.

Function Documentation

yac_interp_method_check_add_constructor_callback()

void yac_interp_method_check_add_constructor_callback	(	func_constructor	constructor_callback,
		void *	user_data,
		char const *	key )

sets a constructor_callback that can afterwards be retrieved by yac_interp_method_check_get_constructor_callback

Parameters

[in]	constructor_callback	pointer to a constructor_callback routine
[in]	user_data	pointer to user data
[in]	key	string that can afterwards be used to retrieve the pointer

Definition at line 217 of file interp_method_check.c.

Here is the call graph for this function:

yac_interp_method_check_add_do_search_callback()

void yac_interp_method_check_add_do_search_callback	(	func_do_search	do_search_callback,
		void *	user_data,
		char const *	key )

sets a do_search_callback that can afterwards be retrieved by yac_interp_method_check_get_do_search_callback

Parameters

[in]	do_search_callback	pointer to a do_search_callback routine
[in]	user_data	pointer to user data
[in]	key	string that can afterwards be used to retrieve the pointer

Definition at line 234 of file interp_method_check.c.

Here is the call graph for this function:

yac_interp_method_check_buf_free()

void yac_interp_method_check_buf_free

(

)

free internal array with provided pointers to callback routines

Definition at line 250 of file interp_method_check.c.

Here is the caller graph for this function:

yac_interp_method_check_get_constructor_callback()

void yac_interp_method_check_get_constructor_callback	(	char const *	key,
		func_constructor *	constructor_callback,
		void **	user_data )

retrieves a constructor_callback pointer that was set by yac_interp_method_check_add_constructor_callback

Parameters

[in]	key	string to identify a pointer that was previously set
[out]	constructor_callback	pointer to constructor_callback routine
[out]	user_data	pointer to user data

Definition at line 225 of file interp_method_check.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_interp_method_check_get_do_search_callback()

void yac_interp_method_check_get_do_search_callback	(	char const *	key,
		func_do_search *	do_search_callback,
		void **	user_data )

retrieves a do_search_callback pointer that was set by yac_interp_method_check_add_do_search_callback

Parameters

[in]	key	string to identify a pointer that was previously set
[out]	do_search_callback	pointer to do_search_callback routine
[out]	user_data	pointer to user data

Definition at line 242 of file interp_method_check.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_interp_method_check_new()

struct interp_method * yac_interp_method_check_new	(	func_constructor	constructor_callback,
		void *	constructor_user_data,
		func_do_search	do_search_callback,
		void *	do_search_user_data )

constructor for an interpolation method of type interp_method_check

Parameters

[in]	constructor_callback	pointer to routine that is called in yac_interp_method_check_new
[in]	constructor_user_data	pointer passed to constructor_callback when it is called
[in]	do_search_callback	pointer to routine that is to be called when the do_search routine of this interp_method is called
[in]	do_search_user_data	pointer passed to do_search_callback when it is called

Returns

returns a pointer to an interpolation method

Definition at line 73 of file interp_method_check.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_interp_method_config_check_unpack()

struct yac_interp_method_config * yac_interp_method_config_check_unpack	(	void *	buffer,
		int	buffer_size,
		int *	position,
		MPI_Comm	comm )

Unpacks a check interpolation method configuration from a buffer.

Parameters

[in]	buffer	Buffer containing the packed configuration data
[in]	buffer_size	Size of the buffer
[in,out]	position	Current position in the buffer (will be updated)
[in]	comm	MPI communicator for parallel unpacking

Returns

Pointer to the unpacked yac_interp_method_config structure

Definition at line 432 of file interp_method_check.c.

Here is the call graph for this function:

yac_interp_method_config_default_check_new()

struct yac_interp_method_config * yac_interp_method_config_default_check_new

(

void

)

Creates a check interpolation method configuration with default parameters.

Returns

Pointer to the created yac_interp_method_config structure

Definition at line 419 of file interp_method_check.c.