interpolation_gen_config_internal.h File Reference

#include "interpolation/interpolation_gen_config.h"

Include dependency graph for interpolation_gen_config_internal.h:

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

Go to the source code of this file.

Functions
enum yac_interp_weights_reorder_type	yac_interpolation_gen_config_get_reorder (struct yac_interpolation_gen_config const *config)
	Get the configured reordering strategy.
struct yac_collection_selection const *	yac_interpolation_gen_config_get_collection_selection (struct yac_interpolation_gen_config const *config)
	Get the configured collection selection.
double	yac_interpolation_gen_config_get_frac_mask_fallback_value (struct yac_interpolation_gen_config const *config)
	Get the configured fractional mask fallback value.
double	yac_interpolation_gen_config_get_scaling_factor (struct yac_interpolation_gen_config const *config)
	Get the configured scaling factor.
double	yac_interpolation_gen_config_get_scaling_summand (struct yac_interpolation_gen_config const *config)
	Get the configured scaling summand.
const char *	yac_interpolation_gen_config_get_yaxt_exchanger_name (struct yac_interpolation_gen_config const *config)
	Get the configured Yaxt exchanger name.
int	yac_interpolation_gen_config_compare (struct yac_interpolation_gen_config const *a, struct yac_interpolation_gen_config const *b)
	Compare two interpolation configuration structures.
size_t	yac_interpolation_gen_config_get_pack_size (struct yac_interpolation_gen_config const *config, MPI_Comm comm)
	Get the MPI packing size of an interpolation generation configuration.
void	yac_interpolation_gen_config_pack (struct yac_interpolation_gen_config const *config, void *buffer, int buffer_size, int *position, MPI_Comm comm)
	Pack an interpolation generation configuration into an MPI buffer.
struct yac_interpolation_gen_config *	yac_interpolation_gen_config_unpack (void const *buffer, int buffer_size, int *position, MPI_Comm comm)
	Unpack an interpolation generation configuration from an MPI buffer.

Function Documentation

yac_interpolation_gen_config_compare()

int yac_interpolation_gen_config_compare	(	struct yac_interpolation_gen_config const *	a,
		struct yac_interpolation_gen_config const *	b )

Compare two interpolation configuration structures.

Compares two yac_interpolation_gen_config objects and returns an integer describing their relative order.

Rules:

• 0 if both configurations are equivalent or both are NULL
• <0 if a is considered less than b
• >0 if a is considered greater than b

Property: compare(a, b) == -compare(b, a)

Parameters

[in]	a	First configuration selection (may be NULL)
[in]	b	Second configuration selection (may be NULL)

Returns

0 if equal, negative if a<b, positive if a>b

Definition at line 312 of file interpolation_gen_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_interpolation_gen_config_get_collection_selection()

struct yac_collection_selection const * yac_interpolation_gen_config_get_collection_selection

(

struct yac_interpolation_gen_config const *

config

)

Get the configured collection selection.

Parameters

[in]

config

Pointer to a valid configuration structure.

Returns

The collection selection.

Note

The value must have been explicitly set before querying.

Definition at line 255 of file interpolation_gen_config.c.

Here is the caller graph for this function:

yac_interpolation_gen_config_get_frac_mask_fallback_value()

double yac_interpolation_gen_config_get_frac_mask_fallback_value

(

struct yac_interpolation_gen_config const *

config

)

Get the configured fractional mask fallback value.

Parameters

[in]

config

Pointer to a valid configuration structure.

Returns

The fractional mask fallback value.

Definition at line 270 of file interpolation_gen_config.c.

Here is the caller graph for this function:

yac_interpolation_gen_config_get_pack_size()

size_t yac_interpolation_gen_config_get_pack_size	(	struct yac_interpolation_gen_config const *	config,
		MPI_Comm	comm )

Get the MPI packing size of an interpolation generation configuration.

Computes the number of bytes required to pack a yac_interpolation_gen_config structure for MPI communication using yac_interpolation_gen_config_pack.

The returned size accounts for all structure members, including nested objects such as the yac_collection_selection and the optional exchanger name string.

Parameters

[in]	config	Pointer to the configuration structure (must not be NULL)
[in]	comm	MPI communicator used for datatype size computation

Returns

Total number of bytes required to pack the configuration.

Definition at line 368 of file interpolation_gen_config.c.

Here is the call graph for this function:

yac_interpolation_gen_config_get_reorder()

enum yac_interp_weights_reorder_type yac_interpolation_gen_config_get_reorder

(

struct yac_interpolation_gen_config const *

config

)

Get the configured reordering strategy.

Parameters

[in]

config

Pointer to a valid configuration structure.

Returns

The configured reorder type.

Definition at line 244 of file interpolation_gen_config.c.

Here is the caller graph for this function:

yac_interpolation_gen_config_get_scaling_factor()

double yac_interpolation_gen_config_get_scaling_factor

(

struct yac_interpolation_gen_config const *

config

)

Get the configured scaling factor.

Parameters

[in]

config

Pointer to a valid configuration structure.

Returns

The scaling factor.

Definition at line 281 of file interpolation_gen_config.c.

Here is the caller graph for this function:

yac_interpolation_gen_config_get_scaling_summand()

double yac_interpolation_gen_config_get_scaling_summand

(

struct yac_interpolation_gen_config const *

config

)

Get the configured scaling summand.

Parameters

[in]

config

Pointer to a valid configuration structure.

Returns

The scaling summand.

Definition at line 291 of file interpolation_gen_config.c.

Here is the caller graph for this function:

yac_interpolation_gen_config_get_yaxt_exchanger_name()

const char * yac_interpolation_gen_config_get_yaxt_exchanger_name

(

struct yac_interpolation_gen_config const *

config

)

Get the configured Yaxt exchanger name.

Parameters

[in]

config

Pointer to a valid configuration structure.

Returns

Pointer to the configured exchanger name string, or NULL if the default exchanger is used.

Definition at line 301 of file interpolation_gen_config.c.

Here is the caller graph for this function:

yac_interpolation_gen_config_pack()

void yac_interpolation_gen_config_pack	(	struct yac_interpolation_gen_config const *	config,
		void *	buffer,
		int	buffer_size,
		int *	position,
		MPI_Comm	comm )

Pack an interpolation generation configuration into an MPI buffer.

Parameters

[in]	config	Pointer to configuration to pack (must not be NULL)
[in,out]	buffer	Destination buffer for packed data
[in]	buffer_size	Size of buffer in bytes
[in,out]	position	Current position in the buffer (updated)
[in]	comm	MPI communicator used for datatype consistency

Definition at line 389 of file interpolation_gen_config.c.

Here is the call graph for this function:

yac_interpolation_gen_config_unpack()

struct yac_interpolation_gen_config * yac_interpolation_gen_config_unpack	(	void const *	buffer,
		int	buffer_size,
		int *	position,
		MPI_Comm	comm )

Unpack an interpolation generation configuration from an MPI buffer.

Reconstructs a newly allocated yac_interpolation_gen_config structure from a buffer previously filled by yac_interpolation_gen_config_pack.

Parameters

[in]	buffer	Source buffer containing packed data
[in]	buffer_size	Size of the packed buffer in bytes
[in,out]	position	Current position in the buffer (updated)
[in]	comm	MPI communicator used for datatype consistency

Returns

Newly allocated unpacked configuration object.

Definition at line 421 of file interpolation_gen_config.c.

Here is the call graph for this function: