couple_config_config_output.h File Reference

#include "yac_mpi_common.h"
#include "couple_config.h"
#include "couple_config_internal.h"

Include dependency graph for couple_config_config_output.h:

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

Go to the source code of this file.

Data Structures
struct	yac_couple_config_config_output

Functions
void	yac_couple_config_config_output_append (struct yac_couple_config_config_output **config_outputs, size_t *num_config_outputs, char const *filename, enum yac_text_filetype filetype, char const *ref, int include_definitions)
void	yac_couple_config_config_output_free (struct yac_couple_config_config_output *config_output)
void	yac_couple_config_config_outputs_free (struct yac_couple_config_config_output **config_outputs, size_t *num_config_outputs)
enum yac_couple_config_flag_value	yac_couple_config_config_output_get_include_definitions (struct yac_couple_config_config_output const *config_output)
void	yac_couple_config_config_outputs_merge (struct yac_couple_config_config_output **config_outputs, size_t *num_config_outputs, MPI_Comm comm)

Function Documentation

yac_couple_config_config_output_append()

void yac_couple_config_config_output_append	(	struct yac_couple_config_config_output **	config_outputs,
		size_t *	num_config_outputs,
		char const *	filename,
		enum yac_text_filetype	filetype,
		char const *	ref,
		int	include_definitions )

Append a config output entry to the list of config outputs, checking for consistency with existing entries.

Parameters

[in,out]	config_outputs	Config output entries.
[in,out]	num_config_outputs	Current number of config output entries.
[in]	filename	Name of the output file (must not be NULL or empty).
[in]	filetype	Type of the output file.
[in]	ref	Reference name for synchronization (must not be NULL or empty).
[in]	include_definitions	Flag indicating whether to include definitions

Definition at line 15 of file couple_config_config_output.c.

Here is the caller graph for this function:

yac_couple_config_config_output_free()

void yac_couple_config_config_output_free

(

struct yac_couple_config_config_output *

config_output

)

Free a config output entry and all its dynamic data.

Parameters

[in,out]

config_output

Config output entry.

Definition at line 75 of file couple_config_config_output.c.

Here is the caller graph for this function:

yac_couple_config_config_output_get_include_definitions()

enum yac_couple_config_flag_value yac_couple_config_config_output_get_include_definitions

(

struct yac_couple_config_config_output const *

config_output

)

Get the include_definitions flag from a config output entry, returning YAC_COUPLE_CONFIG_FLAG_FALSE as the default when the flag is unset.

Parameters

[in]

config_output

Config output entry.

Returns

include_definitions flag value.

Definition at line 207 of file couple_config_config_output.c.

Here is the caller graph for this function:

yac_couple_config_config_outputs_free()

void yac_couple_config_config_outputs_free	(	struct yac_couple_config_config_output **	config_outputs,
		size_t *	num_config_outputs )

Free all config outputs and their dynamic data from a coupling configuration.

Parameters

[in,out]	config_outputs	Config output entries.
[in,out]	num_config_outputs	Number of config output entries.

Definition at line 217 of file couple_config_config_output.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_config_outputs_merge()

void yac_couple_config_config_outputs_merge	(	struct yac_couple_config_config_output **	config_outputs,
		size_t *	num_config_outputs,
		MPI_Comm	comm )

Synchronize and merge all config output entries across ranks.

Parameters

[in,out]	config_outputs	Config output entries.
[in,out]	num_config_outputs	Number of config output entries.
[in]	comm	MPI communicator.

Definition at line 193 of file couple_config_config_output.c.

Here is the call graph for this function:

Here is the caller graph for this function: