YAC 3.20.0
Yet Another Coupler
Loading...
Searching...
No Matches
Macros | Enumerations | Functions
couple_config.h File Reference
#include "interpolation/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)
 
#define APPLY_COORDINATE_CHECK_DEFAULT_VALUE   (1)
 
#define COORDINATES_MISMATCH_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 const *couple_config)
 
char * yac_couple_config_get_end_datetime (struct yac_couple_config const *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 const *couple_config)
 
int yac_couple_config_is_valid_component_name (struct yac_couple_config const *couple_config, char const *component_name)
 
size_t yac_couple_config_get_component_idx (struct yac_couple_config const *couple_config, char const *component_name)
 
char const * yac_couple_config_get_component_name (struct yac_couple_config const *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_set_component_metadata (struct yac_couple_config *couple_config, char const *comp_name, const char *metadata)
 
const char * yac_couple_config_get_component_metadata (struct yac_couple_config const *couple_config, char const *comp_name)
 
size_t yac_couple_config_get_num_fields (struct yac_couple_config const *couple_config, size_t component_idx)
 
size_t yac_couple_config_get_num_grids (struct yac_couple_config const *couple_config)
 
int yac_couple_config_contains_grid_name (struct yac_couple_config const *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_set_grid_metadata (struct yac_couple_config *couple_config, char const *grid_name, const char *metadata)
 
const char * yac_couple_config_get_grid_metadata (struct yac_couple_config const *couple_config, char const *grid_name)
 
size_t yac_couple_config_get_grid_idx (struct yac_couple_config const *couple_config, char const *grid_name)
 
char const * yac_couple_config_get_grid_name (struct yac_couple_config const *couple_config, size_t grid_idx)
 
void yac_couple_config_set_grid_output_filename (struct yac_couple_config *couple_config, const char *grid_name, char const *output_filename)
 
const char * yac_couple_config_get_grid_output_filename (struct yac_couple_config const *couple_config, const char *grid_name)
 
void yac_couple_config_add_component_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_set_field_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_get_field_metadata (struct yac_couple_config const *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 const *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 const *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 const *couple_config, size_t component_idx, size_t field_idx)
 
char const * yac_couple_config_get_field_name (struct yac_couple_config const *couple_config, size_t component_idx, size_t field_idx)
 
char const * yac_couple_config_get_field_timestep (struct yac_couple_config const *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 const *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 const *couple_config, char const *component_name, char const *grid_name, char const *field_name)
 
int yac_couple_config_is_valid_field (struct yac_couple_config const *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 weight_file_on_existing, 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, struct yac_collection_selection const *collection_selection, int use_raw_exchange)
 
size_t yac_couple_config_get_num_couples (struct yac_couple_config const *couple_config)
 
size_t yac_couple_config_get_num_couple_fields (struct yac_couple_config const *couple_config, size_t couple_idx)
 
void yac_couple_config_get_couple_component_names (struct yac_couple_config const *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 const *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 const *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 const *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 const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
int yac_couple_config_get_mapping_on_source (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
int yac_couple_config_get_source_lag (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
int yac_couple_config_get_target_lag (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
char const * yac_couple_config_get_coupling_period (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
char const * yac_couple_config_get_source_timestep (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
char const * yac_couple_config_get_target_timestep (struct yac_couple_config const *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 const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
int yac_couple_config_get_enforce_write_weight_file (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
char const * yac_couple_config_get_weight_file_name (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
enum yac_weight_file_on_existing yac_couple_config_get_weight_file_on_existing (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
double yac_couple_config_get_scale_factor (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
double yac_couple_config_get_scale_summand (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
void yac_couple_config_get_src_mask_names (struct yac_couple_config const *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 const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
char const * yac_couple_config_get_yaxt_exchanger_name (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
void yac_couple_config_get_field_source (struct yac_couple_config const *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)
 
int yac_couple_config_get_use_raw_exchange (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
struct yac_collection_selection const * yac_couple_config_get_collection_selection (struct yac_couple_config const *couple_config, size_t couple_idx, size_t field_couple_idx)
 
struct yac_interpolation_gen_config * yac_couple_config_get_interpolation_gen_config (struct yac_couple_config *couple_config, size_t couple_idx, size_t field_couple_idx)
 
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 const *couple_config)
 
void yac_couple_config_set_missing_definition_is_fatal (struct yac_couple_config *couple_config, int missing_definition_is_fatal)
 
int yac_couple_config_get_apply_coordinate_check (struct yac_couple_config const *couple_config)
 
void yac_couple_config_set_apply_coordinate_check (struct yac_couple_config *couple_config, int apply_coordinate_check)
 
int yac_couple_config_get_coordinates_mismatch_is_fatal (struct yac_couple_config const *couple_config)
 
void yac_couple_config_set_coordinates_mismatch_is_fatal (struct yac_couple_config *couple_config, int coordinates_mismatch_is_fatal)
 

Macro Definition Documentation

◆ APPLY_COORDINATE_CHECK_DEFAULT_VALUE

#define APPLY_COORDINATE_CHECK_DEFAULT_VALUE   (1)

Definition at line 36 of file couple_config.h.

◆ COORDINATES_MISMATCH_IS_FATAL_DEFAULT_VALUE

#define COORDINATES_MISMATCH_IS_FATAL_DEFAULT_VALUE   (1)

Definition at line 37 of file couple_config.h.

◆ MISSING_DEFINITION_IS_FATAL_DEFAULT_VALUE

#define MISSING_DEFINITION_IS_FATAL_DEFAULT_VALUE   (1)

Definition at line 35 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 22 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 30 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 10 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 147 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_component_field()

void yac_couple_config_add_component_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 258 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 133 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 const * couple_config,
char const * grid_name )

Definition at line 1182 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 weight_file_on_existing,
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,
struct yac_collection_selection const * collection_selection,
int use_raw_exchange )

Definition at line 1222 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 109 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 927 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_apply_coordinate_check()

int yac_couple_config_get_apply_coordinate_check ( struct yac_couple_config const * couple_config)

returns whether YAC checks point coordinates at enddef

Parameters
[in]couple_configcoupling configuration
Returns
apply_coordinate_check flag

Definition at line 319 of file couple_config.c.

Here is the caller graph for this function:

◆ yac_couple_config_get_collection_selection()

struct yac_collection_selection const * yac_couple_config_get_collection_selection ( struct yac_couple_config const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 867 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 const * couple_config,
char const * component_name )

Definition at line 475 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_metadata()

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

Definition at line 201 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_name()

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

Definition at line 558 of file couple_config.c.

Here is the caller graph for this function:

◆ yac_couple_config_get_coordinates_mismatch_is_fatal()

int yac_couple_config_get_coordinates_mismatch_is_fatal ( struct yac_couple_config const * couple_config)

returns whether a coordinate mismatch triggers a fatal error

Parameters
[in]couple_configcoupling configuration
Returns
coordinates_mismatch_is_fatal flag

Definition at line 365 of file couple_config.c.

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 const * couple_config,
size_t couple_idx,
char const * couple_component_names[2] )

Definition at line 426 of file couple_config.c.

◆ yac_couple_config_get_coupling_period()

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

Definition at line 735 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 748 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 const * couple_config)

Definition at line 1162 of file couple_config.c.

Here is the caller graph for this function:

◆ yac_couple_config_get_enforce_write_weight_file()

int yac_couple_config_get_enforce_write_weight_file ( struct yac_couple_config const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 761 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_collection_size()

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

Definition at line 962 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx,
char const ** src_component_name,
char const ** tgt_component_name )

Definition at line 975 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 const * couple_config,
size_t component_idx,
size_t field_idx )

Definition at line 566 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx,
char const ** src_grid_name,
char const ** tgt_grid_name )

Definition at line 893 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 const * couple_config,
size_t component_idx,
size_t grid_idx,
char const * field_name )

Definition at line 529 of file couple_config.c.

Here is the call graph for this function:

◆ yac_couple_config_get_field_metadata()

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

Definition at line 221 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 const * couple_config,
size_t component_idx,
size_t field_idx )

Definition at line 586 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx,
const char ** src_field_name,
const char ** tgt_field_name )

Definition at line 994 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 const * couple_config,
char const * component_name,
char const * grid_name,
char const * field_name )

Definition at line 612 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 const * 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 1560 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 const * couple_config,
char const * component_name,
char const * grid_name,
char const * field_name )

Definition at line 598 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 const * couple_config,
char const * component_name,
char const * grid_name,
char const * field_name )

Definition at line 946 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 const * couple_config,
char const * grid_name )

Definition at line 503 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_metadata()

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

Definition at line 214 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_name()

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

Definition at line 1173 of file couple_config.c.

Here is the caller graph for this function:

◆ yac_couple_config_get_grid_output_filename()

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

Definition at line 207 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_interp_stack()

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

Definition at line 683 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_interpolation_gen_config()

struct yac_interpolation_gen_config * yac_couple_config_get_interpolation_gen_config ( struct yac_couple_config * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 1599 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_mapping_on_source()

int yac_couple_config_get_mapping_on_source ( struct yac_couple_config const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 696 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 const * 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_configcoupling configuration
Returns
missing_definition_is_fatal flag

Definition at line 276 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 const * couple_config)

Definition at line 457 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 const * couple_config,
size_t couple_idx )

Definition at line 418 of file couple_config.c.

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 const * couple_config)

Definition at line 270 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 const * couple_config,
size_t component_idx )

Definition at line 469 of file couple_config.c.

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 const * couple_config)

Definition at line 463 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 800 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 813 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 709 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 1025 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx,
char const *const ** mask_names,
size_t * num_mask_names )

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_start_datetime()

char * yac_couple_config_get_start_datetime ( struct yac_couple_config const * couple_config)

Definition at line 1150 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 722 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 1055 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 840 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_use_raw_exchange()

int yac_couple_config_get_use_raw_exchange ( struct yac_couple_config const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 880 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 774 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_on_existing()

enum yac_weight_file_on_existing yac_couple_config_get_weight_file_on_existing ( struct yac_couple_config const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

Definition at line 787 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 const * couple_config,
size_t couple_idx,
size_t field_couple_idx )

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_is_valid_component_name()

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

Definition at line 438 of file couple_config.c.

◆ yac_couple_config_is_valid_field()

int yac_couple_config_is_valid_field ( struct yac_couple_config const * couple_config,
size_t component_idx,
size_t field_idx )

Definition at line 671 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 45 of file couple_config.c.

Here is the caller graph for this function:

◆ yac_couple_config_set_apply_coordinate_check()

void yac_couple_config_set_apply_coordinate_check ( struct yac_couple_config * couple_config,
int apply_coordinate_check )

sets whether YAC checks point coordinates at enddef

Parameters
[in]couple_configcoupling configuration
[in]apply_coordinate_checkapply_coordinate_check flag

Definition at line 343 of file couple_config.c.

Here is the caller graph for this function:

◆ yac_couple_config_set_component_metadata()

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

Definition at line 153 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_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_configcoupling configuration
[in]filenamename of the output file
[in]filetypetype of the output file
[in]refreference, which has to be provided to yac_couple_config_sync in order to select the filename
[in]include_definitionsinclude debug definitions (components, grids, and fields) in the output file

Definition at line 1507 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_coordinates_mismatch_is_fatal()

void yac_couple_config_set_coordinates_mismatch_is_fatal ( struct yac_couple_config * couple_config,
int coordinates_mismatch_is_fatal )

sets whether a coordinate mismatch triggers a fatal error

Parameters
[in]couple_configcoupling configuration
[in]coordinates_mismatch_is_fatalcoordinates_mismatch_is_fatal flag

Definition at line 392 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 1142 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_field_metadata()

void yac_couple_config_set_field_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 189 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_grid_metadata()

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

Definition at line 175 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_grid_output_filename()

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

Definition at line 161 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_configcoupling configuration
[in]missing_definition_is_fatalmissing_definition_is_fatal flag

Definition at line 297 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_configcoupling configuration
[in]commMPI communicator
[in]output_refThe 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 1427 of file couple_config.c.

Here is the call graph for this function:
Here is the caller graph for this function: