couple_config.h File Reference

#include "interp_method_avg.h"
#include "interp_method_callback.h"
#include "interp_method_check.h"
#include "interp_method_conserv.h"
#include "interp_method_creep.h"
#include "interp_method_file.h"
#include "interp_method_fixed.h"
#include "interp_method_hcsbb.h"
#include "interp_method_ncc.h"
#include "interp_method_nnn.h"
#include "interp_method_spmap.h"
#include "interp_stack_config.h"

Include dependency graph for couple_config.h:

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

Go to the source code of this file.

Macros
#define	MISSING_DEFINITION_IS_FATAL_DEFAULT_VALUE   (1)

Enumerations
enum	yac_time_unit_type {   C_MILLISECOND = 0 , C_SECOND = 1 , C_MINUTE = 2 , C_HOUR = 3 ,   C_DAY = 4 , C_MONTH = 5 , C_YEAR = 6 , C_ISO_FORMAT = 7 ,   TIME_UNIT_UNDEFINED }
enum	yac_reduction_type {   TIME_NONE = 0 , TIME_ACCUMULATE = 1 , TIME_AVERAGE = 2 , TIME_MINIMUM = 3 ,   TIME_MAXIMUM = 4 }
enum	yac_text_filetype { YAC_TEXT_FILETYPE_YAML = 0 , YAC_TEXT_FILETYPE_JSON = 1 }

Functions
struct yac_couple_config *	yac_couple_config_new ()
void	yac_couple_config_delete (struct yac_couple_config *couple_config)
char *	yac_couple_config_get_start_datetime (struct yac_couple_config *couple_config)
char *	yac_couple_config_get_end_datetime (struct yac_couple_config *couple_config)
void	yac_couple_config_set_datetime (struct yac_couple_config *couple_config, char const *start, char const *end)
size_t	yac_couple_config_get_num_components (struct yac_couple_config *couple_config)
int	yac_couple_config_component_name_is_valid (struct yac_couple_config *couple_config, char const *component_name)
size_t	yac_couple_config_get_component_idx (struct yac_couple_config *couple_config, char const *component_name)
char const *	yac_couple_config_get_component_name (struct yac_couple_config *couple_config, size_t component_idx)
void	yac_couple_config_add_component (struct yac_couple_config *couple_config, char const *name)
void	yac_couple_config_component_set_metadata (struct yac_couple_config *couple_config, char const *comp_name, const char *metadata)
const char *	yac_couple_config_component_get_metadata (struct yac_couple_config *couple_config, char const *comp_name)
size_t	yac_couple_config_get_num_fields (struct yac_couple_config *couple_config, size_t component_idx)
size_t	yac_couple_config_get_num_grids (struct yac_couple_config *couple_config)
int	yac_couple_config_contains_grid_name (struct yac_couple_config *couple_config, char const *grid_name)
void	yac_couple_config_add_grid (struct yac_couple_config *couple_config, char const *name)
void	yac_couple_config_grid_set_metadata (struct yac_couple_config *couple_config, char const *grid_name, const char *metadata)
const char *	yac_couple_config_grid_get_metadata (struct yac_couple_config *couple_config, char const *grid_name)
size_t	yac_couple_config_get_grid_idx (struct yac_couple_config *couple_config, char const *grid_name)
char const *	yac_couple_config_get_grid_name (struct yac_couple_config *couple_config, size_t grid_idx)
void	yac_couple_config_grid_set_output_filename (struct yac_couple_config *couple_config, const char *grid_name, char const *output_filename)
const char *	yac_couple_config_grid_get_output_filename (struct yac_couple_config *couple_config, const char *grid_name)
void	yac_couple_config_component_add_field (struct yac_couple_config *couple_config, const char *component_name, const char *grid_name, const char *name, const char *timestep, size_t collection_size)
void	yac_couple_config_field_set_metadata (struct yac_couple_config *couple_config, char const *comp_name, char const *grid_name, char const *field_name, const char *metadata)
const char *	yac_couple_config_field_get_metadata (struct yac_couple_config *couple_config, char const *comp_name, char const *grid_name, char const *field_name)
size_t	yac_couple_config_get_field_idx (struct yac_couple_config *couple_config, size_t component_idx, size_t grid_idx, char const *field_name)
void	yac_couple_config_field_enable_frac_mask (struct yac_couple_config *couple_config, char const *comp_name, char const *grid_name, char const *field_name, double frac_mask_fallback_value)
double	yac_couple_config_get_frac_mask_fallback_value (struct yac_couple_config *couple_config, char const *component_name, char const *grid_name, char const *field_name)
char const *	yac_couple_config_get_field_grid_name (struct yac_couple_config *couple_config, size_t component_idx, size_t field_idx)
char const *	yac_couple_config_get_field_name (struct yac_couple_config *couple_config, size_t component_idx, size_t field_idx)
char const *	yac_couple_config_get_field_timestep (struct yac_couple_config *couple_config, char const *component_name, char const *grid_name, char const *field_name)
size_t	yac_couple_config_get_field_collection_size (struct yac_couple_config *couple_config, char const *component_name, char const *grid_name, char const *field_name)
int	yac_couple_config_get_field_role (struct yac_couple_config *couple_config, char const *component_name, char const *grid_name, char const *field_name)
int	yac_couple_config_field_is_valid (struct yac_couple_config *couple_config, size_t component_idx, size_t field_idx)
void	yac_couple_config_def_couple (struct yac_couple_config *couple_config, char const *src_comp_name, char const *src_grid_name, char const *src_field_name, char const *tgt_comp_name, char const *tgt_grid_name, char const *tgt_field_name, char const *coupling_period, int time_reduction, struct yac_interp_stack_config *interp_stack, int src_lag, int tgt_lag, char const *weight_file_name, int mapping_on_source, double scale_factor, double scale_summand, size_t num_src_mask_names, char const *const *src_mask_names, char const *tgt_mask_name, char const *yaxt_exchanger_name)
size_t	yac_couple_config_get_num_couples (struct yac_couple_config *couple_config)
size_t	yac_couple_config_get_num_couple_fields (struct yac_couple_config *couple_config, size_t couple_idx)
void	yac_couple_config_get_couple_component_names (struct yac_couple_config *couple_config, size_t couple_idx, char const *couple_component_names[2])
void	yac_couple_config_get_field_couple_component_names (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx, char const **src_component_name, char const **tgt_component_name)
void	yac_couple_config_get_field_grid_names (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx, char const **src_grid_name, char const **tgt_grid_name)
void	yac_couple_config_get_field_names (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx, const char **src_field_name, const char **tgt_field_name)
struct yac_interp_stack_config *	yac_couple_config_get_interp_stack (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
int	yac_couple_config_mapping_on_source (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
int	yac_couple_config_get_source_lag (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
int	yac_couple_config_get_target_lag (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
char const *	yac_couple_config_get_coupling_period (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
char const *	yac_couple_config_get_source_timestep (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
char const *	yac_couple_config_get_target_timestep (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
enum yac_reduction_type	yac_couple_config_get_coupling_period_operation (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
int	yac_couple_config_enforce_write_weight_file (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
char const *	yac_couple_config_get_weight_file_name (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
double	yac_couple_config_get_scale_factor (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
double	yac_couple_config_get_scale_summand (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
void	yac_couple_config_get_src_mask_names (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx, char const *const **mask_names, size_t *num_mask_names)
char const *	yac_couple_config_get_tgt_mask_name (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
char const *	yac_couple_config_get_yaxt_exchanger_name (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
void	yac_couple_config_get_field_source (struct yac_couple_config *couple_config, char const *tgt_component_name, char const *tgt_grid_name, char const *tgt_field_name, char const **src_component_name, char const **src_grid_name, char const **src_field_name)
void	yac_couple_config_sync (struct yac_couple_config *couple_config, MPI_Comm comm, char const *output_ref)
void	yac_couple_config_set_config_output_filename (struct yac_couple_config *couple_config, char const *filename, enum yac_text_filetype filetype, char const *ref, int include_definitions)
int	yac_couple_config_get_missing_definition_is_fatal (struct yac_couple_config *couple_config)
void	yac_couple_config_set_missing_definition_is_fatal (struct yac_couple_config *couple_config, int missing_definition_is_fatal)

Macro Definition Documentation

MISSING_DEFINITION_IS_FATAL_DEFAULT_VALUE

#define MISSING_DEFINITION_IS_FATAL_DEFAULT_VALUE   (1)

Definition at line 50 of file couple_config.h.

Enumeration Type Documentation

yac_reduction_type

enum yac_reduction_type

Enumerator
TIME_NONE
TIME_ACCUMULATE
TIME_AVERAGE
TIME_MINIMUM
TIME_MAXIMUM

Definition at line 37 of file couple_config.h.

yac_text_filetype

enum yac_text_filetype

Enumerator
YAC_TEXT_FILETYPE_YAML	YAML format.
YAC_TEXT_FILETYPE_JSON	JSON format.

Definition at line 45 of file couple_config.h.

yac_time_unit_type

enum yac_time_unit_type

Enumerator
C_MILLISECOND
C_SECOND
C_MINUTE
C_HOUR
C_DAY
C_MONTH
C_YEAR
C_ISO_FORMAT
TIME_UNIT_UNDEFINED

Definition at line 25 of file couple_config.h.

Function Documentation

yac_couple_config_add_component()

void yac_couple_config_add_component	(	struct yac_couple_config *	couple_config,
		char const *	name )

Definition at line 779 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_add_grid()

void yac_couple_config_add_grid	(	struct yac_couple_config *	couple_config,
		char const *	name )

Definition at line 749 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_component_add_field()

void yac_couple_config_component_add_field	(	struct yac_couple_config *	couple_config,
		const char *	component_name,
		const char *	grid_name,
		const char *	name,
		const char *	timestep,
		size_t	collection_size )

Definition at line 948 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_component_get_metadata()

const char * yac_couple_config_component_get_metadata	(	struct yac_couple_config *	couple_config,
		char const *	comp_name )

Definition at line 839 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_component_name_is_valid()

int yac_couple_config_component_name_is_valid	(	struct yac_couple_config *	couple_config,
		char const *	component_name )

Definition at line 1029 of file couple_config.c.

yac_couple_config_component_set_metadata()

void yac_couple_config_component_set_metadata	(	struct yac_couple_config *	couple_config,
		char const *	comp_name,
		const char *	metadata )

Definition at line 785 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_contains_grid_name()

int yac_couple_config_contains_grid_name	(	struct yac_couple_config *	couple_config,
		char const *	grid_name )

Definition at line 1762 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_def_couple()

void yac_couple_config_def_couple	(	struct yac_couple_config *	couple_config,
		char const *	src_comp_name,
		char const *	src_grid_name,
		char const *	src_field_name,
		char const *	tgt_comp_name,
		char const *	tgt_grid_name,
		char const *	tgt_field_name,
		char const *	coupling_period,
		int	time_reduction,
		struct yac_interp_stack_config *	interp_stack,
		int	src_lag,
		int	tgt_lag,
		char const *	weight_file_name,
		int	mapping_on_source,
		double	scale_factor,
		double	scale_summand,
		size_t	num_src_mask_names,
		char const *const *	src_mask_names,
		char const *	tgt_mask_name,
		char const *	yaxt_exchanger_name )

Definition at line 2286 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_delete()

void yac_couple_config_delete

(

struct yac_couple_config *

couple_config

)

Definition at line 699 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_enforce_write_weight_file()

int yac_couple_config_enforce_write_weight_file	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1647 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_field_enable_frac_mask()

void yac_couple_config_field_enable_frac_mask	(	struct yac_couple_config *	couple_config,
		char const *	comp_name,
		char const *	grid_name,
		char const *	field_name,
		double	frac_mask_fallback_value )

Definition at line 1321 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_field_get_metadata()

const char * yac_couple_config_field_get_metadata	(	struct yac_couple_config *	couple_config,
		char const *	comp_name,
		char const *	grid_name,
		char const *	field_name )

Definition at line 860 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_field_is_valid()

int yac_couple_config_field_is_valid	(	struct yac_couple_config *	couple_config,
		size_t	component_idx,
		size_t	field_idx )

Definition at line 1238 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_field_set_metadata()

void yac_couple_config_field_set_metadata	(	struct yac_couple_config *	couple_config,
		char const *	comp_name,
		char const *	grid_name,
		char const *	field_name,
		const char *	metadata )

Definition at line 826 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_component_idx()

size_t yac_couple_config_get_component_idx	(	struct yac_couple_config *	couple_config,
		char const *	component_name )

Definition at line 1066 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_get_component_name()

char const * yac_couple_config_get_component_name	(	struct yac_couple_config *	couple_config,
		size_t	component_idx )

Definition at line 1130 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_couple_component_names()

void yac_couple_config_get_couple_component_names	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		char const *	couple_component_names[2] )

Definition at line 1015 of file couple_config.c.

Here is the call graph for this function:

yac_couple_config_get_coupling_period()

char const * yac_couple_config_get_coupling_period	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1500 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_coupling_period_operation()

enum yac_reduction_type yac_couple_config_get_coupling_period_operation	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1557 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_end_datetime()

char * yac_couple_config_get_end_datetime

(

struct yac_couple_config *

couple_config

)

Definition at line 1623 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_get_field_collection_size()

size_t yac_couple_config_get_field_collection_size	(	struct yac_couple_config *	couple_config,
		char const *	component_name,
		char const *	grid_name,
		char const *	field_name )

Definition at line 1386 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_field_couple_component_names()

void yac_couple_config_get_field_couple_component_names	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx,
		char const **	src_component_name,
		char const **	tgt_component_name )

Definition at line 1406 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_field_grid_name()

char const * yac_couple_config_get_field_grid_name	(	struct yac_couple_config *	couple_config,
		size_t	component_idx,
		size_t	field_idx )

Definition at line 1154 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_field_grid_names()

void yac_couple_config_get_field_grid_names	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx,
		char const **	src_grid_name,
		char const **	tgt_grid_name )

Definition at line 1284 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_field_idx()

size_t yac_couple_config_get_field_idx	(	struct yac_couple_config *	couple_config,
		size_t	component_idx,
		size_t	grid_idx,
		char const *	field_name )

Definition at line 1101 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_field_name()

char const * yac_couple_config_get_field_name	(	struct yac_couple_config *	couple_config,
		size_t	component_idx,
		size_t	field_idx )

Definition at line 1169 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_field_names()

void yac_couple_config_get_field_names	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx,
		const char **	src_field_name,
		const char **	tgt_field_name )

Definition at line 1425 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_field_role()

int yac_couple_config_get_field_role	(	struct yac_couple_config *	couple_config,
		char const *	component_name,
		char const *	grid_name,
		char const *	field_name )

Definition at line 1203 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_field_source()

void yac_couple_config_get_field_source	(	struct yac_couple_config *	couple_config,
		char const *	tgt_component_name,
		char const *	tgt_grid_name,
		char const *	tgt_field_name,
		char const **	src_component_name,
		char const **	src_grid_name,
		char const **	src_field_name )

Definition at line 2764 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_field_timestep()

char const * yac_couple_config_get_field_timestep	(	struct yac_couple_config *	couple_config,
		char const *	component_name,
		char const *	grid_name,
		char const *	field_name )

Definition at line 1183 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_frac_mask_fallback_value()

double yac_couple_config_get_frac_mask_fallback_value	(	struct yac_couple_config *	couple_config,
		char const *	component_name,
		char const *	grid_name,
		char const *	field_name )

Definition at line 1359 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_grid_idx()

size_t yac_couple_config_get_grid_idx	(	struct yac_couple_config *	couple_config,
		char const *	grid_name )

Definition at line 1084 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_get_grid_name()

char const * yac_couple_config_get_grid_name	(	struct yac_couple_config *	couple_config,
		size_t	grid_idx )

Definition at line 1636 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_get_interp_stack()

struct yac_interp_stack_config * yac_couple_config_get_interp_stack	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1270 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_missing_definition_is_fatal()

int yac_couple_config_get_missing_definition_is_fatal

(

struct yac_couple_config *

couple_config

)

returns whether YAC aborts if for a defined couple at least one associated field was not defined by the user

Parameters

[in]

couple_config

coupling configuration

Returns

missing_definition_is_fatal flag

Definition at line 966 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_get_num_components()

size_t yac_couple_config_get_num_components

(

struct yac_couple_config *

couple_config

)

Definition at line 1047 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_get_num_couple_fields()

size_t yac_couple_config_get_num_couple_fields	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx )

Definition at line 1005 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_num_couples()

size_t yac_couple_config_get_num_couples

(

struct yac_couple_config *

couple_config

)

Definition at line 960 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_get_num_fields()

size_t yac_couple_config_get_num_fields	(	struct yac_couple_config *	couple_config,
		size_t	component_idx )

Definition at line 1059 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_num_grids()

size_t yac_couple_config_get_num_grids

(

struct yac_couple_config *

couple_config

)

Definition at line 1053 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_get_scale_factor()

double yac_couple_config_get_scale_factor	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1680 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_scale_summand()

double yac_couple_config_get_scale_summand	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1695 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_source_lag()

int yac_couple_config_get_source_lag	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1470 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_source_timestep()

char const * yac_couple_config_get_source_timestep	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1515 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_src_mask_names()

void yac_couple_config_get_src_mask_names	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx,
		char const *const **	mask_names,
		size_t *	num_mask_names )

Definition at line 1710 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_start_datetime()

char * yac_couple_config_get_start_datetime

(

struct yac_couple_config *

couple_config

)

Definition at line 1610 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_get_target_lag()

int yac_couple_config_get_target_lag	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1485 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_target_timestep()

char const * yac_couple_config_get_target_timestep	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1540 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_tgt_mask_name()

char const * yac_couple_config_get_tgt_mask_name	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1732 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_weight_file_name()

char const * yac_couple_config_get_weight_file_name	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1662 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_get_yaxt_exchanger_name()

char const * yac_couple_config_get_yaxt_exchanger_name	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1747 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_grid_get_metadata()

const char * yac_couple_config_grid_get_metadata	(	struct yac_couple_config *	couple_config,
		char const *	grid_name )

Definition at line 853 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_grid_get_output_filename()

const char * yac_couple_config_grid_get_output_filename	(	struct yac_couple_config *	couple_config,
		const char *	grid_name )

Definition at line 846 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_grid_set_metadata()

void yac_couple_config_grid_set_metadata	(	struct yac_couple_config *	couple_config,
		char const *	grid_name,
		const char *	metadata )

Definition at line 815 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_grid_set_output_filename()

void yac_couple_config_grid_set_output_filename	(	struct yac_couple_config *	couple_config,
		const char *	grid_name,
		char const *	output_filename )

Definition at line 794 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_mapping_on_source()

int yac_couple_config_mapping_on_source	(	struct yac_couple_config *	couple_config,
		size_t	couple_idx,
		size_t	field_couple_idx )

Definition at line 1455 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_new()

struct yac_couple_config * yac_couple_config_new

(

)

Definition at line 120 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_set_config_output_filename()

void yac_couple_config_set_config_output_filename	(	struct yac_couple_config *	couple_config,
		char const *	filename,
		enum yac_text_filetype	filetype,
		char const *	ref,
		int	include_definitions )

enables the writing of the synchronised coupling configuration to file by yac_couple_config_sync

Parameters

[in]	couple_config	coupling configuration
[in]	filename	name of the output file
[in]	filetype	type of the output file
[in]	ref	reference, which has to be provided to yac_couple_config_sync in order to select the filename
[in]	include_definitions	include user definitions (components, grids, and fields) in the output file

Definition at line 2710 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_set_datetime()

void yac_couple_config_set_datetime	(	struct yac_couple_config *	couple_config,
		char const *	start,
		char const *	end )

Definition at line 1602 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_couple_config_set_missing_definition_is_fatal()

void yac_couple_config_set_missing_definition_is_fatal	(	struct yac_couple_config *	couple_config,
		int	missing_definition_is_fatal )

sets whether YAC aborts if for a defined couple at least one associated field was not defined by the user

Parameters

[in]	couple_config	coupling configuration
[in]	missing_definition_is_fatal	missing_definition_is_fatal flag

Definition at line 977 of file couple_config.c.

Here is the caller graph for this function:

yac_couple_config_sync()

void yac_couple_config_sync	(	struct yac_couple_config *	couple_config,
		MPI_Comm	comm,
		char const *	output_ref )

synchronises the coupling configuration across all processes in comm

Parameters

[in]	couple_config	coupling configuration
[in]	comm	MPI communicator
[in]	output_ref	The coupling configuration will be written to file after it has been synchronised between all processes, if a filename and -type have been set for the provided reference (see yac_couple_config_set_config_output_filename)

Definition at line 2638 of file couple_config.c.

Here is the call graph for this function:

Here is the caller graph for this function: