YAC: src/mci/yac.c File Reference

Searching...

No Matches

#include "config.h"
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "yac_mpi_common.h"
#include "ensure_array_size.h"
#include "event.h"
#include "yac.h"
#include "mpi_handshake.h"
#include "utils_mci.h"
#include "version.h"
#include "instance.h"
#include "fields.h"
#include "couple_config.h"
#include "config_yaml.h"
#include "geometry.h"
#include "yac_mpi.h"
#include "utils_common.h"
#include "interpolation_exchange.h"
#include "interp_weights.h"

Include dependency graph for yac.c:

Go to the source code of this file.

Data Structures
struct	user_input_data_component

struct	user_input_data_points

struct	user_input_data_masks

struct	yac_ext_couple_config

Macros
#define	NO_CHECK (1)

#define	PUT_CHECK (put_mask[i][j])

#define	SUM +=

#define	ASSIGN =

#define	AGGREGATE_FRAC(CHECK, EXTRA_CHECK, ACCU_OP)

#define	AGGREATE_NOFRAC(CHECK, EXTRA_CHECK, ACCU_OP)

#define	AGGREGATE(EXTRA_CHECK, ACCU_OP)

#define	NO_CHECK (1)

#define	PUT_CHECK (put_mask[i][j])

#define	WEIGHT_ACC_(ACC, CHECK, EXTRA_CHECK)

#define	WEIGHT_ACC(ACC, EXTRA_CHECK)

Enumerations
enum	{ YAC_CONFIG_OUTPUT_SYNC_LOC_DEF_COMP_ = 0 , YAC_CONFIG_OUTPUT_SYNC_LOC_SYNC_DEF_ = 1 , YAC_CONFIG_OUTPUT_SYNC_LOC_ENDDEF_ = 2 }

Functions
static int	yac_pointer_to_unique_id (void *pointer)

static void *	yac_unique_id_to_pointer (int id, char const *id_name)

static int	yac_lookup_pointer (void const *pointer)

static void	yac_free_pointer_unique_lookup ()

static int	yac_add_grid (const char *grid_name, struct yac_basic_grid_data grid_data)

static void	yac_free_grids ()

static void	yac_free_points ()

static void	yac_free_masks ()

static void	yac_free_components ()

static void	yac_free_interp_stack_configs ()

static void	check_default_instance_id (char const *routine_name)

static void	yac_check_version (MPI_Comm comm)

void	check_mpi_initialised (char const *routine_name)

void	yac_cmpi_handshake (MPI_Comm comm, size_t n, char const *group_names, MPI_Comm group_comms)

void	yac_cmpi_handshake_f2c (MPI_Fint comm, int n, char const *group_names, MPI_Fint group_comms)

static int	yac_init (MPI_Comm comm)

int	yac_cget_default_instance_id ()

void	yac_cinit_comm_instance (MPI_Comm comm, int *yac_instance_id)

void	yac_cinit_comm_instance_f2c (MPI_Fint comm, int *yac_instance_id)

void	yac_cinit_comm (MPI_Comm comm)

void	yac_cinit_comm_f2c (MPI_Fint comm_f)

void	yac_cinit_instance (int *yac_instance_id)

void	yac_cinit (void)

void	yac_cinit_comm_dummy (MPI_Comm comm)

void	yac_cinit_comm_dummy_f2c (MPI_Fint comm_f)

void	yac_cinit_dummy (void)

int	yac_cyaml_get_emitter_flag_default_c2f ()

int	yac_cyaml_get_emitter_flag_json_c2f ()

void	yac_cread_config_yaml_instance (int yac_instance_id, const char *yaml_filename)

void	yac_cread_config_yaml (const char *yaml_filename)

void	yac_cread_config_json_instance (int yac_instance_id, const char *yaml_filename)

void	yac_cread_config_json (const char *yaml_filename)

void	yac_cset_config_output_file_instance (int yac_instance_id, const char *filename, int fileformat, int sync_location, int include_definitions)

void	yac_cset_config_output_file (const char *filename, int filetype, int sync_location, int include_definitions)

void	yac_cset_grid_output_file_instance (int yac_instance_id, const char gridname, const char filename)

void	yac_cset_grid_output_file (const char gridname, const char filename)

static void	yac_ccleanup_instance_ (int yac_instance_id)

void	yac_ccleanup_instance (int yac_instance_id)
	Clean-up a YAC instance (see Restarting YAC)

void	yac_ccleanup ()
	Clean-up default YAC instance (see Restarting YAC)

static void	cleanup ()

void	yac_cfinalize_instance (int yac_instance_id)
	Finalises YAC.

void	yac_cfinalize ()
	Finalises YAC.

void	yac_cdef_datetime_instance (int yac_instance_id, const char start_datetime, const char end_datetime)

void	yac_cdef_datetime (const char start_datetime, const char end_datetime)

void	yac_cdef_calendar (int calendar)

int	yac_cget_calendar ()

char *	yac_cget_start_datetime_instance (int yac_instance_id)

char *	yac_cget_start_datetime (void)

char *	yac_cget_end_datetime_instance (int yac_instance_id)

char *	yac_cget_end_datetime (void)

char *	yac_cget_version (void)

static struct user_input_data_component *	get_user_input_data_component (int comp_id, char const *routine)

void	yac_cget_comp_comm (int comp_id, MPI_Comm *comp_comm)

void	yac_get_comp_comm_f2c (int comp_id, MPI_Fint *comp_comm_f)

void	yac_cget_comp_size_c2py (int comp_id, int *size)

void	yac_cget_comp_rank_c2py (int comp_id, int *rank)

void	yac_cget_comps_comm_instance (int yac_instance_id, char const *comp_names, int num_comps, MPI_Comm comps_comm)

void	yac_cget_comps_comm (const char *comp_names, int num_comps, MPI_Comm comps_comm)

void	yac_cget_comps_comm_instance_f2c (int yac_instance_id, char const *comp_names, int num_comps, MPI_Fint comps_comm_f)

void	yac_cget_comps_comm_f2c (char const *comp_names, int num_comps, MPI_Fint comps_comm_f)

void	yac_cpredef_comp_instance (int yac_instance_id, char const name, int comp_id)

void	yac_cpredef_comp (char const name, int comp_id)

void	yac_cdef_comps_instance (int yac_instance_id, char const *comp_names, int num_comps, int comp_ids)

void	yac_cdef_comps (char const *comp_names, int num_comps, int comp_ids)

void	yac_cdef_comp_instance (int yac_instance_id, char const comp_name, int comp_id)

void	yac_cdef_comp (char const comp_name, int comp_id)

static int	user_input_data_add_points (struct yac_basic_grid *grid, enum yac_location location, yac_coordinate_pointer coordinates)

static void	check_x_vertices (double const x_vertices, size_t count, char const routine_name)

static void	check_y_vertices (double const y_vertices, size_t count, char const routine_name)

static void	check_cell_to_vertex (int cell_to_vertex, int num_vertices_per_cell, int nbr_cells, int nbr_vertices, char const *routine_name)

static void	check_cell_to_edge (int cell_to_edge, int num_edges_per_cell, int nbr_cells, int nbr_edges, char const *routine_name)

void	yac_cdef_points_reg2d (int const grid_id, int const nbr_points, int const located, double const x_points, double const y_points, int point_id)

void	yac_cdef_points_curve2d (int const grid_id, int const nbr_points, int const located, double const x_points, double const y_points, int point_id)

void	yac_cdef_points_unstruct (int const grid_id, int const nbr_points, int const located, double const x_points, double const y_points, int *point_id)

void	yac_cdef_points_reg2d_rot (int const grid_id, int const nbr_points, int const located, double const x_points, double const y_points, double x_north_pole, double y_north_pole, int point_id)

static int	user_input_data_add_mask (struct yac_basic_grid grid, enum yac_location location, int const is_valid, size_t nbr_points, char const *name)

void	yac_cdef_mask_named (int const grid_id, int const nbr_points, int const located, int const is_valid, char const name, int *mask_id)

void	yac_cdef_mask (int const grid_id, int const nbr_points, int const located, int const is_valid, int mask_id)

void	yac_cset_mask (int const *is_valid, int points_id)

void	yac_cdef_field_mask (char const name, int const comp_id, int const point_ids, int const mask_ids, int const num_pointsets, int collection_size, const char timestep, int time_unit, int *field_id)

void	yac_cdef_field (char const name, int const comp_id, int const point_ids, int const num_pointsets, int collection_size, const char timestep, int time_unit, int field_id)

void	yac_cenable_field_frac_mask_instance (int yac_instance_id, const char comp_name, const char grid_name, const char *field_name, double frac_mask_fallback_value)

void	yac_cenable_field_frac_mask (const char comp_name, const char grid_name, const char *field_name, double frac_mask_fallback_value)

void	yac_cdef_component_metadata_instance (int yac_instance_id, const char comp_name, const char metadata)

void	yac_cdef_component_metadata (const char comp_name, const char metadata)

void	yac_cdef_grid_metadata_instance (int yac_instance_id, const char grid_name, const char metadata)

void	yac_cdef_grid_metadata (const char grid_name, const char metadata)

void	yac_cdef_field_metadata_instance (int yac_instance_id, const char comp_name, const char grid_name, const char field_name, const char metadata)

void	yac_cdef_field_metadata (const char comp_name, const char grid_name, const char field_name, const char metadata)

const char *	yac_cget_component_metadata_instance (int yac_instance_id, const char *comp_name)

const char *	yac_cget_component_metadata (const char *comp_name)

const char *	yac_cget_grid_metadata_instance (int yac_instance_id, const char *grid_name)

const char *	yac_cget_grid_metadata (const char *grid_name)

const char *	yac_cget_field_metadata_instance (int yac_instance_id, const char comp_name, const char grid_name, const char *field_name)

const char *	yac_cget_field_metadata (const char comp_name, const char grid_name, const char *field_name)

static void	init_ext_couple_config (struct yac_ext_couple_config *ext_couple_config)

void	yac_cget_ext_couple_config (int *ext_couple_config_id)

void	yac_cfree_ext_couple_config (int ext_couple_config_id)

void	yac_cset_ext_couple_config_weight_file_ (struct yac_ext_couple_config ext_couple_config, char const weight_file)

void	yac_cset_ext_couple_config_weight_file (int ext_couple_config_id, char const *weight_file)

void	yac_cget_ext_couple_config_weight_file (int ext_couple_config_id, char const **weight_file)

void	yac_cset_ext_couple_config_weight_file_on_existing_ (struct yac_ext_couple_config *ext_couple_config, int weight_file_on_existing)

void	yac_cset_ext_couple_config_weight_file_on_existing (int ext_couple_config_id, int weight_file_on_existing)

void	yac_cget_ext_couple_config_weight_file_on_existing (int ext_couple_config_id, int *weight_file_on_existing)

void	yac_cset_ext_couple_config_mapping_side_ (struct yac_ext_couple_config *ext_couple_config, int mapping_side)

void	yac_cset_ext_couple_config_mapping_side (int ext_couple_config_id, int mapping_side)

void	yac_cget_ext_couple_config_mapping_side (int ext_couple_config_id, int *mapping_side)

void	yac_cset_ext_couple_config_scale_factor_ (struct yac_ext_couple_config *ext_couple_config, double scale_factor)

void	yac_cset_ext_couple_config_scale_factor (int ext_couple_config_id, double scale_factor)

void	yac_cget_ext_couple_config_scale_factor (int ext_couple_config_id, double *scale_factor)

void	yac_cset_ext_couple_config_scale_summand_ (struct yac_ext_couple_config *ext_couple_config, double scale_summand)

void	yac_cset_ext_couple_config_scale_summand (int ext_couple_config_id, double scale_summand)

void	yac_cget_ext_couple_config_scale_summand (int ext_couple_config_id, double *scale_summand)

void	yac_cset_ext_couple_config_src_mask_names_ (struct yac_ext_couple_config ext_couple_config, size_t num_src_mask_names, char const const *src_mask_names)

void	yac_cset_ext_couple_config_src_mask_names (int ext_couple_config_id, size_t num_src_mask_names, char const const src_mask_names)

void	yac_cget_ext_couple_config_src_mask_names (int ext_couple_config_id, size_t num_src_mask_names, char const const **src_mask_names)

void	yac_cset_ext_couple_config_tgt_mask_name_ (struct yac_ext_couple_config ext_couple_config, char const tgt_mask_name)

void	yac_cset_ext_couple_config_tgt_mask_name (int ext_couple_config_id, char const *tgt_mask_name)

void	yac_cget_ext_couple_config_tgt_mask_name (int ext_couple_config_id, char const **tgt_mask_name)

void	yac_cset_ext_couple_config_yaxt_exchanger_name_ (struct yac_ext_couple_config ext_couple_config, char const yaxt_exchanger_name)

void	yac_cset_ext_couple_config_yaxt_exchanger_name (int ext_couple_config_id, char const *yaxt_exchanger_name)

void	yac_cget_ext_couple_config_yaxt_exchanger_name (int ext_couple_config_id, char const **yaxt_exchanger_name)

void	yac_cset_ext_couple_config_use_raw_exchange_ (struct yac_ext_couple_config *ext_couple_config, int use_raw_exchange)

void	yac_cset_ext_couple_config_use_raw_exchange (int ext_couple_config_id, int use_raw_exchange)

void	yac_cget_ext_couple_config_use_raw_exchange (int ext_couple_config_id, int *use_raw_exchange)

void	yac_cdef_couple_custom_instance_ (int yac_instance_id, 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_timestep, int time_unit, int time_reduction, int interp_stack_config_id, int src_lag, int tgt_lag, struct yac_ext_couple_config ext_couple_config)

void	yac_cdef_couple_custom_instance (int yac_instance_id, 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_timestep, int time_unit, int time_reduction, int interp_stack_config_id, int src_lag, int tgt_lag, int ext_couple_config_id)

void	yac_cdef_couple_custom (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_timestep, int time_unit, int time_reduction, int interp_stack_config_id, int src_lag, int tgt_lag, int ext_couple_config_id)

void	yac_cdef_couple_instance (int yac_instance_id, 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_timestep, int time_unit, int time_reduction, int interp_stack_config_id, int src_lag, int tgt_lag)

void	yac_cdef_couple (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_timestep, int time_unit, int time_reduction, int interp_stack_config_id, int src_lag, int tgt_lag)

void	yac_cdef_couple_instance_ (int yac_instance_id, 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_timestep, int time_unit, int time_reduction, int interp_stack_config_id, int src_lag, int tgt_lag, char const weight_file, int weight_file_on_existing, int mapping_side, double scale_factor, double scale_summand, int num_src_mask_names, char const const src_mask_names, char const tgt_mask_name, char const yaxt_exchanger_name, int use_raw_exchange)

void	yac_cdef_couple_ (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_timestep, int time_unit, int time_reduction, int interp_stack_config_id, int src_lag, int tgt_lag, char const weight_file, int weight_file_on_existing, int mapping_side, double scale_factor, double scale_summand, int num_src_mask_names, char const const src_mask_names, char const tgt_mask_name, char const yaxt_exchanger_name, int use_raw_exchange)

void	yac_ccheck_field_dimensions (int field_id, int collection_size, int num_interp_fields, int const *interp_field_sizes)

void	yac_ccheck_src_field_buffer_size (int field_id, int collection_size, int src_field_buffer_size_)

void	yac_ccheck_src_field_buffer_sizes (int field_id, int num_src_fields_, int collection_size, int *src_field_buffer_sizes_)

void	yac_cget_raw_interp_weights_data (int const field_id, double frac_mask_fallback_value, double scaling_factor, double scaling_summand, size_t num_fixed_values, double fixed_values, size_t num_tgt_per_fixed_value, size_t *tgt_idx_fixed, size_t num_wgt_tgt, size_t wgt_tgt_idx, size_t num_src_per_tgt, double weights, size_t src_field_idx, size_t *src_idx, size_t num_src_fields, size_t **src_field_buffer_size)

void	yac_cget_raw_interp_weights_data_csr (int const field_id, double frac_mask_fallback_value, double scaling_factor, double scaling_summand, size_t num_fixed_values, double fixed_values, size_t num_tgt_per_fixed_value, size_t tgt_idx_fixed, size_t src_indptr_, double weights, size_t src_field_idx, size_t *src_idx, size_t num_src_fields, size_t **src_field_buffer_sizes)

void	yac_cget_raw_interp_weights_data_csr_c2f (int const field_id, double frac_mask_fallback_value, double scaling_factor, double scaling_summand, size_t num_fixed_values, double fixed_values, size_t num_tgt_per_fixed_value, size_t tgt_idx_fixed, size_t src_indptr, double weights, size_t src_field_idx, size_t *src_idx, size_t num_src_fields, size_t *src_field_buffer_sizes, size_t tgt_field_data_size)

void	yac_cget_action (int field_id, int *action)

const char *	yac_cget_field_datetime (int field_id)

static void	yac_cupdate_ (struct coupling_field cpl_field, struct event event, int is_source)

void	yac_cupdate (int field_id)

static double **	get_recv_field_pointers (int const field_id, int const collection_size, double *recv_field)

static double ***	get_src_field_buffer_pointers (int field_id, size_t collection_size, double *src_field_buffer)

static double ***	get_src_field_buffer_pointers_ptr (int field_id, size_t collection_size, double **src_field_buffer)

static void *	yac_cget_pre_processing (int const field_id, int collection_size, int info, int ierr)

static void	yac_get (int const field_id, int collection_size, double *recv_field, int is_async, int info, int *ierr)

void	yac_get_raw_frac (int const field_id, int const collection_size, double *src_field_buffer, double src_frac_mask_buffer, int is_async, int info, int *ierror)

void	yac_get_ (int const field_id, int const collection_size, double recv_field, int is_async, int info, int *ierr)

void	yac_cget_ (int const field_id, int const collection_size, double recv_field, int info, int *ierr)

void	yac_cget_async_ (int const field_id, int const collection_size, double recv_field, int info, int *ierr)

void	yac_cget (int const field_id, int collection_size, double *recv_field, int info, int *ierr)

void	yac_cget_async (int const field_id, int collection_size, double *recv_field, int info, int *ierr)

void	yac_get_raw_frac_ (int const field_id, int const collection_size, double src_field_buffer, double src_frac_mask_buffer, int is_async, int info, int ierr)

static void	yac_get_raw_frac_ptr_ (int const field_id, int const collection_size, double src_field_buffer, double src_frac_mask_buffer, int is_async, int info, int ierr)

void	yac_cget_raw_ (int const field_id, int const collection_size, double src_field_buffer, int info, int *ierr)

void	yac_cget_raw_frac_ (int const field_id, int const collection_size, double src_field_buffer, double src_frac_mask_buffer, int info, int ierr)

void	yac_cget_raw_ptr_ (int const field_id, int const collection_size, double *src_field_buffer, int info, int *ierr)

void	yac_cget_raw_frac_ptr_ (int const field_id, int const collection_size, double src_field_buffer, double src_frac_mask_buffer, int info, int ierr)

void	yac_cget_raw_async_ (int const field_id, int const collection_size, double src_field_buffer, int info, int *ierr)

void	yac_cget_raw_frac_async_ (int const field_id, int const collection_size, double src_field_buffer, double src_frac_mask_buffer, int info, int ierr)

void	yac_cget_raw_async_ptr_ (int const field_id, int const collection_size, double *src_field_buffer, int info, int *ierr)

void	yac_cget_raw_frac_async_ptr_ (int const field_id, int const collection_size, double src_field_buffer, double src_frac_mask_buffer, int info, int ierr)

void	yac_cget_raw (int const field_id, int collection_size, double **src_field_buffer, int info, int *ierr)

void	yac_cget_raw_async (int const field_id, int collection_size, double **src_field_buffer, int info, int *ierr)

void	yac_cget_raw_frac (int const field_id, int collection_size, double *src_field_buffer, double src_frac_mask_buffer, int info, int *ierr)

void	yac_cget_raw_frac_async (int const field_id, int collection_size, double *src_field_buffer, double src_frac_mask_buffer, int info, int *ierr)

static double ***	get_send_field_pointers (int field_id, size_t collection_size, double *send_field)

void	yac_cput_ (int const field_id, int const collection_size, double send_field, int info, int *ierr)

void	yac_cput_frac_ (int const field_id, int const collection_size, double send_field, double send_frac_mask, int info, int ierr)

static void	get_send_field_pointers_ptr_ (int const field_id, int const collection_size, double send_field, double send_frac_mask, double **send_field_, double **send_frac_mask_)

void	yac_cput_ptr_ (int const field_id, int const collection_size, double *send_field, int info, int *ierr)

void	yac_cput_frac_ptr_ (int const field_id, int const collection_size, double send_field, double send_frac_mask, int info, int ierr)

void	yac_ctest (int field_id, int *flag)

void	yac_cwait (int field_id)

void *	yac_get_field_put_mask_c2f (int field_id)

void *	yac_get_field_get_mask_c2f (int field_id)

static void *	yac_cput_pre_processing (struct coupling_field cpl_field, unsigned put_idx, int const collection_size, double send_field, double send_field_acc_, double send_frac_mask, double **send_frac_mask_acc_, int with_frac_mask_, int use_raw_exchange_, int info, int *ierr)

void	yac_cput_frac (int const field_id, int const collection_size, double *const send_field, double const send_frac_mask, int info, int *ierr)

void	yac_cput (int const field_id, int const collection_size, double **const send_field, int info, int *ierr)

void	yac_cexchange_ (int const send_field_id, int const recv_field_id, int const collection_size, double send_field, double recv_field, int send_info, int recv_info, int *ierr)

void	yac_cexchange_raw_frac_ (int const send_field_id, int const recv_field_id, int const collection_size, double send_field, double send_frac_mask, double src_field_buffer, double src_frac_mask_buffer, int send_info, int recv_info, int *ierr)

void	yac_cexchange_raw_ (int const send_field_id, int const recv_field_id, int const collection_size, double send_field, double src_field_buffer, int send_info, int recv_info, int *ierr)

void	yac_cexchange_frac_ (int const send_field_id, int const recv_field_id, int const collection_size, double send_field, double send_frac_mask, double recv_field, int send_info, int recv_info, int ierr)

void	yac_cexchange_ptr_ (int const send_field_id, int const recv_field_id, int const collection_size, double send_field, double recv_field, int send_info, int recv_info, int *ierr)

void	yac_cexchange_raw_ptr_ (int const send_field_id, int const recv_field_id, int const collection_size, double send_field, double src_field_buffer, int send_info, int recv_info, int *ierr)

void	yac_cexchange_frac_ptr_ (int const send_field_id, int const recv_field_id, int const collection_size, double send_field, double send_frac_mask, double *recv_field, int send_info, int recv_info, int ierr)

void	yac_cexchange_raw_frac_ptr_ (int const send_field_id, int const recv_field_id, int const collection_size, double send_field, double send_frac_mask, double src_field_buffer, double src_frac_mask_buffer, int send_info, int recv_info, int *ierr)

void	yac_cexchange_frac (int const send_field_id, int const recv_field_id, int const collection_size, double *const send_field, double const send_frac_mask, double recv_field, int send_info, int recv_info, int ierr)

void	yac_cexchange_raw_frac (int const send_field_id, int const recv_field_id, int const collection_size, double *const send_field, double const send_frac_mask, double src_field_buffer, double src_frac_mask_buffer, int send_info, int recv_info, int ierr)

void	yac_cexchange (int const send_field_id, int const recv_field_id, int const collection_size, double *const send_field, double recv_field, int send_info, int recv_info, int *ierr)

void	yac_cexchange_raw (int const send_field_id, int const recv_field_id, int const collection_size, double *const send_field, double src_field_buffer, int send_info, int recv_info, int ierr)

void	yac_csync_def_instance (int yac_instance_id)

void	yac_csync_def (void)

void	yac_cenddef_instance (int yac_instance_id)

void	yac_cenddef (void)

void	yac_cenddef_and_emit_config_instance (int yac_instance_id, int emit_flags, char **config)

void	yac_cenddef_and_emit_config (int emit_flags, char **config)

int	yac_cget_field_id_instance (int yac_instance_id, const char comp_name, const char grid_name, const char *field_name)

int	yac_cget_field_id (const char comp_name, const char grid_name, const char *field_name)

int	yac_cget_nbr_comps_instance (int yac_instance_id)

int	yac_cget_nbr_comps (void)

int	yac_cget_nbr_grids_instance (int yac_instance_id)

int	yac_cget_nbr_grids ()

int	yac_cget_comp_nbr_grids_instance (int yac_instance_id, const char *comp_name)

int	yac_cget_comp_nbr_grids (const char *comp_name)

int	yac_cget_nbr_fields_instance (int yac_instance_id, const char comp_name, const char grid_name)

int	yac_cget_nbr_fields (const char comp_name, const char grid_name)

void	yac_cget_comp_names_instance (int yac_instance_id, int nbr_comps, const char **comp_names)

void	yac_cget_comp_names (int nbr_comps, const char **comp_names)

void	yac_cget_grid_names_instance (int yac_instance_id, int nbr_grids, const char **grid_names)

void	yac_cget_grid_names (int nbr_grids, const char **grid_names)

void	yac_cget_comp_grid_names_instance (int yac_instance_id, const char comp_name, int nbr_grids, const char *grid_names)

void	yac_cget_comp_grid_names (const char comp_name, int nbr_grids, const char *grid_names)

void	yac_cget_field_names_instance (int yac_instance_id, const char comp_name, const char grid_name, int nbr_fields, const char **field_names)

void	yac_cget_field_names (const char comp_name, const char grid_name, int nbr_fields, const char **field_names)

const char *	yac_cget_component_name_from_field_id (int field_id)

const char *	yac_cget_grid_name_from_field_id (int field_id)

const char *	yac_cget_field_name_from_field_id (int field_id)

const char *	yac_cget_timestep_from_field_id (int field_id)

int	yac_cget_collection_size_from_field_id (int field_id)

int	yac_cget_role_from_field_id (int field_id)

const char *	yac_cget_field_timestep_instance (int yac_instance_id, const char comp_name, const char grid_name, const char *field_name)

const char *	yac_cget_field_timestep (const char comp_name, const char grid_name, const char *field_name)

double	yac_cget_field_frac_mask_fallback_value_instance (int yac_instance_id, const char comp_name, const char grid_name, const char *field_name)

int	yac_cget_field_collection_size_instance (int yac_instance_id, const char comp_name, const char grid_name, const char *field_name)

double	yac_cget_field_frac_mask_fallback_value (const char comp_name, const char grid_name, const char *field_name)

int	yac_cget_field_collection_size (const char comp_name, const char grid_name, const char *field_name)

int	yac_cget_field_role_instance (int yac_instance_id, const char comp_name, const char grid_name, const char *field_name)

int	yac_cget_field_role (const char comp_name, const char grid_name, const char *field_name)

void	yac_cget_field_source_instance (int yac_instance_id, const char tgt_comp_name, const char tgt_grid_name, const char tgt_field_name, const char src_comp_name, const char src_grid_name, const char *src_field_name)

void	yac_cget_field_source (const char tgt_comp_name, const char tgt_grid_name, const char tgt_field_name, const char src_comp_name, const char src_grid_name, const char *src_field_name)

void	yac_cdef_grid_reg2d (const char grid_name, int nbr_vertices[2], int cyclic[2], double x_vertices, double y_vertices, int grid_id)

void	yac_cdef_grid_curve2d (const char grid_name, int nbr_vertices[2], int cyclic[2], double x_vertices, double y_vertices, int grid_id)

void	yac_cdef_grid_unstruct (const char grid_name, int nbr_vertices, int nbr_cells, int num_vertices_per_cell, double x_vertices, double y_vertices, int cell_to_vertex, int grid_id)

void	yac_cdef_grid_unstruct_ll (const char grid_name, int nbr_vertices, int nbr_cells, int num_vertices_per_cell, double x_vertices, double y_vertices, int cell_to_vertex, int grid_id)

void	yac_cdef_grid_unstruct_edge (const char grid_name, int nbr_vertices, int nbr_cells, int nbr_edges, int num_edges_per_cell, double x_vertices, double y_vertices, int cell_to_edge, int edge_to_vertex, int *grid_id)

void	yac_cdef_grid_unstruct_edge_ll (const char grid_name, int nbr_vertices, int nbr_cells, int nbr_edges, int num_edges_per_cell, double x_vertices, double y_vertices, int cell_to_edge, int edge_to_vertex, int *grid_id)

void	yac_cdef_grid_cloud (const char grid_name, int nbr_points, double x_points, double y_points, int grid_id)

void	yac_cdef_grid_reg2d_rot (const char grid_name, int nbr_vertices[2], int cyclic[2], double x_vertices, double y_vertices, double x_north_pole, double y_north_pole, int grid_id)

void	yac_cset_global_index (int const *global_index, int location, int grid_id)

void	yac_cset_core_mask (int const *is_core, int location, int grid_id)

size_t	yac_cget_grid_size (int located, int grid_id)

void	yac_ccompute_grid_cell_areas (int grid_id, double *cell_areas)

size_t	yac_cget_points_size (int points_id)

void	yac_cget_interp_stack_config (int *interp_stack_config_id)

void	yac_cfree_interp_stack_config (int interp_stack_config_id)

void	yac_cadd_interp_stack_config_average (int interp_stack_config_id, int reduction_type, int partial_coverage)

void	yac_cadd_interp_stack_config_ncc (int interp_stack_config_id, int weight_type, int partial_coverage)

void	yac_cadd_interp_stack_config_nnn (int interp_stack_config_id, int type, size_t n, double max_search_distance, double scale)

void	yac_cadd_interp_stack_config_rbf (int interp_stack_config_id, size_t n, double max_search_distance, double scale)

void	yac_cadd_interp_stack_config_conservative (int interp_stack_config_id, int order, int enforced_conserv, int partial_coverage, int normalisation)

void	yac_cadd_interp_stack_config_spmap (int interp_stack_config_id, double spread_distance, double max_search_distance, int weight_type, int scale_type, double src_sphere_radius, char const src_filename, char const src_varname, int src_min_global_id, double tgt_sphere_radius, char const tgt_filename, char const tgt_varname, int tgt_min_global_id)

void	yac_cadd_interp_stack_config_spmap_f2c (int interp_stack_config_id, double spread_distance, double max_search_distance, int weight_type, int scale_type, double src_sphere_radius, char const src_filename, char const src_varname, int src_min_global_id, double tgt_sphere_radius, char const tgt_filename, char const tgt_varname, int tgt_min_global_id)

void	yac_cadd_interp_stack_config_hcsbb (int interp_stack_config_id)

void	yac_cadd_interp_stack_config_user_file_2 (int interp_stack_config_id, char const *filename, int on_missing_file, int on_succes)

void	yac_cadd_interp_stack_config_user_file (int interp_stack_config_id, char const *filename)

void	yac_cadd_interp_stack_config_fixed (int interp_stack_config_id, double value)

void	yac_cadd_interp_stack_config_check (int interp_stack_config_id, char const constructor_key, char const do_search_key)

void	yac_cadd_interp_stack_config_creep (int interp_stack_config_id, int creep_distance)

void	yac_cadd_interp_stack_config_user_callback (int interp_stack_config_id, char const *func_compute_weights_key)

void	yac_cadd_compute_weights_callback (yac_func_compute_weights compute_weights_callback, void user_data, char const key)

static int	yac_cget_interp_stack_config_from_string (char const *interp_stack_config, int parse_flags)

void	yac_cget_interp_stack_config_from_string_yaml (char const interp_stack_config, int interp_stack_config_id)

void	yac_cget_interp_stack_config_from_string_json (char const interp_stack_config, int interp_stack_config_id)

Variables
int const	YAC_LOCATION_CELL = YAC_LOC_CELL

int const	YAC_LOCATION_CORNER = YAC_LOC_CORNER

int const	YAC_LOCATION_EDGE = YAC_LOC_EDGE

int const	YAC_EXCHANGE_TYPE_NONE = NOTHING

int const	YAC_EXCHANGE_TYPE_SOURCE = SOURCE

int const	YAC_EXCHANGE_TYPE_TARGET = TARGET

int const	YAC_ACTION_NONE = NONE
	no data exchanges

int const	YAC_ACTION_REDUCTION = REDUCTION
	data reduction, but data exchange

int const	YAC_ACTION_COUPLING = COUPLING
	data exchange

int const	YAC_ACTION_RESTART = RESTART

int const	YAC_ACTION_GET_FOR_RESTART = GET_FOR_RESTART
	last valid get

int const	YAC_ACTION_PUT_FOR_RESTART = PUT_FOR_RESTART
	last valid put

int const	YAC_ACTION_GET_FOR_CHECKPOINT = GET_FOR_CHECKPOINT

int const	YAC_ACTION_PUT_FOR_CHECKPOINT = PUT_FOR_CHECKPOINT

int const	YAC_ACTION_OUT_OF_BOUND = OUT_OF_BOUND
	put/get is outside of the valid range

int const	YAC_REDUCTION_TIME_NONE = TIME_NONE

int const	YAC_REDUCTION_TIME_ACCUMULATE = TIME_ACCUMULATE

int const	YAC_REDUCTION_TIME_AVERAGE = TIME_AVERAGE

int const	YAC_REDUCTION_TIME_MINIMUM = TIME_MINIMUM

int const	YAC_REDUCTION_TIME_MAXIMUM = TIME_MAXIMUM

int const	YAC_TIME_UNIT_MILLISECOND = C_MILLISECOND

int const	YAC_TIME_UNIT_SECOND = C_SECOND

int const	YAC_TIME_UNIT_MINUTE = C_MINUTE

int const	YAC_TIME_UNIT_HOUR = C_HOUR

int const	YAC_TIME_UNIT_DAY = C_DAY

int const	YAC_TIME_UNIT_MONTH = C_MONTH

int const	YAC_TIME_UNIT_YEAR = C_YEAR

int const	YAC_TIME_UNIT_ISO_FORMAT = C_ISO_FORMAT

int const	YAC_CALENDAR_NOT_SET = CALENDAR_NOT_SET

int const	YAC_PROLEPTIC_GREGORIAN = PROLEPTIC_GREGORIAN

int const	YAC_YEAR_OF_365_DAYS = YEAR_OF_365_DAYS

int const	YAC_YEAR_OF_360_DAYS = YEAR_OF_360_DAYS

int const	YAC_AVG_ARITHMETIC = YAC_INTERP_AVG_ARITHMETIC

int const	YAC_AVG_DIST = YAC_INTERP_AVG_DIST

int const	YAC_AVG_BARY = YAC_INTERP_AVG_BARY

int const	YAC_NCC_AVG = YAC_INTERP_NCC_AVG

int const	YAC_NCC_DIST = YAC_INTERP_NCC_DIST

int const	YAC_NNN_AVG = YAC_INTERP_NNN_AVG

int const	YAC_NNN_DIST = YAC_INTERP_NNN_DIST

int const	YAC_NNN_GAUSS = YAC_INTERP_NNN_GAUSS

int const	YAC_NNN_RBF = YAC_INTERP_NNN_RBF

int const	YAC_NNN_ZERO = YAC_INTERP_NNN_ZERO

int const	YAC_CONSERV_DESTAREA = YAC_INTERP_CONSERV_DESTAREA

int const	YAC_CONSERV_FRACAREA = YAC_INTERP_CONSERV_FRACAREA

int const	YAC_SPMAP_AVG = YAC_INTERP_SPMAP_AVG

int const	YAC_SPMAP_DIST = YAC_INTERP_SPMAP_DIST

int const	YAC_SPMAP_NONE = YAC_INTERP_SPMAP_NONE

int const	YAC_SPMAP_SRCAREA = YAC_INTERP_SPMAP_SRCAREA

int const	YAC_SPMAP_INVTGTAREA = YAC_INTERP_SPMAP_INVTGTAREA

int const	YAC_SPMAP_FRACAREA = YAC_INTERP_SPMAP_FRACAREA

int const	YAC_FILE_MISSING_ERROR = YAC_INTERP_FILE_MISSING_ERROR
	abort on missing file

int const	YAC_FILE_MISSING_CONT = YAC_INTERP_FILE_MISSING_CONT
	continue on missing file

int const	YAC_FILE_SUCCESS_STOP = YAC_INTERP_FILE_SUCCESS_STOP

int const	YAC_FILE_SUCCESS_CONT = YAC_INTERP_FILE_SUCCESS_CONT

int const	YAC_CONFIG_OUTPUT_FORMAT_YAML = YAC_TEXT_FILETYPE_YAML

int const	YAC_CONFIG_OUTPUT_FORMAT_JSON = YAC_TEXT_FILETYPE_JSON

int const	YAC_WGT_ON_EXISTING_ERROR = YAC_WEIGHT_FILE_ERROR

int const	YAC_WGT_ON_EXISTING_KEEP = YAC_WEIGHT_FILE_KEEP
	keep existing weight file

int const	YAC_WGT_ON_EXISTING_OVERWRITE = YAC_WEIGHT_FILE_OVERWRITE
	overwrite existing weight file

int const	YAC_CONFIG_OUTPUT_SYNC_LOC_DEF_COMP
	after component definition

int const	YAC_CONFIG_OUTPUT_SYNC_LOC_SYNC_DEF
	after synchronization of definition

int const	YAC_CONFIG_OUTPUT_SYNC_LOC_ENDDEF
	after end of definitions

static int	default_instance_id = INT_MAX

static int	yac_instance_count = 0

void **	pointer_lookup_table = NULL

static int	pointer_lookup_table_size = 0

struct yac_basic_grid **	grids = NULL

size_t	num_grids = 0

static struct user_input_data_component **	components = NULL

static size_t	num_components = 0

static struct user_input_data_points **	points = NULL

static size_t	num_points = 0

static struct user_input_data_masks **	masks = NULL

static size_t	num_masks = 0

static struct yac_interp_stack_config **	interp_stack_configs = NULL

static size_t	num_interp_stack_configs = 0

Macro Definition Documentation

◆ AGGREATE_NOFRAC

#define AGGREATE_NOFRAC	(	CHECK,
		EXTRA_CHECK,
		ACCU_OP )

Value:

  { \
    YAC_OMP_PARALLEL \
    { \
      YAC_OMP_FOR \
      for (size_t j = 0; j < num_points; ++j) {\
        double send_field_value = send_field[h][i][j]; \
        if (CHECK && (EXTRA_CHECK)) \
          send_field_acc[h][i][j] ACCU_OP send_field_value; \
      } \
    } \
  }

◆ AGGREGATE

#define AGGREGATE	(		EXTRA_CHECK,
			ACCU_OP )

Value:

  { \
    for (int h = 0; h < collection_size; h++) { \
      for (size_t i = 0; i < num_interp_fields; i++) { \
        size_t num_points = \
          yac_coupling_field_get_data_size( \
            cpl_field, \
            yac_coupling_field_get_interp_fields(cpl_field)[i].location); \
        if (with_frac_mask) { \
          if (put_mask) AGGREGATE_FRAC(PUT_CHECK, EXTRA_CHECK, ACCU_OP) \
          else          AGGREGATE_FRAC(NO_CHECK,  EXTRA_CHECK, ACCU_OP) \
        } else { \
          if (put_mask) AGGREATE_NOFRAC(PUT_CHECK, EXTRA_CHECK, ACCU_OP) \
          else          AGGREATE_NOFRAC(NO_CHECK,  EXTRA_CHECK, ACCU_OP) \
        } \
      } \
    } \
    break; \
  }

◆ AGGREGATE_FRAC

#define AGGREGATE_FRAC	(	CHECK,
		EXTRA_CHECK,
		ACCU_OP )

Value:

  { \
    YAC_OMP_PARALLEL \
    { \
      YAC_OMP_FOR \
      for (size_t j = 0; j < num_points; ++j) { \
        double frac_mask = send_frac_mask[h][i][j]; \
        double send_field_value = send_field[h][i][j] * frac_mask; \
        if (CHECK && (EXTRA_CHECK)) { \
          if (frac_mask != 0.0) { \
            send_field_acc[h][i][j] ACCU_OP send_field_value; \
            send_frac_mask_acc[h][i][j] ACCU_OP frac_mask; \
          } \
        } \
      } \
    } \
  }

◆ ASSIGN

#define ASSIGN =

◆ NO_CHECK [1/2]

#define NO_CHECK (1)

◆ NO_CHECK [2/2]

#define NO_CHECK (1)

◆ PUT_CHECK [1/2]

#define PUT_CHECK (put_mask[i][j])

◆ PUT_CHECK [2/2]

#define PUT_CHECK (put_mask[i][j])

◆ SUM

#define SUM +=

Examples: test_interp_weights_parallel.c.

◆ WEIGHT_ACC

#define WEIGHT_ACC	(		ACC,
			EXTRA_CHECK )

Value:

  { \
    if (put_mask) WEIGHT_ACC_(ACC, PUT_CHECK, EXTRA_CHECK) \
    else          WEIGHT_ACC_(ACC, NO_CHECK,  EXTRA_CHECK) \
  }

◆ WEIGHT_ACC_

#define WEIGHT_ACC_	(	ACC,
		CHECK,
		EXTRA_CHECK )

Value:

  { \
    for (size_t j = 0; j < num_points; j++) \
      if (CHECK && (EXTRA_CHECK)) ACC[h][i][j] *= weight; \
  }

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
YAC_CONFIG_OUTPUT_SYNC_LOC_DEF_COMP_
YAC_CONFIG_OUTPUT_SYNC_LOC_SYNC_DEF_
YAC_CONFIG_OUTPUT_SYNC_LOC_ENDDEF_

Definition at line 106 of file yac.c.

Function Documentation

◆ check_cell_to_edge()

static void check_cell_to_edge	(	int *	cell_to_edge,
		int *	num_edges_per_cell,
		int	nbr_cells,
		int	nbr_edges,
		char const *	routine_name )

static

Definition at line 970 of file yac.c.

Here is the caller graph for this function:

◆ check_cell_to_vertex()

static void check_cell_to_vertex	(	int *	cell_to_vertex,
		int *	num_vertices_per_cell,
		int	nbr_cells,
		int	nbr_vertices,
		char const *	routine_name )

static

Definition at line 950 of file yac.c.

Here is the caller graph for this function:

◆ check_default_instance_id()

static void check_default_instance_id ( char const * routine_name )

static

Definition at line 314 of file yac.c.

Here is the caller graph for this function:

◆ check_mpi_initialised()

void check_mpi_initialised ( char const * routine_name )

Definition at line 349 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ check_x_vertices()

static void check_x_vertices	(	double const *	x_vertices,
		size_t	count,
		char const *	routine_name )

static

Definition at line 929 of file yac.c.

Here is the caller graph for this function:

◆ check_y_vertices()

static void check_y_vertices	(	double const *	y_vertices,
		size_t	count,
		char const *	routine_name )

static

Definition at line 939 of file yac.c.

Here is the caller graph for this function:

◆ cleanup()

static void cleanup ( )

static

Definition at line 615 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_recv_field_pointers()

static double ** get_recv_field_pointers	(	int const	field_id,
		int const	collection_size,
		double *	recv_field )

static

Definition at line 2264 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_send_field_pointers()

static double *** get_send_field_pointers	(	int	field_id,
		size_t	collection_size,
		double *	send_field )

static

Definition at line 2801 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_send_field_pointers_ptr_()

static void get_send_field_pointers_ptr_	(	int const	field_id,
		int const	collection_size,
		double **	send_field,
		double **	send_frac_mask,
		double ****	send_field_,
		double ****	send_frac_mask_ )

static

Definition at line 2886 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_src_field_buffer_pointers()

static double *** get_src_field_buffer_pointers	(	int	field_id,
		size_t	collection_size,
		double *	src_field_buffer )

static

Definition at line 2292 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_src_field_buffer_pointers_ptr()

static double *** get_src_field_buffer_pointers_ptr	(	int	field_id,
		size_t	collection_size,
		double **	src_field_buffer )

static

Definition at line 2323 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_user_input_data_component()

static struct user_input_data_component * get_user_input_data_component	(	int	comp_id,
		char const *	routine )

static

Definition at line 727 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_ext_couple_config()

static void init_ext_couple_config ( struct yac_ext_couple_config * ext_couple_config )

static

Definition at line 1411 of file yac.c.

Here is the caller graph for this function:

◆ user_input_data_add_mask()

static int user_input_data_add_mask	(	struct yac_basic_grid *	grid,
		enum yac_location	location,
		int const *	is_valid,
		size_t	nbr_points,
		char const *	name )

static

Definition at line 1135 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ user_input_data_add_points()

static int user_input_data_add_points	(	struct yac_basic_grid *	grid,
		enum yac_location	location,
		yac_coordinate_pointer	coordinates )

static

Definition at line 909 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_add_grid()

static int yac_add_grid	(	const char *	grid_name,
		struct yac_basic_grid_data	grid_data )

static

Definition at line 238 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_compute_weights_callback()

void yac_cadd_compute_weights_callback	(	yac_func_compute_weights	compute_weights_callback,
		void *	user_data,
		char const *	key )

registers a callback routine for the computation of weights by the interpolation method user_callback

Parameters

[in]	compute_weights_callback	pointer to a weight computation routine
[in]	user_data	data pointer that will be passed to compute_weights_callback
[in]	key	key for identifying the callback routine

Remarks: the callback has to be set on all source processes taking part in respective coupling; the key has to match the one provided in coupling configuration

Examples: test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, and test_instance_parallel1.c.

Definition at line 5119 of file yac.c.

Here is the call graph for this function:

◆ yac_cadd_interp_stack_config_average()

void yac_cadd_interp_stack_config_average	(	int	interp_stack_config_id,
		int	reduction_type,
		int	partial_coverage )

adds average interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	reduction_type	reduction type
[in]	partial_coverage	allow partial coverage

Examples: test_dynamic_config_c.c.

Definition at line 4887 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_check()

void yac_cadd_interp_stack_config_check	(	int	interp_stack_config_id,
		char const *	constructor_key,
		char const *	do_search_key )

adds fixed interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	constructor_key	key provided to yac_interp_method_check_add_constructor_callback for a constructor callback routine
[in]	do_search_key	key provided to yac_interp_method_check_add_do_search_callback for a do_search callback routine

Examples: test_dynamic_config_c.c.

Definition at line 5084 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_conservative()

void yac_cadd_interp_stack_config_conservative	(	int	interp_stack_config_id,
		int	order,
		int	enforced_conserv,
		int	partial_coverage,
		int	normalisation )

adds conservative interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	order	first or second order
[in]	enforced_conserv	enforce local conservation
[in]	partial_coverage	allow partial coverage
[in]	normalisation	normalisation type

Examples: test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, and test_restart_c.c.

Definition at line 4957 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_creep()

void yac_cadd_interp_stack_config_creep	(	int	interp_stack_config_id,
		int	creep_distance )

adds creep interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	creep_distance	creep distance

Examples: test_dynamic_config_c.c.

Definition at line 5096 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_fixed()

void yac_cadd_interp_stack_config_fixed	(	int	interp_stack_config_id,
		double	value )

adds fixed interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	value	fixed value

Examples: test_dummy_coupling_raw_c.c, and test_dynamic_config_c.c.

Definition at line 5074 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_hcsbb()

void yac_cadd_interp_stack_config_hcsbb ( int interp_stack_config_id )

adds HCSBB interpolation to the bottom of a interpolation stack

Parameters

[in] interp_stack_config_id interpolation stack

Examples: test_dynamic_config_c.c.

Definition at line 5030 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_ncc()

void yac_cadd_interp_stack_config_ncc	(	int	interp_stack_config_id,
		int	weight_type,
		int	partial_coverage )

adds nearest corner cells interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	weight_type	reduction type
[in]	partial_coverage	allow partial coverage

Examples: test_dynamic_config_c.c.

Definition at line 4906 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_nnn()

void yac_cadd_interp_stack_config_nnn	(	int	interp_stack_config_id,
		int	type,
		size_t	n,
		double	max_search_distance,
		double	scale )

adds n-nearest-neighbour interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	type	reduction type
[in]	n	number of nearest neighbour points
[in]	max_search_distance	maximum search distance for each point
[in]	scale	scale parameter required by some reduction types

Remarks: a max_search_distance of 0.0 results in the search distance not being restricted

Examples: test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dynamic_config_c.c, test_multithreading.c, and test_restart2.c.

Definition at line 4924 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_rbf()

void yac_cadd_interp_stack_config_rbf	(	int	interp_stack_config_id,
		size_t	n,
		double	max_search_distance,
		double	scale )

adds rbf interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	n	number of nearest neighbour points
[in]	max_search_distance	maximum search distance for each point
[in]	scale	scale parameter

Remarks: a max_search_distance of 0.0 results in the search distance not being restricted

Examples: test_dynamic_config_c.c.

Definition at line 4945 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_spmap()

void yac_cadd_interp_stack_config_spmap	(	int	interp_stack_config_id,
		double	spread_distance,
		double	max_search_distance,
		int	weight_type,
		int	scale_type,
		double	src_sphere_radius,
		char const *	src_filename,
		char const *	src_varname,
		int	src_min_global_id,
		double	tgt_sphere_radius,
		char const *	tgt_filename,
		char const *	tgt_varname,
		int	tgt_min_global_id )

adds source point mapping interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	spread_distance	spread distance (in rad)
[in]	max_search_distance	maximum search distance (in rad)
[in]	weight_type	reduction type
[in]	scale_type	scaling type
[in]	src_sphere_radius	sphere radius used for source cell area computation
[in]	src_filename	netCDF file contain the source cell areas
[in]	src_varname	variable name of source cell areas
[in]	src_min_global_id	minimum global id used to map global cell ids to values in the netCDF file
[in]	tgt_sphere_radius	sphere radius used for target cell area computation
[in]	tgt_filename	netCDF file contain the target cell areas
[in]	tgt_varname	variable name of target cell areas
[in]	tgt_min_global_id	minimum global id used to map global cell ids to values in the netCDF file

Remarks: cell areas for the scaling can either be computed by YAC or read from a netCDF file (see Source to Target mapping); for computing cell areas:
(sphere_radius > 0.0; filename == NULL; varname == NULL); for reading cell areas:
(sphere_radius == 0.0; filename != NULL; varname != NULL)

Examples: test_dynamic_config_c.c.

Definition at line 4976 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cadd_interp_stack_config_spmap_f2c()

void yac_cadd_interp_stack_config_spmap_f2c	(	int	interp_stack_config_id,
		double	spread_distance,
		double	max_search_distance,
		int	weight_type,
		int	scale_type,
		double	src_sphere_radius,
		char const *	src_filename,
		char const *	src_varname,
		int	src_min_global_id,
		double	tgt_sphere_radius,
		char const *	tgt_filename,
		char const *	tgt_varname,
		int	tgt_min_global_id )

Definition at line 5010 of file yac.c.

Here is the call graph for this function:

◆ yac_cadd_interp_stack_config_user_callback()

void yac_cadd_interp_stack_config_user_callback	(	int	interp_stack_config_id,
		char const *	func_compute_weights_key )

adds user callback interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	func_compute_weights_key	key provided to yac_cadd_compute_weights_callback for a compute_weights callback routine

Examples: test_dummy_coupling_raw_c.c, and test_dynamic_config_c.c.

Definition at line 5106 of file yac.c.

Here is the call graph for this function:

◆ yac_cadd_interp_stack_config_user_file()

void yac_cadd_interp_stack_config_user_file	(	int	interp_stack_config_id,
		char const *	filename )

adds user weight file interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	filename	weight file name

Remarks: YAC will read the weight file in parallel. This parallel output can be configured as described here: Configuration of parallel IO in YAC

Examples: test_dynamic_config_c.c.

Definition at line 5065 of file yac.c.

Here is the call graph for this function:

◆ yac_cadd_interp_stack_config_user_file_2()

void yac_cadd_interp_stack_config_user_file_2	(	int	interp_stack_config_id,
		char const *	filename,
		int	on_missing_file,
		int	on_success )

adds user weight file interpolation to the bottom of a interpolation stack

Parameters

[in]	interp_stack_config_id	interpolation stack
[in]	filename	weight file name
[in]	on_missing_file	specifies how YAC should behave if no file was found
[in]	on_success	specifies how YAC should behave in case a weight file was successfully read

Remarks: YAC will read the weight file in parallel. This parallel output can be configured as described here: Configuration of parallel IO in YAC

Definition at line 5039 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_ccheck_field_dimensions()

void yac_ccheck_field_dimensions	(	int	field_id,
		int	collection_size,
		int	num_pointsets,
		int const *	pointset_sizes )

Checks whether the field dimensions match with field definition and aborts if there is a mismatch

Parameters

[in]	field_id
[in]	collection_size	collection size
[in]	num_pointsets	number of pointsets
[in]	pointset_sizes	size of each pointset

Remarks: if num_pointsets is -1, its value will not be checked; if pointset_sizes is NULL, its values will not be checked

Definition at line 1828 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_ccheck_src_field_buffer_size()

void yac_ccheck_src_field_buffer_size	(	int	field_id,
		int	collection_size,
		int	src_field_buffer_size )

Checks whether the source field buffer size matches the one expected by YAC for this field and abort if there is a mismatch

Parameters

[in]	field_id
[in]	collection_size	collection size
[in]	src_field_buffer_size	source buffer size (SUM(src_field_buffer_sizes(:)))

Definition at line 1889 of file yac.c.

Here is the call graph for this function:

◆ yac_ccheck_src_field_buffer_sizes()

void yac_ccheck_src_field_buffer_sizes	(	int	field_id,
		int	num_src_fields,
		int	collection_size,
		int *	src_field_buffer_sizes )

Checks whether the source field buffer sizes matches the one expected by YAC for this field and abort if there is a mismatch

Parameters

[in]	field_id
[in]	num_src_fields	number of source fields
[in]	collection_size	collection size
[in]	src_field_buffer_sizes	source field buffer sizes

Definition at line 1927 of file yac.c.

Here is the call graph for this function:

◆ yac_ccleanup()

void yac_ccleanup ( )

Clean-up default YAC instance (see Restarting YAC)

Frees all memory associated with the default YAC instance.

Remarks: Call yac_cfinalize for freeing all memory allocated by YAC.

Examples: test_dummy_coupling8_c.c, and test_restart_c.c.

Definition at line 606 of file yac.c.

Here is the call graph for this function:

◆ yac_ccleanup_instance()

void yac_ccleanup_instance ( int yac_instance_id )

Clean-up a YAC instance (see Restarting YAC)

Frees all memory associated with the provided YAC instance.

Parameters

[in] yac_instance_id id of the YAC instance to be cleaned up

Remarks: Call yac_cfinalize for freeing all memory allocated by YAC.

Examples: test_dummy_coupling3_c.c, test_dummy_coupling6_c.c, and test_dummy_coupling7_c.c.

Definition at line 598 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_ccleanup_instance_()

static void yac_ccleanup_instance_ ( int yac_instance_id )

static

Definition at line 579 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_ccompute_grid_cell_areas()

void yac_ccompute_grid_cell_areas	(	int	grid_id,
		double *	cell_areas )

computes the areas of all cells in a grid (an earth radius of 1.0 is assumed)

Parameters

[in]	grid_id
[out]	cell_areas

Examples: test_dummy_coupling_c.c.

Definition at line 4832 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_calendar()

void yac_cdef_calendar ( int calendar )

Defines the calendar of the default instance

Parameters

[in] calendar The calendar

See also: YAC_PROLEPTIC_GREGORIAN etc.

Examples: test_couple_config.c, test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_instance_parallel1.c, test_instance_parallel2.c, test_instance_parallel3.c, test_multithreading.c, test_query_routines_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 664 of file yac.c.

Here is the caller graph for this function:

◆ yac_cdef_comp()

void yac_cdef_comp	(	const char *	comp_name,
		int *	comp_id )

Elementary definition of the component for the default YAC instance

Parameters

[in]	comp_name	name of the component
[out]	comp_id	component Id

Remarks: this call is collective for all processes that initialised the default YAC instance; components can only be defined once in the initialisation phase of a YAC instance. If you want to predefine a component, please use yac_cpredef_comp.

Examples: test_dummy_coupling2_c.c, test_dummy_coupling4_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, test_multithreading.c, test_query_routines_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 902 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_comp_instance()

void yac_cdef_comp_instance	(	int	yac_instance_id,
		const char *	comp_name,
		int *	comp_id )

Elementary definition of the component.

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	comp_name	name of the component
[out]	comp_id	component Id

Remarks: this call is collective for all processes that initialised the provided YAC instance; components can only be defined once in the initialisation phase of a YAC instance. If you want to predefine a component, please use yac_cpredef_comp_instance.

Examples: test_dummy_coupling3_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dynamic_config_c.c, and test_query_routines_c.c.

Definition at line 896 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_component_metadata()

void yac_cdef_component_metadata	(	const char *	comp_name,
		const char *	metadata )

Define metadata for a component

Parameters

[in]	comp_name
[in]	metadata

Examples: test_query_routines_c.c.

Definition at line 1334 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_component_metadata_instance()

void yac_cdef_component_metadata_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	metadata )

Define metadata for a component

Parameters

[in]	yac_instance_id
[in]	comp_name
[in]	metadata

Examples: test_query_routines_c.c.

Definition at line 1326 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_comps()

void yac_cdef_comps	(	const char **	comp_names,
		int	num_comps,
		int *	comp_ids )

Elementary definition of the components for the default YAC instance

Parameters

[in]	comp_names	names of the components
[in]	num_comps	number of components
[out]	comp_ids	component Id's

Remarks: this call is collective for all processes that initialised the default YAC instance; components can only be defined once in the initialisation phase of a YAC instance

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, and test_query_routines_c.c.

Definition at line 888 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_comps_instance()

void yac_cdef_comps_instance	(	int	yac_instance_id,
		const char **	comp_names,
		int	num_comps,
		int *	comp_ids )

Elementary definition of the components.

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	comp_names	names of the components
[in]	num_comps	number of components
[out]	comp_ids	component Id's

Remarks: this call is collective for all processes that initialised the provided YAC instance; components can only be defined once in the initialisation phase of a YAC instance

Examples: test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, test_dynamic_config_c.c, and test_query_routines_c.c.

Definition at line 863 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_couple()

void yac_cdef_couple	(	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_timestep,
		int	time_unit,
		int	time_reduction,
		int	interp_stack_config_id,
		int	src_lag,
		int	tgt_lag )

Define couple in the default yac instance

Parameters

[in]	src_comp_name	component name of the source component
[in]	src_grid_name	grid name of the source grid
[in]	src_field_name	field name of the source field
[in]	tgt_comp_name	component name of the target component
[in]	tgt_grid_name	grid name of the target grid
[in]	tgt_field_name	field name of the target field
[in]	coupling_timestep	time step for the coupling given in the defined timestep unit
[in]	time_unit	unit of coupling_timestep argument
[in]	time_reduction	type for reducing multiple timesteps

See also: YAC_REDUCTION_TIME_NONE etc.

Parameters

[in]	interp_stack_config_id	id of the interpolation stack config to be used
[in]	src_lag	lag for this couple on the source component
[in]	tgt_lag	lag for this couple on the target component

Examples: test_dummy_coupling8_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, test_restart2.c, and test_restart_c.c.

Definition at line 1745 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_couple_()

void yac_cdef_couple_	(	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_timestep,
		int	time_unit,
		int	time_reduction,
		int	interp_stack_config_id,
		int	src_lag,
		int	tgt_lag,
		char const *	weight_file,
		int	weight_file_on_existing,
		int	mapping_side,
		double	scale_factor,
		double	scale_summand,
		int	num_src_mask_names,
		char const const	src_mask_names,
		char const *	tgt_mask_name,
		char const *	yaxt_exchanger_name,
		int	use_raw_exchange )

Definition at line 1804 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_couple_custom()

void yac_cdef_couple_custom	(	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_timestep,
		int	time_unit,
		int	time_reduction,
		int	interp_stack_config_id,
		int	src_lag,
		int	tgt_lag,
		int	ext_couple_config_id )

Define couple in the default yac instance using an extended coupling configuration

Parameters

[in]	src_comp_name	component name of the source component
[in]	src_grid_name	grid name of the source grid
[in]	src_field_name	field name of the source field
[in]	tgt_comp_name	component name of the target component
[in]	tgt_grid_name	grid name of the target grid
[in]	tgt_field_name	field name of the target field
[in]	coupling_timestep	time step for the coupling given in the defined timestep unit
[in]	time_unit	unit of coupling_timestep argument
[in]	time_reduction	type for reducing multiple timesteps

See also: YAC_REDUCTION_TIME_NONE etc.

Parameters

[in]	interp_stack_config_id	id of the interpolation stack config to be used
[in]	src_lag	lag for this couple on the source component
[in]	tgt_lag	lag for this couple on the target component
[in]	ext_couple_config_id	extended coupling configuration

Examples: test_dummy_coupling9_c.c, and test_dummy_coupling_raw_c.c.

Definition at line 1713 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_couple_custom_instance()

void yac_cdef_couple_custom_instance	(	int	yac_instance_id,
		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_timestep,
		int	time_unit,
		int	time_reduction,
		int	interp_stack_config_id,
		int	src_lag,
		int	tgt_lag,
		int	ext_couple_config_id )

Define couple using an extended coupling configuration

Parameters

[in]	yac_instance_id	id of the YAC instance for that the couple should be defined
[in]	src_comp_name	component name of the source component
[in]	src_grid_name	grid name of the source grid
[in]	src_field_name	field name of the source field
[in]	tgt_comp_name	component name of the target component
[in]	tgt_grid_name	grid name of the target grid
[in]	tgt_field_name	field name of the target field
[in]	coupling_timestep	time step for the coupling
[in]	time_unit	unit of coupling_timestep argument
[in]	time_reduction	type for reducing multiple timesteps

See also: YAC_REDUCTION_TIME_NONE etc.

Parameters

[in]	interp_stack_config_id	id of the interpolation stack config to be used
[in]	src_lag	lag for this couple on the source component
[in]	tgt_lag	lag for this couple on the target component
[in]	ext_couple_config_id	extended coupling configuration

Examples: test_dummy_coupling7_c.c, and test_dynamic_config_c.c.

Definition at line 1698 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_couple_custom_instance_()

void yac_cdef_couple_custom_instance_	(	int	yac_instance_id,
		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_timestep,
		int	time_unit,
		int	time_reduction,
		int	interp_stack_config_id,
		int	src_lag,
		int	tgt_lag,
		struct yac_ext_couple_config *	ext_couple_config )

Definition at line 1668 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_couple_instance()

void yac_cdef_couple_instance	(	int	yac_instance_id,
		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_timestep,
		int	time_unit,
		int	time_reduction,
		int	interp_stack_config_id,
		int	src_lag,
		int	tgt_lag )

Define couple

Parameters

[in]	yac_instance_id	id of the YAC instance for that the couple should be defined
[in]	src_comp_name	component name of the source component
[in]	src_grid_name	grid name of the source grid
[in]	src_field_name	field name of the source field
[in]	tgt_comp_name	component name of the target component
[in]	tgt_grid_name	grid name of the target grid
[in]	tgt_field_name	field name of the target field
[in]	coupling_timestep	time step for the coupling
[in]	time_unit	unit of coupling_timestep argument
[in]	time_reduction	type for reducing multiple timesteps

See also: YAC_REDUCTION_TIME_NONE etc.

Parameters

[in]	interp_stack_config_id	id of the interpolation stack config to be used
[in]	src_lag	lag for this couple on the source component
[in]	tgt_lag	lag for this couple on the target component

Examples: test_dummy_coupling7_c.c, and test_dynamic_config_c.c.

Definition at line 1728 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_couple_instance_()

void yac_cdef_couple_instance_	(	int	yac_instance_id,
		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_timestep,
		int	time_unit,
		int	time_reduction,
		int	interp_stack_config_id,
		int	src_lag,
		int	tgt_lag,
		char const *	weight_file,
		int	weight_file_on_existing,
		int	mapping_side,
		double	scale_factor,
		double	scale_summand,
		int	num_src_mask_names,
		char const const	src_mask_names,
		char const *	tgt_mask_name,
		char const *	yaxt_exchanger_name,
		int	use_raw_exchange )

Definition at line 1759 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_datetime()

void yac_cdef_datetime	(	const char *	start_datetime,
		const char *	end_datetime )

Definition of job start and end datetime for the default YAC instance

Parameters

[in]	start_datetime	calendar job start datetime
[in]	end_datetime	calendar job end datetime

Examples: test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, test_restart2.c, and test_restart_c.c.

Definition at line 656 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_datetime_instance()

void yac_cdef_datetime_instance	(	int	yac_instance_id,
		const char *	start_datetime,
		const char *	end_datetime )

Definition of job start and end datetime

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	start_datetime	calendar job start datetime
[in]	end_datetime	calendar job end datetime

Examples: test_dummy_coupling7_c.c, and test_dynamic_config_c.c.

Definition at line 647 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_field()

void yac_cdef_field	(	char const *	field_name,
		int const	component_id,
		int const *	point_ids,
		int const	num_pointsets,
		int	collection_size,
		const char *	timestep,
		int	time_unit,
		int *	field_id )

Definition of the coupling field (using default mask, if defined)

Parameters

[in]	field_name	character string providing the name of the coupling field
[in]	component_id	component ID
[in]	point_ids	point IDs
[in]	num_pointsets	number of pointsets per grid
[in]	collection_size	collection size
[in]	timestep	timestep
[in]	time_unit	time unit
[out]	field_id	returned field_id which has to be used to identify coupling fields in yac_cput and yac_cget.

Remarks: A calendar has to be defined before this routine is called. This can be done by a call to yac_cdef_calendar, by reading of configuration file that defines a calendar, or by synchronizing with other processes that already have defined a calendar using yac_csync_def.

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, test_query_routines_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 1274 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_field_mask()

void yac_cdef_field_mask	(	char const *	field_name,
		int const	component_id,
		int const *	point_ids,
		int const *	mask_ids,
		int const	num_pointsets,
		int	collection_size,
		const char *	timestep,
		int	time_unit,
		int *	field_id )

Definition of the coupling field

Parameters

[in]	field_name	character string providing the name of the coupling field
[in]	component_id	component ID
[in]	point_ids	point IDs
[in]	mask_ids	mask IDs
[in]	num_pointsets	number of pointsets per grid
[in]	collection_size	collection size
[in]	timestep	timestep
[in]	time_unit
[out]	field_id	returned field_id which has to be used to identify coupling fields in yac_cput and yac_cget.

Remarks: A calendar has to be defined before this routine is called. This can be done by a call to yac_cdef_calendar, by reading of configuration file that defines a calendar, or by synchronizing with other processes that already have defined a calendar using yac_csync_def.

Examples: test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, and test_dummy_coupling_raw_c.c.

Definition at line 1201 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_field_metadata()

void yac_cdef_field_metadata	(	const char *	comp_name,
		const char *	grid_name,
		const char *	field_name,
		const char *	metadata )

Define metadata for a field

Parameters

[in]	comp_name
[in]	grid_name
[in]	field_name
[in]	metadata

Examples: test_query_routines_c.c.

Definition at line 1362 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_field_metadata_instance()

void yac_cdef_field_metadata_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name,
		const char *	field_name,
		const char *	metadata )

Define metadata for a field

Parameters

[in]	yac_instance_id
[in]	comp_name
[in]	grid_name
[in]	field_name
[in]	metadata

Examples: test_query_routines_c.c.

Definition at line 1353 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_grid_cloud()

void yac_cdef_grid_cloud	(	const char *	grid_name,
		int	nbr_points,
		double *	x_points,
		double *	y_points,
		int *	grid_id )

Definition of grid consisting of a cloud of points

Parameters

[in]	grid_name	name of the grid
[in]	nbr_points	number of points
[in]	x_points	array of point longitudes, in radians
[in]	y_points	array of point latitudes, in radians
[out]	grid_id	id of generated grid

Examples: test_dummy_coupling7_c.c.

Definition at line 4704 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_grid_curve2d()

void yac_cdef_grid_curve2d	(	const char *	grid_name,
		int	nbr_vertices[2],
		int	cyclic[2],
		double *	x_vertices,
		double *	y_vertices,
		int *	grid_id )

Definition of a 2d curvilinear grid

Parameters

[in]	grid_name	name of the grid
[in]	nbr_vertices	2d array containing the number of vertices in each dimension
[in]	cyclic	2d array containing information about cyclic behaviour in each dimension
[in]	x_vertices	array of vertex longitudes, in radians
[in]	y_vertices	array of vertex latitudes, in radians
[out]	grid_id	id of generated grid

Remarks

The array x_vertices and y_vertices are expected to be of size nbr_vertices[0] * nbr_vertices[1].
This call generate a grid with the following basic grid data:
size_t internal_nbr_cells_2d[2];

size_t internal_nbr_vertices_2d[2];

if (cyclic[0]) {

internal_nbr_cells_2d[0] = nbr_vertices[0];

internal_nbr_cells_2d[1] = nbr_vertices[1] - 1;

internal_nbr_vertices_2d[0] = nbr_vertices[0] + 1;

internal_nbr_vertices_2d[1] = nbr_vertices[1];

} else {

internal_nbr_cells_2d[0] = nbr_vertices[0] - 1;

internal_nbr_cells_2d[1] = nbr_vertices[1] - 1;

internal_nbr_vertices_2d[0] = nbr_vertices[0];

internal_nbr_vertices_2d[1] = nbr_vertices[1];

}

size_t internal_nbr_cells =

internal_nbr_cells_2d[0] * internal_nbr_cells_2d[1];

size_t internal_nbr_vertices =

internal_nbr_vertices_2d[0] * internal_nbr_vertices_2d[1];

size_t internal_nbr_edges =

(internal_nbr_cells_2d[0] + 1) * internal_nbr_cells_2d[1] +

internal_nbr_cells_2d[0] * (internal_nbr_cells_2d[1] + 1);

double * internal_x_vertices =

malloc(internal_nbr_vertices * sizeof(*internal_x_vertices));

double * internal_y_vertices =

malloc(internal_nbr_vertices * sizeof(*internal_y_vertices));

for (size_t i = 0; i < internal_nbr_vertices; ++i) {

internal_x_vertices[i] = x_vertices[i];

internal_y_vertices[i] = y_vertices[i];

}
The edges of the grid follow great circles.
See Ordering of edges

Examples: test_dummy_coupling6_c.c.

Definition at line 4600 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_grid_metadata()

void yac_cdef_grid_metadata	(	const char *	grid_name,
		const char *	metadata )

Define metadata for a grid for the default YAC instance

Parameters

[in]	grid_name
[in]	metadata

Examples: test_query_routines_c.c.

Definition at line 1348 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_grid_metadata_instance()

void yac_cdef_grid_metadata_instance	(	int	yac_instance_id,
		const char *	grid_name,
		const char *	metadata )

Define metadata for a grid

Parameters

[in]	yac_instance_id
[in]	grid_name
[in]	metadata

Examples: test_query_routines_c.c.

Definition at line 1339 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_grid_reg2d()

void yac_cdef_grid_reg2d	(	const char *	grid_name,
		int	nbr_vertices[2],
		int	cyclic[2],
		double *	x_vertices,
		double *	y_vertices,
		int *	grid_id )

Definition of a 2d regular grid

Parameters

[in]	grid_name	name of the grid
[in]	nbr_vertices	2d array containing the number of vertices in each dimension
[in]	cyclic	2d array containing information about cyclic behaviour in each dimension
[in]	x_vertices	array of vertex longitudes, in radians
[in]	y_vertices	array of vertex latitudes, in radians
[out]	grid_id	id of generated grid

Remarks

This call generate a grid with the following basic grid data:
size_t internal_nbr_cells_2d[2];

size_t internal_nbr_vertices_2d[2];

if (cyclic[0]) {

internal_nbr_cells_2d[0] = nbr_vertices[0];

internal_nbr_cells_2d[1] = nbr_vertices[1] - 1;

internal_nbr_vertices_2d[0] = nbr_vertices[0];

internal_nbr_vertices_2d[1] = nbr_vertices[1];

} else {

internal_nbr_cells_2d[0] = nbr_vertices[0] - 1;

internal_nbr_cells_2d[1] = nbr_vertices[1] - 1;

internal_nbr_vertices_2d[0] = nbr_vertices[0];

internal_nbr_vertices_2d[1] = nbr_vertices[1];

}

size_t internal_nbr_cells =

internal_nbr_cells_2d[0] * internal_nbr_cells_2d[1];

size_t internal_nbr_vertices =

internal_nbr_vertices_2d[0] * internal_nbr_vertices_2d[1];

size_t internal_nbr_edges =

internal_nbr_cells_2d[1] * internal_nbr_vertices_2d[0] +

internal_nbr_cells_2d[0] * internal_nbr_vertices_2d[1];

double * internal_x_vertices =

malloc(internal_nbr_vertices * sizeof(*internal_x_vertices));

double * internal_y_vertices =

malloc(internal_nbr_vertices * sizeof(*internal_y_vertices));

for (size_t i = 0, k = 0; i < nbr_vertices[1]; ++i) {

for (size_t j = 0; j < nbr_vertices[0]; ++j, ++k) {

internal_x_vertices[k] = x_vertices[j];

internal_y_vertices[k] = y_vertices[i];

}

}
The edges of the grid either follow circles of longitude or latitude.
See Ordering of edges

Examples: test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, and test_query_routines_c.c.

Definition at line 4582 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_grid_reg2d_rot()

void yac_cdef_grid_reg2d_rot	(	const char *	grid_name,
		int	nbr_vertices[2],
		int	cyclic[2],
		double *	x_vertices,
		double *	y_vertices,
		double	x_north_pole,
		double	y_north_pole,
		int *	grid_id )

Definition of a rotated 2d regular grid

Parameters

[in]	grid_name	name of the grid
[in]	nbr_vertices	2d array containing the number of vertices in each dimension
[in]	cyclic	2d array containing information about cyclic behaviour in each dimension
[in]	x_vertices	array of vertex longitudes, in radians
[in]	y_vertices	array of vertex latitudes, in radians
[in]	x_north_pole	longitude of the rotated north pole, in radians
[in]	y_north_pole	longitude of the rotated north pole, in radians
[out]	grid_id	id of generated grid

Remarks

This call generate a grid with the following basic grid data:
size_t internal_nbr_cells_2d[2];

size_t internal_nbr_vertices_2d[2];

if (cyclic[0]) {

internal_nbr_cells_2d[0] = nbr_vertices[0];

internal_nbr_cells_2d[1] = nbr_vertices[1] - 1;

internal_nbr_vertices_2d[0] = nbr_vertices[0];

internal_nbr_vertices_2d[1] = nbr_vertices[1];

} else {

internal_nbr_cells_2d[0] = nbr_vertices[0] - 1;

internal_nbr_cells_2d[1] = nbr_vertices[1] - 1;

internal_nbr_vertices_2d[0] = nbr_vertices[0];

internal_nbr_vertices_2d[1] = nbr_vertices[1];

}

size_t internal_nbr_cells =

internal_nbr_cells_2d[0] * internal_nbr_cells_2d[1];

size_t internal_nbr_vertices =

internal_nbr_vertices_2d[0] * internal_nbr_vertices_2d[1];

size_t internal_nbr_edges =

internal_nbr_cells_2d[1] * internal_nbr_vertices_2d[0] +

internal_nbr_cells_2d[0] * internal_nbr_vertices_2d[1];

double * internal_x_vertices =

malloc(internal_nbr_vertices * sizeof(*internal_x_vertices));

double * internal_y_vertices =

malloc(internal_nbr_vertices * sizeof(*internal_y_vertices));

for (size_t i = 0, k = 0; i < nbr_vertices[1]; ++i) {

for (size_t j = 0; j < nbr_vertices[0]; ++j, ++k) {

double x_vertex_rot, y_vertex_rot;

rotate(

x_vertices[j], y_vertices[i], &x_vertex_rot, &y_vertex_rot);

internal_x_vertices[k] = x_vertex_rot;

internal_y_vertices[k] = y_vertex_rot;

}

}
The edges of the grid follow great circles.
See Ordering of edges

Definition at line 4720 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_grid_unstruct()

void yac_cdef_grid_unstruct	(	const char *	grid_name,
		int	nbr_vertices,
		int	nbr_cells,
		int *	num_vertices_per_cell,
		double *	x_vertices,
		double *	y_vertices,
		int *	cell_to_vertex,
		int *	grid_id )

Definition of an unstructured grid

Parameters

[in]	grid_name	name of the grid
[in]	nbr_vertices	number of vertices
[in]	nbr_cells	number of cells
[in]	num_vertices_per_cell	array containing the number of vertices for each cell
[in]	x_vertices	array of vertex longitudes, in radians
[in]	y_vertices	array of vertex latitudes, in radians
[in]	cell_to_vertex	connectivity of vertices belonging to cells (the vertex indices per cell have to be in clockwise or counterclockwise ordering)
[out]	grid_id	id of generated grid

Remarks

The edges of the grid follow great circles.
See Ordering of edges

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 4618 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_grid_unstruct_edge()

void yac_cdef_grid_unstruct_edge	(	const char *	grid_name,
		int	nbr_vertices,
		int	nbr_cells,
		int	nbr_edges,
		int *	num_edges_per_cell,
		double *	x_vertices,
		double *	y_vertices,
		int *	cell_to_edge,
		int *	edge_to_vertex,
		int *	grid_id )

Definition of an unstructured grid with explicit edge definition

Parameters

[in]	grid_name	name of the grid
[in]	nbr_vertices	number of vertices
[in]	nbr_cells	number of cells
[in]	nbr_edges	number of edges
[in]	num_edges_per_cell	array containing the number of edges for each cell
[in]	x_vertices	array of vertex longitudes, in radians
[in]	y_vertices	array of vertex latitudes, in radians
[in]	cell_to_edge	connectivity of edges belonging to cells (the edge indices per cell have to be in clockwise or counterclockwise ordering)
[in]	edge_to_vertex	connectivity of vertices belonging to edges
[out]	grid_id	id of generated grid

Remarks

The edges of the grid follow great circles.

Definition at line 4660 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_grid_unstruct_edge_ll()

void yac_cdef_grid_unstruct_edge_ll	(	const char *	grid_name,
		int	nbr_vertices,
		int	nbr_cells,
		int	nbr_edges,
		int *	num_edges_per_cell,
		double *	x_vertices,
		double *	y_vertices,
		int *	cell_to_edge,
		int *	edge_to_vertex,
		int *	grid_id )

Definition of an unstructured grid with lon-lat edges with explicit edge definition

Parameters

[in]	grid_name	name of the grid
[in]	nbr_vertices	number of vertices
[in]	nbr_cells	number of cells
[in]	nbr_edges	number of edges
[in]	num_edges_per_cell	array containing the number of edges for each cell
[in]	x_vertices	array of vertex longitudes, in radians
[in]	y_vertices	array of vertex latitudes, in radians
[in]	cell_to_edge	connectivity of edges belonging to cells (the edge indices per cell have to be in clockwise or counterclockwise ordering)
[in]	edge_to_vertex	connectivity of vertices belonging to edges
[out]	grid_id	id of generated grid

Remarks: YAC will check all edges of the grid and determine whether they are on circles of longitudes (same x coordinate) or latitudes (same y coordinate). An edge that does not fulfill this condition will cause an error.

Definition at line 4682 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_grid_unstruct_ll()

void yac_cdef_grid_unstruct_ll	(	const char *	grid_name,
		int	nbr_vertices,
		int	nbr_cells,
		int *	num_vertices_per_cell,
		double *	x_vertices,
		double *	y_vertices,
		int *	cell_to_vertex,
		int *	grid_id )

Definition of an unstructured grid with lon-lat edges

Parameters

[in]	grid_name	name of the grid
[in]	nbr_vertices	number of vertices
[in]	nbr_cells	number of cells
[in]	num_vertices_per_cell	array containing the number of vertices for each cell
[in]	x_vertices	array of vertex longitudes, in radians
[in]	y_vertices	array of vertex latitudes, in radians
[in]	cell_to_vertex	connectivity of vertices belonging to cells (the vertex indices per cell have to be in clockwise or counterclockwise ordering)
[out]	grid_id	id of generated grid

Remarks: See Ordering of edges; YAC will check all edges of the grid and determine whether they are on circles of longitudes (same x coordinate) or latitudes (same y coordinate). An edge that does not fulfill this condition will cause an error.

Definition at line 4639 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_mask()

void yac_cdef_mask	(	int const	grid_id,
		int const	nbr_points,
		int const	location,
		int const *	is_valid,
		int *	mask_id )

define a mask for a grid

Parameters

[in]	grid_id	grid ID
[in]	nbr_points	number of points
[in]	location	cell/vertex/edge
[in]	is_valid	0 for points that are masked out, 1 for valid points
[out]	mask_id	returned handle to the mask struct

Examples: test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, and test_dummy_coupling_raw_c.c.

Definition at line 1173 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_mask_named()

void yac_cdef_mask_named	(	int const	grid_id,
		int const	nbr_points,
		int const	location,
		int const *	is_valid,
		char const *	name,
		int *	mask_id )

define a named mask for a grid

Parameters

[in]	grid_id	grid ID
[in]	nbr_points	number of points
[in]	location	cell/vertex/edge
[in]	is_valid	0 for points that are masked out, 1 for valid points
[in]	name	name of the mask
[out]	mask_id	returned handle to the mask struct

Examples: test_dummy_coupling9_c.c.

Definition at line 1154 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cdef_points_curve2d()

void yac_cdef_points_curve2d	(	int const	grid_id,
		int const *	nbr_points,
		int const	location,
		double const *	x_points,
		double const *	y_points,
		int *	point_id )

Definition of a set of points for 2D curvilinear grids.

Parameters

[in]	grid_id	handle to the grid struct
[in]	nbr_points	number of points
[in]	location	location of points
[in]	x_points	array of point longitudes, in radians
[in]	y_points	array of point latitudes, in radians
[out]	point_id	returned handle to the points struct

Remarks

This routine supports points defined on cells or vertices. For edges use yac_cdef_points_unstruct instead.
The array x_points and y_points are expected to be of size nbr_points[0] * nbr_points[1].
See yac_cdef_grid_curve2d on how the coordinates are being interpreted.

Examples: test_dummy_coupling6_c.c.

Definition at line 1028 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_points_reg2d()

void yac_cdef_points_reg2d	(	int const	grid_id,
		int const *	nbr_points,
		int const	location,
		double const *	x_points,
		double const *	y_points,
		int *	point_id )

Definition of a set of points for 2D regular grids.

Parameters

[in]	grid_id	handle to the grid struct
[in]	nbr_points	number of points
[in]	location	location of points
[in]	x_points	array of point longitudes, in radians
[in]	y_points	array of point latitudes, in radians
[out]	point_id	returned handle to the points struct

Remarks

This routine supports points defined on cells or vertices. For edges use yac_cdef_points_unstruct instead.
The array x_points and y_points are expected to be of size nbr_points[0] and nbr_points[1] respectively.
See yac_cdef_grid_reg2d on how the coordinates are being interpreted.

Examples: test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, and test_query_routines_c.c.

Definition at line 992 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_points_reg2d_rot()

void yac_cdef_points_reg2d_rot	(	int const	grid_id,
		int const *	nbr_points,
		int const	location,
		double const *	x_points,
		double const *	y_points,
		double	x_north_pole,
		double	y_north_pole,
		int *	point_id )

Definition of a set of points for 2D regular rotated grid.

Parameters

[in]	grid_id	handle to the grid struct
[in]	nbr_points	number of points
[in]	location	location of points
[in]	x_points	array of point longitudes, in radians
[in]	y_points	array of point latitudes, in radians
[in]	x_north_pole	longitude of the north pole, in radians
[in]	y_north_pole	latitude of the north pole, in radians
[out]	point_id	returned handle to the points struct

Remarks

This routine supports points defined on cells or vertices. For edges use yac_cdef_points_unstruct instead.
The array x_points and y_points are expected to be of size nbr_points[0] and nbr_points[1] respectively.
See yac_cdef_grid_reg2d_rot on how the coordinates are being interpreted.

Definition at line 1093 of file yac.c.

Here is the call graph for this function:

◆ yac_cdef_points_unstruct()

void yac_cdef_points_unstruct	(	int const	grid_id,
		int const	nbr_points,
		int const	location,
		double const *	x_points,
		double const *	y_points,
		int *	point_id )

Definition of a set of points for 2D unstructured grids.

Parameters

[in]	grid_id	handle to the grid struct
[in]	nbr_points	number of points
[in]	location	location of points
[in]	x_points	array of point longitudes, in radians
[in]	y_points	array of point latitudes, in radians
[out]	point_id	returned handle to the points struct

Remarks: The array x_points and y_points are expected to be of size nbr_points.

See also: yac_cdef_grid_unstruct

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 1066 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cenable_field_frac_mask()

void yac_cenable_field_frac_mask	(	const char *	comp_name,
		const char *	grid_name,
		const char *	field_name,
		double	frac_mask_fallback_value )

Enables fractional masking for a coupling field and sets the fallback value

Parameters

[in]	comp_name
[in]	grid_name
[in]	field_name
[in]	frac_mask_fallback_value	fractional mask fallback value

Remarks: If this field is used as a source in couple, the user will have to provide a fractional mask for all source points along with the source field values in all put/exchange operations of this field. (see Dynamic fractional masking)

Examples: test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, and test_dummy_coupling_raw_c.c.

Definition at line 1317 of file yac.c.

Here is the call graph for this function:

◆ yac_cenable_field_frac_mask_instance()

void yac_cenable_field_frac_mask_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name,
		const char *	field_name,
		double	frac_mask_fallback_value )

Enables fractional masking for a coupling field and sets the fallback value

Parameters

[in]	yac_instance_id
[in]	comp_name
[in]	grid_name
[in]	field_name
[in]	frac_mask_fallback_value	fractional mask fallback value

Remarks: If this field is used as a source in couple, the user will have to provide a fractional mask for all source points along with the source field values in all put/exchange operations of this field. (see Dynamic fractional masking)

Examples: test_dummy_coupling7_c.c.

Definition at line 1305 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cenddef()

void yac_cenddef ( void )

End of the definition phase for the default YAC instance and setup of internal data structures for coupling (communication matrices and interpolation weights)

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, test_restart2.c, and test_restart_c.c.

Definition at line 4166 of file yac.c.

Here is the call graph for this function:

◆ yac_cenddef_and_emit_config()

void yac_cenddef_and_emit_config	(	int	emit_flags,
		char **	config )

End of the definition phase for the default YAC instance, invocation of the search and setup of internal data structures for coupling (communication matrices and interpolation weights). In addition, the collected coupling configuration from all processes is emitted.

Parameters

[in]	emit_flags	flags for configuring the generated coupling configuration output (YAC_YAML_EMITTER_DEFAULT or YAC_YAML_EMITTER_JSON)
[out]	config	coupling configuration

Remarks: the user is responsible for freeing the returned coupling configuration

Examples: test_restart_c.c.

Definition at line 4181 of file yac.c.

Here is the call graph for this function:

◆ yac_cenddef_and_emit_config_instance()

void yac_cenddef_and_emit_config_instance	(	int	yac_instance_id,
		int	emit_flags,
		char **	config )

End of the definition phase, invocation of the search and setup of internal data structures for coupling (communication matrices and interpolation weights). In addition, the collected coupling configuration from all processes is emitted.

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	emit_flags	flags for configuring the generated coupling configuration output (YAC_YAML_EMITTER_DEFAULT or YAC_YAML_EMITTER_JSON)
[out]	config	coupling configuration

Remarks: the user is responsible for freeing the returned coupling configuration

Definition at line 4172 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cenddef_instance()

void yac_cenddef_instance ( int yac_instance_id )

End of the definition phase, invocation of the search and setup of internal data structures for coupling (communication matrices and interpolation weights)

Parameters

[in] yac_instance_id id of the YAC instance

Examples: test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, and test_dynamic_config_c.c.

Definition at line 4159 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cexchange()

void yac_cexchange	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double ***const	send_field,
		double **	recv_field,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Exchange of the coupling fields

Parameters

[in]	send_field_id	-
[in]	recv_field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	recv_field	- receive buffer dimensions: recv_field[collection_size][nbr_points]
[out]	send_info	- returned send info
[out]	recv_info	- returned recv info
[out]	ierror	- returned error

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, and test_dummy_coupling7_c.c.

Definition at line 4111 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cexchange_()

void yac_cexchange_	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double *	send_field,
		double *	recv_field,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Exchange of the coupling fields

Parameters

[in]	send_field_id	-
[in]	recv_field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer (all data is stored in one contiguous part of the memory) dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	recv_field	- receive buffer (all data is stored in one contiguous part of the memory) dimensions: recv_field[collection_size][nbr_points]
[out]	send_info	- returned send info
[out]	recv_info	- returned recv info
[out]	ierror	- returned error

Definition at line 3501 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cexchange_frac()

void yac_cexchange_frac	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double ***const	send_field,
		double ***const	send_frac_mask,
		double **	recv_field,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Exchange of the coupling fields

Parameters

[in]	send_field_id	-
[in]	recv_field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	send_frac_mask	- send fractional mask dimensions send_frac_mask[collection_size] [nbr_fields] [nbr_points]
[in]	recv_field	- receive buffer dimensions: recv_field[collection_size][nbr_points]
[out]	send_info	- returned send info
[out]	recv_info	- returned recv info
[out]	ierror	- returned error

Examples: test_dummy_coupling7_c.c.

Definition at line 3799 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cexchange_frac_()

void yac_cexchange_frac_	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double *	send_field,
		double *	send_frac_mask,
		double *	recv_field,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Exchange of the coupling fields

Parameters

[in]	send_field_id	-
[in]	recv_field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer (all data is stored in one contiguous part of the memory) dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	send_frac_mask	- send fractional mask (all data is stored in one contiguous part of the memory) dimensions send_frac_mask[collection_size] [nbr_fields] [nbr_points]
[in]	recv_field	- receive buffer (all data is stored in one contiguous part of the memory) dimensions: recv_field[collection_size][nbr_points]
[out]	send_info	- returned send info
[out]	recv_info	- returned recv info
[out]	ierror	- returned error

Definition at line 3612 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cexchange_frac_ptr_()

void yac_cexchange_frac_ptr_	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double **	send_field,
		double **	send_frac_mask,
		double **	recv_field,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	send_field_id
[in]	recv_field_id
[in]	collection_size
[in]	send_field	send buffer dimensions send_field[collection_size * nbr_fields] [nbr_points]
[in]	send_frac_mask	send buffer dimensions send_frac_mask[collection_size * nbr_fields] [nbr_points]
[in]	recv_field	receive buffer dimensions: recv_field[collection_size][nbr_points]
[out]	send_info	returned send info
[out]	recv_info	returned recv info
[out]	ierror	returned error

Examples: test_dummy_coupling7_c.c.

Definition at line 3716 of file yac.c.

Here is the call graph for this function:

◆ yac_cexchange_ptr_()

void yac_cexchange_ptr_	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double **	send_field,
		double **	recv_field,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	send_field_id	-
[in]	recv_field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer dimensions send_field[collection_size * nbr_fields] [nbr_points]
[in]	recv_field	- receive buffer dimensions: recv_field[collection_size][nbr_points]
[out]	send_info	- returned send info
[out]	recv_info	- returned recv info
[out]	ierror	- returned error

Definition at line 3651 of file yac.c.

Here is the call graph for this function:

◆ yac_cexchange_raw()

void yac_cexchange_raw	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double ***const	send_field,
		double ***	src_field_buffer,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Exchange of the source points required for the interpolation of the local target field

Parameters

[in]	send_field_id
[in]	recv_field_id
[in]	collection_size
[in]	send_field	send buffer (all data is stored in one contiguous part of the memory) dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	src_field_buffer	source field buffer (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	send_info	returned send info
[out]	recv_info	returned recv info
[out]	ierror	returned error

Examples: test_dummy_coupling_raw_c.c.

Definition at line 4126 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cexchange_raw_()

void yac_cexchange_raw_	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double *	send_field,
		double *	src_field_buffer,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Exchange of the source points required for the interpolation of the local target field

Parameters

[in]	send_field_id
[in]	recv_field_id
[in]	collection_size
[in]	send_field	send buffer (all data is stored in one contiguous part of the memory) dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	src_field_buffer	source field buffer (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	send_info	returned send info
[out]	recv_info	returned recv info
[out]	ierror	returned error

Definition at line 3591 of file yac.c.

Here is the call graph for this function:

◆ yac_cexchange_raw_frac()

void yac_cexchange_raw_frac	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double ***const	send_field,
		double ***const	send_frac_mask,
		double ***	src_field_buffer,
		double ***	src_frac_mask_buffer,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Exchange of the source points required for the interpolation of the local target field

Parameters

[in]	send_field_id
[in]	recv_field_id
[in]	collection_size
[in]	send_field	send buffer dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	send_frac_mask	send fractional mask dimensions send_frac_mask[collection_size] [nbr_fields] [nbr_points]
[in]	src_field_buffer	source field buffer (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[in]	src_frac_mask_buffer	source fractional mask buffer (dimensions: src_frac_mask_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	send_info	returned send info
[out]	recv_info	returned recv info
[out]	ierror	returned error

Remarks: source field values in the src_field_buffer have already been weighted, by the fractional mask

Examples: test_dummy_coupling_raw_c.c.

Definition at line 3915 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cexchange_raw_frac_()

void yac_cexchange_raw_frac_	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double *	send_field,
		double *	send_frac_mask,
		double *	src_field_buffer,
		double *	src_frac_mask_buffer,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Exchange of the source points required for the interpolation of the local target field

Parameters

[in]	send_field_id
[in]	recv_field_id
[in]	collection_size
[in]	send_field	send buffer (all data is stored in one contiguous part of the memory) dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	send_frac_mask	send fractional mask (all data is stored in one contiguous part of the memory) dimensions send_frac_mask[collection_size] [nbr_fields] [nbr_points]
[in]	src_field_buffer	source field buffer (all data is stored in one contiguous part of the memory) (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[in]	src_frac_mask_buffer	source fractional mask buffer (all data is stored in one contiguous part of the memory) (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	send_info	returned send info
[out]	recv_info	returned recv info
[out]	ierror	returned error

Remarks: source field values in the src_field_buffer have already been weighted, by the fractional mask

Definition at line 3533 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cexchange_raw_frac_ptr_()

void yac_cexchange_raw_frac_ptr_	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double **	send_field,
		double **	send_frac_mask,
		double **	src_field_buffer,
		double **	src_frac_mask_buffer,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	send_field_id
[in]	recv_field_id
[in]	collection_size
[in]	send_field	send buffer dimensions send_field[collection_size * nbr_fields] [nbr_points]
[in]	send_frac_mask	send buffer dimensions send_frac_mask[collection_size * nbr_fields] [nbr_points]
[in]	src_field_buffer	source field buffer (all data is stored in one contiguous part of the memory) (dimensions: src_field_buffer [collection_size * num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[in]	src_frac_mask_buffer	source fractional mask buffer (all data is stored in one contiguous part of the memory) (dimensions: src_field_buffer [collection_size * num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	send_info	returned send info
[out]	recv_info	returned recv info
[out]	ierror	returned error

Definition at line 3749 of file yac.c.

Here is the call graph for this function:

◆ yac_cexchange_raw_ptr_()

void yac_cexchange_raw_ptr_	(	int const	send_field_id,
		int const	recv_field_id,
		int const	collection_size,
		double **	send_field,
		double **	src_field_buffer,
		int *	send_info,
		int *	recv_info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	send_field_id
[in]	recv_field_id
[in]	collection_size
[in]	send_field	send buffer dimensions send_field[collection_size * nbr_fields] [nbr_points]
[in]	src_field_buffer	source field buffer (all data is stored in one contiguous part of the memory) (dimensions: src_field_buffer [collection_size * num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	send_info	returned send info
[out]	recv_info	returned recv info
[out]	ierror	returned error

Definition at line 3679 of file yac.c.

Here is the call graph for this function:

◆ yac_cfinalize()

void yac_cfinalize ( )

Finalises YAC.

First cleans up the default YAC instance, if it was initialised and not yet cleaned up by a call to yac_ccleanup. If there are no remaining YAC instances, MPI and yaxt will be finalised (if initialised by YAC) and instance independed memory allocated by YAC will be freed.

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, test_query_routines_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 635 of file yac.c.

Here is the call graph for this function:

◆ yac_cfinalize_instance()

void yac_cfinalize_instance ( int yac_instance_id )

Finalises YAC.

First cleans up the provided YAC instance, if it was initialised and not yet cleaned up by a call to yac_ccleanup_instance. If there are no remaining YAC instances, MPI and yaxt will be finalised (if initialised by YAC) and instance independed memory allocated by YAC will be freed.

Parameters

[in] yac_instance_id id of the YAC instance to be finalised

Examples: test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dynamic_config_c.c, and test_query_routines_c.c.

Definition at line 626 of file yac.c.

Here is the call graph for this function:

◆ yac_cfree_ext_couple_config()

void yac_cfree_ext_couple_config ( int ext_couple_config_id )

Frees an extended coupling configuration

Parameters

[in] ext_couple_config_id

Examples: test_dummy_coupling7_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_raw_c.c, and test_dynamic_config_c.c.

Definition at line 1434 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cfree_interp_stack_config()

void yac_cfree_interp_stack_config ( int interp_stack_config_id )

frees a stack trace

Parameters

[in] interp_stack_config_id interpolation stack

Examples: test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 4867 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget()

void yac_cget	(	int const	field_id,
		int const	collection_size,
		double **	recv_field,
		int *	info,
		int *	ierror )

Receiving of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	recv_field	- receive buffer dimensions: recv_field[collection_size][nbr_points]
[out]	info	- returned info argument indicating the action performed
[out]	ierror	- returned error

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 2532 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_()

void yac_cget_	(	int const	field_id,
		int const	collection_size,
		double *	recv_field,
		int *	info,
		int *	ierror )

Receiving of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	recv_field	- receive buffer (all data is stored in one contiguous part of the memory) dimensions: recv_field[collection_size][nbr_points]
[in]	info	- returned info argument indicating the action performed
[out]	ierror	- returned error

Examples: test_dummy_coupling4_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, and test_multithreading.c.

Definition at line 2514 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_action()

void yac_cget_action	(	int	field_id,
		int *	action )

Returns the action a put/get would return for the current timestep

Parameters

[in]	field_id	field id returned by yac_cdef_field
[out]	action	action for the current timestep (YAC_ACTION_NONE, YAC_ACTION_REDUCTION, YAC_ACTION_COUPLING, YAC_ACTION_GET_FOR_RESTART, YAC_ACTION_PUT_FOR_RESTART, or YAC_ACTION_OUT_OF_BOUND)

Remarks: If the exchange type of the field is YAC_EXCHANGE_TYPE_NONE, this routine will return YAC_ACTION_NONE.; If this routine is called before yac_cenddef, the behaviour is undefined.

Examples: test_dummy_coupling5_c.c.

Definition at line 2163 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_async()

void yac_cget_async	(	int const	field_id,
		int const	collection_size,
		double **	recv_field,
		int *	info,
		int *	ierror )

Receiving of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	recv_field	- receive buffer dimensions: recv_field[collection_size][nbr_points]
[out]	info	- returned info argument indicating the action performed
[out]	ierror	- returned error

Remarks: This routine returns immediately without waiting for the receive operation to be completed. The user should not access the memory associated with recv_field until this is the case. This can be achieved by calling yac_cwait.

Examples: test_dummy_coupling_c.c.

Definition at line 2541 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_async_()

void yac_cget_async_	(	int const	field_id,
		int const	collection_size,
		double *	recv_field,
		int *	info,
		int *	ierror )

Receiving of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	recv_field	- receive buffer (all data is stored in one contiguous part of the memory) dimensions: recv_field[collection_size][nbr_points]
[in]	info	- returned info argument indicating the action performed
[out]	ierror	- returned error

Remarks: This routine returns immediately without waiting for the receive operation to be completed. The user should not access the memory associated with recv_field until this is the case. This can be achieved by calling yac_cwait.

Examples: test_dummy_coupling9_c.c.

Definition at line 2523 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_calendar()

int yac_cget_calendar ( )

Gets the calendar of the default instance

Examples: test_dummy_coupling_c.c.

Definition at line 681 of file yac.c.

Here is the caller graph for this function:

◆ yac_cget_collection_size_from_field_id()

int yac_cget_collection_size_from_field_id ( int field_id )

query routine to get the collection_size of a field for a given ID

Parameters

[in] field_id ID as provided by yac_cdef_field

Returns: collection_size

Examples: test_dummy_coupling3_c.c, test_dummy_coupling_c.c, and test_query_routines_c.c.

Definition at line 4466 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_comp_comm()

void yac_cget_comp_comm	(	int	comp_id,
		MPI_Comm *	comp_comm )

Providing the component MPI communicator

Parameters

[in]	comp_id	local component ID (from yac_cdef_comp), handle to the component struct
[out]	comp_comm	component communicator

Examples: test_dummy_coupling3_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 745 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_comp_grid_names()

void yac_cget_comp_grid_names	(	const char *	comp_name,
		int	nbr_grids,
		const char **	grid_names )

query routine to get the list of grid names of a given component that are referenced by at least one defined field or have metadata assigned to it

Parameters

[in]	comp_name	name of the component
[in]	nbr_grids	number of grids
[out]	grid_names	list of grid names

Examples: test_query_routines_c.c.

Definition at line 4385 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_comp_grid_names_instance()

void yac_cget_comp_grid_names_instance	(	int	yac_instance_id,
		const char *	comp_name,
		int	nbr_grids,
		const char **	grid_names )

query routine to get the list of grid names of a given component that are referenced by at least one defined field or have metadata assigned to it

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	comp_name	name of the component
[in]	nbr_grids	number of grids
[out]	grid_names	list of grid names

Examples: test_query_routines_c.c.

Definition at line 4343 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_comp_names()

void yac_cget_comp_names	(	int	nbr_comps,
		const char **	comp_names )

query routine to get the list of component names for defined the default YAC instance.

Parameters

[in]	nbr_comps	number of components
[out]	comp_names	list of component names

Examples: test_query_routines_c.c.

Definition at line 4312 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_comp_names_instance()

void yac_cget_comp_names_instance	(	int	yac_instance_id,
		int	nbr_comps,
		const char **	comp_names )

query routine to get the list of component names for defined

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	nbr_comps	number of components
[out]	comp_names	list of component names

Examples: test_query_routines_c.c.

Definition at line 4292 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_comp_nbr_grids()

int yac_cget_comp_nbr_grids ( const char * comp_name )

query routine for number of grids defined in the default YAC instance for a given components that is referenced by at least one defined field.

Parameters

[in] comp_name

Returns: number of components

Examples: test_query_routines_c.c.

Definition at line 4262 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_comp_nbr_grids_instance()

int yac_cget_comp_nbr_grids_instance	(	int	yac_instance_id,
		const char *	comp_name )

query routine for number of grids defined for a given components that is referenced by at least one defined field.

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	comp_name

Returns: number of components

Examples: test_query_routines_c.c.

Definition at line 4239 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_comp_rank_c2py()

void yac_cget_comp_rank_c2py	(	int	comp_id,
		int *	rank )

Examples: test_query_routines_c.c.

Definition at line 774 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_comp_size_c2py()

void yac_cget_comp_size_c2py	(	int	comp_id,
		int *	size )

Examples: test_query_routines_c.c.

Definition at line 767 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_component_metadata()

const char * yac_cget_component_metadata ( const char * comp_name )

Get metadata for a component

Parameters

[in] comp_name

Returns: metadata (NULL if no metadata is defined)

Examples: test_query_routines_c.c.

Definition at line 1377 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_component_metadata_instance()

const char * yac_cget_component_metadata_instance	(	int	yac_instance_id,
		const char *	comp_name )

Get metadata for a component

Parameters

[in]	yac_instance_id
[in]	comp_name

Returns: metadata (NULL if no metadata is defined)

Examples: test_query_routines_c.c.

Definition at line 1369 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_component_name_from_field_id()

const char * yac_cget_component_name_from_field_id ( int field_id )

query routine to get the component name for a given ID

Parameters

[in] field_id ID as provided by yac_cdef_field

Returns: comp_name component name of the fields component. (array of length YAC_MAX_CHARLEN)

Examples: test_query_routines_c.c.

Definition at line 4437 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_comps_comm()

void yac_cget_comps_comm	(	const char **	comp_names,
		int	num_comps,
		MPI_Comm *	comps_comm )

Generates an MPI communicator that contains all processes of the provided components

Parameters

[in]	comp_names	name of components
[in]	num_comps	number of components
[out]	comps_comm	generated communicator

Remarks: the components have to defined in the default YAC instance; the local process has to be in at least one of the provided components; this call is collective for all processes in the provided components

Examples: test_dummy_coupling3_c.c, test_dummy_coupling6_c.c, and test_dummy_coupling7_c.c.

Definition at line 795 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_comps_comm_f2c()

void yac_cget_comps_comm_f2c	(	char const **	comp_names,
		int	num_comps,
		MPI_Fint *	comps_comm_f )

Definition at line 815 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_comps_comm_instance()

void yac_cget_comps_comm_instance	(	int	yac_instance_id,
		const char **	comp_names,
		int	num_comps,
		MPI_Comm *	comps_comm )

Generates an MPI communicator that contains all processes of the provided components

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	comp_names	name of components
[in]	num_comps	number of components
[out]	comps_comm	generated communicator

Remarks: the local process has to be in at least one of the provided components; this call is collective for all processes in the provided components

Examples: test_dummy_coupling6_c.c, and test_dummy_coupling7_c.c.

Definition at line 785 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_comps_comm_instance_f2c()

void yac_cget_comps_comm_instance_f2c	(	int	yac_instance_id,
		char const **	comp_names,
		int	num_comps,
		MPI_Fint *	comps_comm_f )

Definition at line 805 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_default_instance_id()

int yac_cget_default_instance_id ( )

Getter function for the default instance

Returns the instance id of the default instance.

Remarks: The default instance needs to be initialised before calling this function.

Returns: The instance id of the default instance

Definition at line 392 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_end_datetime()

char * yac_cget_end_datetime ( void )

query routine for the end datetime of the job of the default YAC instance

Examples: test_dummy_coupling3_c.c.

Definition at line 710 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_end_datetime_instance()

char * yac_cget_end_datetime_instance ( int yac_instance_id )

query routine for the end datetime of the job

Parameters

[in] yac_instance_id id of the YAC instance

Examples: test_dummy_coupling3_c.c.

Definition at line 703 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_ext_couple_config()

void yac_cget_ext_couple_config ( int * ext_couple_config_id )

Get an extended coupling configuration (all parameters are set to the default values)

Parameters

[out] ext_couple_config_id extended coupling configuration

Examples: test_dummy_coupling7_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_raw_c.c, and test_dynamic_config_c.c.

Definition at line 1426 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_ext_couple_config_mapping_side()

void yac_cget_ext_couple_config_mapping_side	(	int	ext_couple_config_id,
		int *	mapping_side )

Gets the mapping side

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[out]	mapping_side	mapping side

Examples: test_dynamic_config_c.c.

Definition at line 1518 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_ext_couple_config_scale_factor()

void yac_cget_ext_couple_config_scale_factor	(	int	ext_couple_config_id,
		double *	scale_factor )

Gets the scale factor

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[out]	scale_factor	scale_factor

Examples: test_dynamic_config_c.c.

Definition at line 1541 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_ext_couple_config_scale_summand()

void yac_cget_ext_couple_config_scale_summand	(	int	ext_couple_config_id,
		double *	scale_summand )

Gets the scale summand

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[out]	scale_summand	scale_summand

Examples: test_dynamic_config_c.c.

Definition at line 1564 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_ext_couple_config_src_mask_names()

void yac_cget_ext_couple_config_src_mask_names	(	int	ext_couple_config_id,
		size_t *	num_src_mask_names,
		char const const *	src_mask_names )

Gets source mask names

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[out]	num_src_mask_names	number of source mask names
[out]	src_mask_names	source mask names

Examples: test_dummy_coupling9_c.c.

Definition at line 1595 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_ext_couple_config_tgt_mask_name()

void yac_cget_ext_couple_config_tgt_mask_name	(	int	ext_couple_config_id,
		char const **	tgt_mask_name )

Gets target mask name

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[out]	tgt_mask_name	target mask name

Examples: test_dummy_coupling9_c.c.

Definition at line 1619 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_ext_couple_config_use_raw_exchange()

void yac_cget_ext_couple_config_use_raw_exchange	(	int	ext_couple_config_id,
		int *	use_raw_exchange )

Gets use of raw exchange

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[out]	use_raw_exchange	use raw exchange

Examples: test_dynamic_config_c.c.

Definition at line 1661 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_ext_couple_config_weight_file()

void yac_cget_ext_couple_config_weight_file	(	int	ext_couple_config_id,
		char const **	weight_file )

Gets the weight file name

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[out]	weight_file	name of the weight file, if it is set; NULL otherwise

Examples: test_dynamic_config_c.c.

Definition at line 1461 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_ext_couple_config_weight_file_on_existing()

void yac_cget_ext_couple_config_weight_file_on_existing	(	int	ext_couple_config_id,
		int *	weight_file_on_existing )

Gets how already existing weight files are handled

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	weight_file_on_existing	handling of existing weight files

Examples: test_dynamic_config_c.c.

Definition at line 1492 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_ext_couple_config_yaxt_exchanger_name()

void yac_cget_ext_couple_config_yaxt_exchanger_name	(	int	ext_couple_config_id,
		char const **	yaxt_exchanger_name )

Gets yaxt exchanger name

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[out]	yaxt_exchanger_name	yaxt exchanger name

Examples: test_dynamic_config_c.c.

Definition at line 1641 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_collection_size()

int yac_cget_field_collection_size	(	const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the collection_size of a field

Parameters

[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: collection_size

Examples: test_query_routines_c.c.

Definition at line 4530 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_collection_size_instance()

int yac_cget_field_collection_size_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the collection_size of a field

Parameters

[in]	yac_instance_id
[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: collection_size

Examples: test_query_routines_c.c.

Definition at line 4512 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_field_datetime()

const char * yac_cget_field_datetime ( int field_id )

Returns the current datetime of the field

Parameters

[in] field_id

Returns: current datetime of the field

Examples: test_dynamic_config_c.c.

Definition at line 2206 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_field_frac_mask_fallback_value()

double yac_cget_field_frac_mask_fallback_value	(	const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the fractional mask fallback value of a field

Parameters

[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: frac_mask_fallback_value

Remarks: if YAC_FRAC_MASK_NO_VALUE is returned, then no fractional mask fallback value is defined for this field

Examples: test_dummy_coupling7_c.c.

Definition at line 4522 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_frac_mask_fallback_value_instance()

double yac_cget_field_frac_mask_fallback_value_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the fractional mask fallback value of a field

Parameters

[in]	yac_instance_id
[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: frac_mask_fallback_value

Remarks: if YAC_FRAC_MASK_NO_VALUE is returned, then no fractional mask fallback value is defined for this field

Examples: test_dummy_coupling7_c.c.

Definition at line 4501 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_field_id()

int yac_cget_field_id	(	const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the field_id from component, grid and field name (if defined on this process)

Parameters

[in]	comp_name	component name
[in]	grid_name	grid name
[in]	field_name	field name

Returns: field_id

Examples: test_query_routines_c.c.

Definition at line 4205 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_id_instance()

int yac_cget_field_id_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the field_id from component, grid and field name (if defined on this process)

Parameters

[in]	yac_instance_id
[in]	comp_name	component name
[in]	grid_name	grid name
[in]	field_name	field name

Returns: field_id

Examples: test_query_routines_c.c.

Definition at line 4192 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_field_metadata()

const char * yac_cget_field_metadata	(	const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

Get metadata for a field

Parameters

[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: metadata (NULL if no metadata is defined)

Examples: test_query_routines_c.c.

Definition at line 1404 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_metadata_instance()

const char * yac_cget_field_metadata_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

Get metadata for a field

Parameters

[in]	yac_instance_id
[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: metadata (NULL if no metadata is defined)

Examples: test_query_routines_c.c.

Definition at line 1395 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_field_name_from_field_id()

const char * yac_cget_field_name_from_field_id ( int field_id )

query routine to get the field name for a given ID

Parameters

[in] field_id ID as provided by yac_cdef_field

Returns: field_name field name that has been given to yac_cdef_field. (array of length YAC_MAX_CHARLEN)

Examples: test_query_routines_c.c.

Definition at line 4452 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_names()

void yac_cget_field_names	(	const char *	comp_name,
		const char *	grid_name,
		int	nbr_fields,
		const char **	field_names )

query routine to get the list of field names defined on the given component and grid for the default YAC instance.

Parameters

[in]	comp_name	component name
[in]	grid_name	grid name
[in]	nbr_fields	number of fields
[out]	field_names	list of field names

Examples: test_query_routines_c.c.

Definition at line 4430 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_names_instance()

void yac_cget_field_names_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name,
		int	nbr_fields,
		const char **	field_names )

query routine to get the list of field names on the given component and grid

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	comp_name	component name
[in]	grid_name	grid name
[in]	nbr_fields	number of fields
[out]	field_names	list of grid names

Examples: test_query_routines_c.c.

Definition at line 4391 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_field_role()

int yac_cget_field_role	(	const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the role of a field for a given ID

Parameters

[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: role exchange type of the field
(YAC_EXCHANGE_TYPE_NONE, YAC_EXCHANGE_TYPE_SOURCE, or YAC_EXCHANGE_TYPE_TARGET)

Remarks: the role is set by the call to yac_cenddef or yac_cenddef_instance

Examples: test_query_routines_c.c.

Definition at line 4548 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_role_instance()

int yac_cget_field_role_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the role of a field for a given ID

Parameters

[in]	yac_instance_id
[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: role exchange type of the field
(YAC_EXCHANGE_TYPE_NONE, YAC_EXCHANGE_TYPE_SOURCE, or YAC_EXCHANGE_TYPE_TARGET)

Remarks: the role is set by the call to yac_cenddef or yac_cenddef_instance

Examples: test_query_routines_c.c.

Definition at line 4537 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_field_source()

void yac_cget_field_source	(	const char *	tgt_comp_name,
		const char *	tgt_grid_name,
		const char *	tgt_field_name,
		const char **	src_comp_name,
		const char **	src_grid_name,
		const char **	src_field_name )

query routine to get the source field for a given target field

Parameters

[in]	tgt_comp_name
[in]	tgt_grid_name
[in]	tgt_field_name
[out]	src_comp_name
[out]	src_grid_name
[out]	src_field_name

Examples: test_dummy_coupling6_c.c.

Definition at line 4569 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_source_instance()

void yac_cget_field_source_instance	(	int	yac_instance_id,
		const char *	tgt_comp_name,
		const char *	tgt_grid_name,
		const char *	tgt_field_name,
		const char **	src_comp_name,
		const char **	src_grid_name,
		const char **	src_field_name )

query routine to get the source field for a given target field

Parameters

[in]	yac_instance_id
[in]	tgt_comp_name
[in]	tgt_grid_name
[in]	tgt_field_name
[out]	src_comp_name
[out]	src_grid_name
[out]	src_field_name

Examples: test_dummy_coupling6_c.c.

Definition at line 4555 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_field_timestep()

const char * yac_cget_field_timestep	(	const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the timestep of a field

Parameters

[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: timestep timestep that has been given to yac_cdef_field iso8601 string (array of length YAC_MAX_CHARLEN)

Examples: test_query_routines_c.c.

Definition at line 4494 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_field_timestep_instance()

const char * yac_cget_field_timestep_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name,
		const char *	field_name )

query routine to get the timestep of a field

Parameters

[in]	yac_instance_id
[in]	comp_name
[in]	grid_name
[in]	field_name

Returns: timestep timestep that has been given to yac_cdef_field iso8601 string (array of length YAC_MAX_CHARLEN)

Examples: test_query_routines_c.c.

Definition at line 4482 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_grid_metadata()

const char * yac_cget_grid_metadata ( const char * grid_name )

Get metadata for a grid

Parameters

[in] grid_name

Returns: metadata (NULL if no metadata is defined)

Examples: test_query_routines_c.c.

Definition at line 1390 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_grid_metadata_instance()

const char * yac_cget_grid_metadata_instance	(	int	yac_instance_id,
		const char *	grid_name )

Get metadata for a grid

Parameters

[in]	yac_instance_id
[in]	grid_name

Returns: metadata (NULL if no metadata is defined)

Examples: test_query_routines_c.c.

Definition at line 1382 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_grid_name_from_field_id()

const char * yac_cget_grid_name_from_field_id ( int field_id )

query routine to get the grid name for a given ID

Parameters

[in] field_id ID as provided by yac_cdef_field

Returns: grid_name grid name of the fields grid. (array of length YAC_MAX_CHARLEN)

Examples: test_query_routines_c.c.

Definition at line 4444 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_grid_names()

void yac_cget_grid_names	(	int	nbr_grids,
		const char **	grid_names )

query routine to get the list of grid names of the default YAC instance that are referenced by at least one defined field or have metadata assigned to it

Parameters

[in]	nbr_grids	number of grids
[out]	grid_names	list of grid names

Examples: test_query_routines_c.c.

Definition at line 4338 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_grid_names_instance()

void yac_cget_grid_names_instance	(	int	yac_instance_id,
		int	nbr_grids,
		const char **	grid_names )

query routine to get the list of grid names that are referenced by at least one defined field or have metadata assigned to it

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	nbr_grids	number of grids
[out]	grid_names	list of grid names

Examples: test_query_routines_c.c.

Definition at line 4318 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_grid_size()

size_t yac_cget_grid_size	(	int	location,
		int	grid_id )

query routine to get the number of points in a grid

Parameters

[in]	location
[in]	grid_id

Examples: test_dummy_coupling2_c.c.

Definition at line 4821 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_interp_stack_config()

void yac_cget_interp_stack_config ( int * interp_stack_config_id )

gets an empty stack trace

Parameters

[out] interp_stack_config_id interpolation stack

Examples: test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, test_restart2.c, and test_restart_c.c.

Definition at line 4853 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_interp_stack_config_from_string()

static int yac_cget_interp_stack_config_from_string	(	char const *	interp_stack_config,
		int	parse_flags )

static

Definition at line 5129 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_interp_stack_config_from_string_json()

void yac_cget_interp_stack_config_from_string_json	(	char const *	interp_stack_config,
		int *	interp_stack_config_id )

generate a interpolation stack from a "0" terminated string that contains a JSON formated description of the stack

Parameters

[in]	interp_stack_config	interpolation stack description
[out]	interp_stack_config_id	interpolation stack

Examples: test_dummy_coupling7_c.c.

Definition at line 5157 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_interp_stack_config_from_string_yaml()

void yac_cget_interp_stack_config_from_string_yaml	(	char const *	interp_stack_config,
		int *	interp_stack_config_id )

generate a interpolation stack from a "0" terminated string that contains a YAML formated description of the stack

Parameters

[in]	interp_stack_config	interpolation stack description
[out]	interp_stack_config_id	interpolation stack

Examples: test_dummy_coupling7_c.c.

Definition at line 5149 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_nbr_comps()

int yac_cget_nbr_comps ( void )

query routine for number of components defined in the default YAC instance

Returns: number of components

Examples: test_query_routines_c.c.

Definition at line 4221 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_nbr_comps_instance()

int yac_cget_nbr_comps_instance ( int yac_instance_id )

query routine for number of components

Parameters

[in] yac_instance_id id of the YAC instance

Returns: number of components

Examples: test_query_routines_c.c.

Definition at line 4213 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_nbr_fields()

int yac_cget_nbr_fields	(	const char *	comp_name,
		const char *	grid_name )

query routine for number of coupling fields defined in the given component and grids of the default YAC instance

Parameters

[in]	comp_name	name of the component
[in]	grid_name	name of the grid

Returns: number of fields defined on the calling process

Examples: test_query_routines_c.c.

Definition at line 4287 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_nbr_fields_instance()

int yac_cget_nbr_fields_instance	(	int	yac_instance_id,
		const char *	comp_name,
		const char *	grid_name )

query routine for number of coupling fields defined in the given component and grids

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	comp_name	name of the component
[in]	grid_name	name of the grid

Returns: number of fields defined on the calling process

Examples: test_query_routines_c.c.

Definition at line 4267 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_nbr_grids()

int yac_cget_nbr_grids ( )

query routine for number of grids defined in the default YAC instance that are referenced by at least one defined field or have metadata assigned to it

Returns: number of fields defined on the calling process

Examples: test_query_routines_c.c.

Definition at line 4234 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_nbr_grids_instance()

int yac_cget_nbr_grids_instance ( int yac_instance_id )

query routine for number of grids that are referenced by at least one defined field or have metadata assigned to it

Parameters

[in] yac_instance_id id of the YAC instance

Returns: number of fields defined on the calling process

Examples: test_query_routines_c.c.

Definition at line 4226 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_points_size()

size_t yac_cget_points_size ( int points_id )

query routine to get the number of points in a pointset

Parameters

[in] points_id

Examples: test_dummy_coupling2_c.c.

Definition at line 4841 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_pre_processing()

static void * yac_cget_pre_processing	(	int const	field_id,
		int	collection_size,
		int *	info,
		int *	ierr )

static

Definition at line 2353 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_raw()

void yac_cget_raw	(	int const	field_id,
		int const	collection_size,
		double ***	src_field_buffer,
		int *	info,
		int *	ierror )

Receiving source points required for the interpolation of the local target field

Parameters

[in]	field_id
[in]	collection_size
[in]	src_field_buffer	source field buffer (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	info	returned info argument indicating the action performed
[out]	ierror	returned error

Examples: test_dummy_coupling_raw_c.c.

Definition at line 2736 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_raw_()

void yac_cget_raw_	(	int const	field_id,
		int const	collection_size,
		double *	src_field_buffer,
		int *	info,
		int *	ierror )

Receiving source points required for the interpolation of the local target field

Parameters

[in]	field_id
[in]	collection_size
[in]	src_field_buffer	source field buffer (all data is stored in one contiguous part of the memory) (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	info	returned info argument indicating the action performed
[out]	ierror	returned error

Definition at line 2623 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_raw_async()

void yac_cget_raw_async	(	int const	field_id,
		int const	collection_size,
		double ***	src_field_buffer,
		int *	info,
		int *	ierror )

Receiving source points required for the interpolation of the local target field

Parameters

[in]	field_id
[in]	collection_size
[in]	src_field_buffer	source field buffer (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	info	returned info argument indicating the action performed
[out]	ierror	returned error

Remarks: This routine returns immediately without waiting for the receive operation to be completed. The user should not access the memory associated with recv_field until this is the case. This can be achieved by calling yac_cwait.

Examples: test_dummy_coupling_raw_c.c.

Definition at line 2749 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_raw_async_()

void yac_cget_raw_async_	(	int const	field_id,
		int const	collection_size,
		double *	src_field_buffer,
		int *	info,
		int *	ierror )

Receiving source points required for the interpolation of the local target field

Parameters

[in]	field_id
[in]	collection_size
[in]	src_field_buffer	source field buffer (all data is stored in one contiguous part of the memory) (dimensions: src_field_buffer [collection_size * SUM(src_field_buffer_sizes)])
[out]	info	returned info argument indicating the action performed
[out]	ierror	returned error

Remarks: This routine returns immediately without waiting for the receive operation to be completed. The user should not access the memory associated with recv_field until this is the case. This can be achieved by calling yac_cwait.

Examples: test_dummy_coupling_raw_c.c.

Definition at line 2680 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_raw_async_ptr_()

void yac_cget_raw_async_ptr_	(	int const	field_id,
		int const	collection_size,
		double **	src_field_buffer,
		int *	info,
		int *	ierr )

Definition at line 2708 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_raw_frac()

void yac_cget_raw_frac	(	int const	field_id,
		int const	collection_size,
		double ***	src_field_buffer,
		double ***	src_frac_mask_buffer,
		int *	info,
		int *	ierror )

Receiving source points required for the interpolation of the local target field

Parameters

[in]	field_id
[in]	collection_size
[in]	src_field_buffer	source field buffer (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[in]	src_frac_mask_buffer	source fractional mask buffer (dimensions: src_frac_mask_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	info	returned info argument indicating the action performed
[out]	ierror	returned error

Remarks: source field values in the src_field_buffer have already been weighted, by the fractional mask

Examples: test_dummy_coupling_raw_c.c.

Definition at line 2763 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_raw_frac_()

void yac_cget_raw_frac_	(	int const	field_id,
		int const	collection_size,
		double *	src_field_buffer,
		double *	src_frac_mask_buffer,
		int *	info,
		int *	ierror )

Receiving source points required for the interpolation of the local target field

Parameters

[in]	field_id
[in]	collection_size
[in]	src_field_buffer	source field buffer (all data is stored in one contiguous part of the memory) (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[in]	src_frac_mask_buffer	source fractional mask buffer (all data is stored in one contiguous part of the memory) (dimensions: src_frac_mask_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	info	returned info argument indicating the action performed
[out]	ierror	returned error

Remarks: source field values in the src_field_buffer have already been weighted, by the fractional mask

Examples: test_dummy_coupling_raw_c.c.

Definition at line 2635 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_raw_frac_async()

void yac_cget_raw_frac_async	(	int const	field_id,
		int const	collection_size,
		double ***	src_field_buffer,
		double ***	src_frac_mask_buffer,
		int *	info,
		int *	ierror )

Receiving source points required for the interpolation of the local target field

Parameters

[in]	field_id
[in]	collection_size
[in]	src_field_buffer	source field buffer (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[in]	src_frac_mask_buffer	source fractional mask buffer (dimensions: src_frac_mask_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	info	returned info argument indicating the action performed
[out]	ierror	returned error

Remarks: source field values in the src_field_buffer have already been weighted, by the fractional mask; This routine returns immediately without waiting for the receive operation to be completed. The user should not access the memory associated with recv_field until this is the case. This can be achieved by calling yac_cwait.

Examples: test_dummy_coupling_raw_c.c.

Definition at line 2781 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_raw_frac_async_()

void yac_cget_raw_frac_async_	(	int const	field_id,
		int const	collection_size,
		double *	src_field_buffer,
		double *	src_frac_mask_buffer,
		int *	info,
		int *	ierror )

Receiving source points required for the interpolation of the local target field

Parameters

[in]	field_id
[in]	collection_size
[in]	src_field_buffer	source field buffer (all data is stored in one contiguous part of the memory) (dimensions: src_field_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[in]	src_frac_mask_buffer	source fractional mask buffer (all data is stored in one contiguous part of the memory) (dimensions: src_frac_mask_buffer [collection_size] [num_src_fields] [src_field_buffer_sizes[src_field_idx]])
[out]	info	returned info argument indicating the action performed
[out]	ierror	returned error

Remarks: source field values in the src_field_buffer have already been weighted, by the fractional mask; This routine returns immediately without waiting for the receive operation to be completed. The user should not access the memory associated with recv_field until this is the case. This can be achieved by calling yac_cwait.

Examples: test_dummy_coupling_raw_c.c.

Definition at line 2692 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_raw_frac_async_ptr_()

void yac_cget_raw_frac_async_ptr_	(	int const	field_id,
		int const	collection_size,
		double **	src_field_buffer,
		double **	src_frac_mask_buffer,
		int *	info,
		int *	ierr )

Definition at line 2720 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_raw_frac_ptr_()

void yac_cget_raw_frac_ptr_	(	int const	field_id,
		int const	collection_size,
		double **	src_field_buffer,
		double **	src_frac_mask_buffer,
		int *	info,
		int *	ierr )

Definition at line 2663 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_raw_interp_weights_data()

void yac_cget_raw_interp_weights_data	(	int const	field_id,
		double *	frac_mask_fallback_value,
		double *	scaling_factor,
		double *	scaling_summand,
		size_t *	num_fixed_values,
		double **	fixed_values,
		size_t **	num_tgt_per_fixed_value,
		size_t **	tgt_idx_fixed,
		size_t *	num_wgt_tgt,
		size_t **	wgt_tgt_idx,
		size_t **	num_src_per_tgt,
		double **	weights,
		size_t **	src_field_idx,
		size_t **	src_idx,
		size_t *	num_src_fields,
		size_t **	src_field_buffer_sizes )

Get interpolation information for raw data exchange

Parameters

[in]	field_id
[out]	frac_mask_fallback_value	fractional masking fallback value
[out]	scaling_factor	scaling factor
[out]	scaling_summand	scaling summand
[out]	num_fixed_values	number of fixed values
[out]	fixed_values	array of fixed values
[out]	num_tgt_per_fixed_value	number of target points per fixed value
[out]	tgt_idx_fixed	local target point indices that receive a fixed value
[out]	num_wgt_tgt	number of target points receiving a weighted sum of source points
[out]	wgt_tgt_idx	local target point indices that receive weighted sum of source points
[out]	num_src_per_tgt	number of source points per target point
[out]	weights	weights
[out]	src_field_idx	source field indices
[out]	src_idx	source field buffer indices
[out]	num_src_fields	number of source fields
[out]	src_field_buffer_sizes	buffer sizes of source field buffers

Remarks: If a coupling is configured for raw data exchange, target processes can extract once all information required to execute the interpolation by hand.; The user is responsible for freeing the memory associated with returned arrays.

Examples: test_dummy_coupling_raw_c.c.

Definition at line 1976 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_raw_interp_weights_data_csr()

void yac_cget_raw_interp_weights_data_csr	(	int const	field_id,
		double *	frac_mask_fallback_value,
		double *	scaling_factor,
		double *	scaling_summand,
		size_t *	num_fixed_values,
		double **	fixed_values,
		size_t **	num_tgt_per_fixed_value,
		size_t **	tgt_idx_fixed,
		size_t **	src_indptr,
		double **	weights,
		size_t **	src_field_idx,
		size_t **	src_idx,
		size_t *	num_src_fields,
		size_t **	src_field_buffer_sizes )

Get interpolation information for raw data exchange (weight matrix is stored as a sparse matrix using CSR format)

Parameters

[in]	field_id
[out]	frac_mask_fallback_value	fractional masking fallback value
[out]	scaling_factor	scaling factor
[out]	scaling_summand	scaling summand
[out]	num_fixed_values	number of fixed values
[out]	fixed_values	array of fixed values
[out]	num_tgt_per_fixed_value	number of target points per fixed value
[out]	tgt_idx_fixed	local target point indices that receive a fixed value
[out]	src_indptr	offset to weights/src_idx/src_field_idx for each local target point
[out]	weights	weights
[out]	src_field_idx	source field indices
[out]	src_idx	source field buffer indices
[out]	num_src_fields	number of source fields
[out]	src_field_buffer_sizes	buffer sizes of source field buffers

Remarks: If a coupling is configured for raw data exchange, target processes can extract once all information required to execute the interpolation by hand.; The user is responsible for freeing the memory associated with returned arrays.; Number of weights per target is computed by "src_indptr[tgt_idx+1] - src_indptr[tgt_idx]".

Examples: test_dummy_coupling_raw_c.c.

Definition at line 2016 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_raw_interp_weights_data_csr_c2f()

void yac_cget_raw_interp_weights_data_csr_c2f	(	int const	field_id,
		double *	frac_mask_fallback_value,
		double *	scaling_factor,
		double *	scaling_summand,
		size_t *	num_fixed_values,
		double **	fixed_values,
		size_t **	num_tgt_per_fixed_value,
		size_t **	tgt_idx_fixed,
		size_t **	src_indptr,
		double **	weights,
		size_t **	src_field_idx,
		size_t **	src_idx,
		size_t *	num_src_fields,
		size_t **	src_field_buffer_sizes,
		size_t *	tgt_field_data_size )

Definition at line 2123 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_raw_ptr_()

void yac_cget_raw_ptr_	(	int const	field_id,
		int const	collection_size,
		double **	src_field_buffer,
		int *	info,
		int *	ierr )

Definition at line 2651 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_role_from_field_id()

int yac_cget_role_from_field_id ( int field_id )

query routine to get the role of a field for a given ID

Parameters

[in] field_id ID as provided by yac_cdef_field

Returns: role exchange type of the field
(YAC_EXCHANGE_TYPE_NONE, YAC_EXCHANGE_TYPE_SOURCE, or YAC_EXCHANGE_TYPE_TARGET)

Remarks: the role is set by the call to yac_cenddef or yac_cenddef_instance

Examples: test_dummy_coupling3_c.c, test_dummy_coupling_c.c, and test_query_routines_c.c.

Definition at line 4473 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_start_datetime()

char * yac_cget_start_datetime ( void )

query routine for the start datetime of the job of the default YAC instance

Examples: test_dummy_coupling3_c.c.

Definition at line 695 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_start_datetime_instance()

char * yac_cget_start_datetime_instance ( int yac_instance_id )

query routine for the start datetime of the job

Parameters

[in] yac_instance_id id of the YAC instance

Examples: test_dummy_coupling3_c.c.

Definition at line 688 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cget_timestep_from_field_id()

const char * yac_cget_timestep_from_field_id ( int field_id )

query routine to get the timestep of a field for a given ID

Parameters

[in] field_id ID as provided by yac_cdef_field

Returns: timestep timestep that has been given to yac_cdef_field iso8601 string. (array of length YAC_MAX_CHARLEN)

Examples: test_dummy_coupling3_c.c, test_dummy_coupling_c.c, and test_query_routines_c.c.

Definition at line 4459 of file yac.c.

Here is the call graph for this function:

◆ yac_cget_version()

char * yac_cget_version ( void )

query routine for the yac version

Definition at line 721 of file yac.c.

Here is the caller graph for this function:

◆ yac_check_version()

static void yac_check_version ( MPI_Comm comm )

static

Definition at line 323 of file yac.c.

Here is the caller graph for this function:

◆ yac_cinit()

void yac_cinit ( void )

Elementary initialisation of the whole system

Remarks: This call initialises the default YAC instance.; A call to yac_ccleanup or yac_cfinalize is required to free all memory associated with the default YAC instance.; This call executes a MPI handshake (MPI handshake algorithm) on MPI_COMM_WORLD with the group name "yac" and uses the created communicator for the initialization. If you don't want to execute a MPI Handshake on MPI_COMM_WORLD you can call yac_cinit_comm with MPI_COMM_WORLD directly.

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, test_query_routines_c.c, and test_restart_c.c.

Definition at line 435 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cinit_comm()

void yac_cinit_comm ( MPI_Comm comm )

Elementary initialisation of the whole system using a user-provided MPI communicator

Parameters

[in] comm MPI communicator

Remarks: This call initialises the default YAC instance.; A call to yac_ccleanup or yac_cfinalize is required to free all memory associated with the default YAC instance.; the MPI communicator provided to this routine has to contain all processes that will take part in the coupling; this call is collective for all processes in comm

Examples: test_restart2.c.

Definition at line 409 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cinit_comm_dummy()

void yac_cinit_comm_dummy ( MPI_Comm comm )

Dummy initialisation of the whole system using a user-provided MPI world communicator

Parameters

[in] comm MPI communicator

Remarks: This routine can be called instead of yac_cinit_comm or yac_cinit_comm_instance, if the local process does not wish to initialise a YAC instance.

Examples: test_dummy_coupling6_c.c, and test_dummy_coupling7_c.c.

Definition at line 445 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cinit_comm_dummy_f2c()

void yac_cinit_comm_dummy_f2c ( MPI_Fint comm_f )

Definition at line 455 of file yac.c.

Here is the call graph for this function:

◆ yac_cinit_comm_f2c()

void yac_cinit_comm_f2c ( MPI_Fint comm_f )

Definition at line 418 of file yac.c.

Here is the call graph for this function:

◆ yac_cinit_comm_instance()

void yac_cinit_comm_instance	(	MPI_Comm	comm,
		int *	yac_instance_id )

Elementary initialisation of the whole system using a user-provided MPI communicator

Parameters

[in]	comm	MPI communicator
[out]	yac_instance_id	id of the YAC instance initialised by this call

Remarks: This call initialises a YAC instance.; A call to yac_ccleanup_instance or yac_cfinalize_instance is required to free all memory associated with this YAC instance.; In case the user has multiple YAC instances in parallel, he has to initialise YAXT himself.

Examples: test_dummy_coupling3_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, and test_dynamic_config_c.c.

Definition at line 397 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cinit_comm_instance_f2c()

void yac_cinit_comm_instance_f2c	(	MPI_Fint	comm,
		int *	yac_instance_id )

Definition at line 403 of file yac.c.

Here is the call graph for this function:

◆ yac_cinit_dummy()

void yac_cinit_dummy ( void )

Dummy for initialisation of the whole system

Remarks: This routine can be called instead of yac_cinit or yac_cinit_instance, if the local process does not wish to initialise a YAC instance.

Examples: test_dummy_coupling3_c.c.

Definition at line 461 of file yac.c.

Here is the call graph for this function:

◆ yac_cinit_instance()

void yac_cinit_instance ( int * yac_instance_id )

Elementary initialisation of the whole system

Parameters

[out] yac_instance_id id of the YAC instance initialised by this call

Remarks: This call initialises a YAC instance.; A call to yac_ccleanup_instance or yac_cfinalize_instance is required to free all memory associated with this YAC instance.; This call executes a MPI handshake (MPI handshake algorithm) on MPI_COMM_WORLD with the group name "yac" and uses the created communicator for the initialization. If you don't want to execute a MPI Handshake on MPI_COMM_WORLD you can call yac_cinit_comm_instance with MPI_COMM_WORLD directly.

Examples: test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dynamic_config_c.c, and test_query_routines_c.c.

Definition at line 423 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cmpi_handshake()

void yac_cmpi_handshake	(	MPI_Comm	comm,
		size_t	n,
		char const **	group_names,
		MPI_Comm *	group_comms )

MPI Handshake (MPI handshake algorithm)

Splits the provided communicator into group communicators. Each group communicator contains all processes of the provided communicator that provided the same group name. The order of the group names can be arbitrary on each process. A process can be part of multiple groups.

Parameters

[in]	comm	MPI communicator
[in]	n	number of group communicators to be generated
[in]	group_names	group names
[out]	group_comms	group communicators

Remarks: This call is collective for processes in comm.; yac_cinit will call this routine for MPI_COMM_WORLD and provided the group name "yac" to build its internal communicator.; If a process does not wish to use yac but is part of a communicator (e.g. MPI_COMM_WORLD) that is used by other processes that actually do use yac. This routine can be called, while not providing the group name "yac, to exclude a process from later collective yac-calls.

Examples: test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_instance_parallel4.c, and test_mpi_handshake_c.c.

Definition at line 360 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cmpi_handshake_f2c()

void yac_cmpi_handshake_f2c	(	MPI_Fint	comm,
		int	n,
		char const **	group_names,
		MPI_Fint *	group_comms )

Definition at line 366 of file yac.c.

Here is the call graph for this function:

◆ yac_cpredef_comp()

void yac_cpredef_comp	(	char const *	comp_name,
		int *	comp_id )

Non-blocking pre-definition of a component for the default YAC instance.

Parameters

[in]	comp_name	name of the component
[out]	comp_id	component Id

Remarks: this call does not finish the component definition phase. I.e. the component communicators are not set up after this call.

Examples: test_dynamic_config_c.c.

Definition at line 858 of file yac.c.

Here is the call graph for this function:

◆ yac_cpredef_comp_instance()

void yac_cpredef_comp_instance	(	int	yac_instance_id,
		char const *	comp_name,
		int *	comp_id )

Non-blocking pre-definition of a component.

Parameters

[in]	yac_instance_id	id of the YAC instance
[in]	comp_name	name of the component
[out]	comp_id	component Id

Remarks: this call does not finish the component definition phase. I.e. the component communicators are not set up after this call.

Examples: test_dynamic_config_c.c.

Definition at line 825 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cput()

void yac_cput	(	int const	field_id,
		int const	collection_size,
		double ***const	send_field,
		int *	info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[out]	info	- returned info
[out]	ierror	- returned error

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling_c.c, test_dummy_coupling_raw_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 3487 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cput_()

void yac_cput_	(	int const	field_id,
		int const	collection_size,
		double *	send_field,
		int *	info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer (all data is stored in one contiguous part of the memory) dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[out]	info	- returned info
[out]	ierror	- returned error

Examples: test_dummy_coupling4_c.c, test_dummy_coupling9_c.c, test_dynamic_config_c.c, and test_multithreading.c.

Definition at line 2836 of file yac.c.

Here is the call graph for this function:

◆ yac_cput_frac()

void yac_cput_frac	(	int const	field_id,
		int const	collection_size,
		double ***const	send_field,
		double ***const	send_frac_mask,
		int *	info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	send_frac_mask	- send fractional mask dimensions send_frac_mask[collection_size] [nbr_fields] [nbr_points]
[out]	info	- returned info
[out]	ierror	- returned error

Examples: test_dummy_coupling7_c.c, and test_dummy_coupling_raw_c.c.

Definition at line 3371 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cput_frac_()

void yac_cput_frac_	(	int const	field_id,
		int const	collection_size,
		double *	send_field,
		double *	send_frac_mask,
		int *	info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer (all data is stored in one contiguous part of the memory) dimensions send_field[collection_size] [nbr_fields] [nbr_points]
[in]	send_frac_mask	- send fractional mask (all data is stored in one contiguous part of the memory) dimensions send_frac_mask[collection_size] [nbr_fields] [nbr_points]
[out]	info	- returned info
[out]	ierror	- returned error

Examples: test_dummy_coupling8_c.c.

Definition at line 2856 of file yac.c.

Here is the call graph for this function:

◆ yac_cput_frac_ptr_()

void yac_cput_frac_ptr_	(	int const	field_id,
		int const	collection_size,
		double **	send_field,
		double **	send_frac_mask,
		int *	info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer dimensions send_field[collection_size * nbr_fields] [nbr_points]
[in]	send_frac_mask	- send fractional mask dimensions send_frac_mask[collection_size * nbr_fields] [nbr_points]
[out]	info	- returned info
[out]	ierror	- returned error

Definition at line 2951 of file yac.c.

Here is the call graph for this function:

◆ yac_cput_pre_processing()

static void * yac_cput_pre_processing	(	struct coupling_field *	cpl_field,
		unsigned	put_idx,
		int const	collection_size,
		double ***	send_field,
		double ****	send_field_acc_,
		double ***	send_frac_mask,
		double ****	send_frac_mask_acc_,
		int *	with_frac_mask_,
		int *	use_raw_exchange_,
		int *	info,
		int *	ierr )

static

Definition at line 3058 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cput_ptr_()

void yac_cput_ptr_	(	int const	field_id,
		int const	collection_size,
		double **	send_field,
		int *	info,
		int *	ierror )

Sending of the coupling fields

Parameters

[in]	field_id	-
[in]	collection_size	-
[in]	send_field	- send buffer dimensions send_field[collection_size * nbr_fields] [nbr_points]
[out]	info	- returned info
[out]	ierror	- returned error

Definition at line 2930 of file yac.c.

Here is the call graph for this function:

◆ yac_cread_config_json()

void yac_cread_config_json ( const char * json_file )

Function for reading configuration from JSON configuration file

Parameters

[in] json_file JSON configuration file

Examples: test_dummy_coupling6_c.c.

Definition at line 504 of file yac.c.

Here is the call graph for this function:

◆ yac_cread_config_json_instance()

void yac_cread_config_json_instance	(	int	yac_instance_id,
		const char *	json_file )

Function for reading configuration from JSON configuration file for a specific YAC instance

Parameters

[in]	yac_instance_id	YAC instance id
[in]	json_file	JSON configuration file

Examples: test_dummy_coupling6_c.c.

Definition at line 495 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cread_config_yaml()

void yac_cread_config_yaml ( const char * yaml_file )

Function for reading configuration from YAML configuration file

Parameters

[in] yaml_file YAML configuration file

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, and test_restart_c.c.

Definition at line 490 of file yac.c.

Here is the call graph for this function:

◆ yac_cread_config_yaml_instance()

void yac_cread_config_yaml_instance	(	int	yac_instance_id,
		const char *	yaml_file )

Function for reading configuration from YAML configuration file for a specific YAC instance

Parameters

[in]	yac_instance_id	YAC instance id
[in]	yaml_file	YAML configuration file

Examples: test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, and test_dummy_coupling6_c.c.

Definition at line 481 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_config_output_file()

void yac_cset_config_output_file	(	const char *	filename,
		int	fileformat,
		int	sync_location,
		int	include_definitions )

Activates writing out of the coupling configuration

Parameters

[in]	filename	name of the file to be written
[in]	fileformat	file format (YAC_CONFIG_OUTPUT_FORMAT_YAML or YAC_CONFIG_OUTPUT_FORMAT_JSON)
[in]	sync_location	synchronisation point after which the file is to be written (YAC_CONFIG_OUTPUT_SYNC_LOC_DEF_COMP, YAC_CONFIG_OUTPUT_SYNC_LOC_SYNC_DEF, or YAC_CONFIG_OUTPUT_SYNC_LOC_ENDDEF)
[in]	include_definitions	include user definitions (components, grids, and fields)

Examples: test_dynamic_config_c.c.

Definition at line 542 of file yac.c.

Here is the call graph for this function:

◆ yac_cset_config_output_file_instance()

void yac_cset_config_output_file_instance	(	int	yac_instance_id,
		const char *	filename,
		int	fileformat,
		int	sync_location,
		int	include_definitions )

Activates writing out of the coupling configuration

Parameters

[in]	yac_instance_id	YAC instance_id
[in]	filename	name of the file to be written
[in]	fileformat	file format (YAC_CONFIG_OUTPUT_FORMAT_YAML or YAC_CONFIG_OUTPUT_FORMAT_JSON)
[in]	sync_location	synchronisation point after which the file is to be written (YAC_CONFIG_OUTPUT_SYNC_LOC_DEF_COMP, YAC_CONFIG_OUTPUT_SYNC_LOC_SYNC_DEF, or YAC_CONFIG_OUTPUT_SYNC_LOC_ENDDEF)
[in]	include_definitions	include user definitions (components, grids, and fields)

Examples: test_dummy_coupling3_c.c.

Definition at line 511 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_core_mask()

void yac_cset_core_mask	(	int const *	is_core,
		int	location,
		int	grid_id )

Set core mask for a grid

Parameters

[in]	is_core	0 for cells/vertices/edges that are halos, 1 for cells/vertices/edges that are core
[in]	location	cell/vertex/edge
[in]	grid_id	grid id

Remarks: cells/vertices/edges who are halos are not used or set in a put or get operation; core mask values are to be provided in the local order of their respective cells/vertices/edges

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, test_dummy_coupling_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 4781 of file yac.c.

Here is the call graph for this function:

◆ yac_cset_ext_couple_config_mapping_side()

void yac_cset_ext_couple_config_mapping_side	(	int	ext_couple_config_id,
		int	mapping_side )

Sets the mapping side

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	mapping_side	mapping side

Remarks: Valid values are: source = 1 and target = 0

Examples: test_dynamic_config_c.c.

Definition at line 1511 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_mapping_side_()

void yac_cset_ext_couple_config_mapping_side_	(	struct yac_ext_couple_config *	ext_couple_config,
		int	mapping_side )

Definition at line 1499 of file yac.c.

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_scale_factor()

void yac_cset_ext_couple_config_scale_factor	(	int	ext_couple_config_id,
		double	scale_factor )

Sets the scale factor

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	scale_factor	scale factor

Examples: test_dummy_coupling7_c.c, and test_dynamic_config_c.c.

Definition at line 1534 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_scale_factor_()

void yac_cset_ext_couple_config_scale_factor_	(	struct yac_ext_couple_config *	ext_couple_config,
		double	scale_factor )

Definition at line 1525 of file yac.c.

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_scale_summand()

void yac_cset_ext_couple_config_scale_summand	(	int	ext_couple_config_id,
		double	scale_summand )

Sets the scale summand

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	scale_summand	scale summand

Examples: test_dummy_coupling7_c.c, and test_dynamic_config_c.c.

Definition at line 1557 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_scale_summand_()

void yac_cset_ext_couple_config_scale_summand_	(	struct yac_ext_couple_config *	ext_couple_config,
		double	scale_summand )

Definition at line 1548 of file yac.c.

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_src_mask_names()

void yac_cset_ext_couple_config_src_mask_names	(	int	ext_couple_config_id,
		size_t	num_src_mask_names,
		char const const	src_mask_names )

Sets source mask names

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	num_src_mask_names	number of source mask names
[in]	src_mask_names	source mask names

Examples: test_dummy_coupling9_c.c.

Definition at line 1587 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_src_mask_names_()

void yac_cset_ext_couple_config_src_mask_names_	(	struct yac_ext_couple_config *	ext_couple_config,
		size_t	num_src_mask_names,
		char const const	src_mask_names )

Definition at line 1571 of file yac.c.

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_tgt_mask_name()

void yac_cset_ext_couple_config_tgt_mask_name	(	int	ext_couple_config_id,
		char const *	tgt_mask_name )

Sets target mask name

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	tgt_mask_name	target mask name

Examples: test_dummy_coupling9_c.c.

Definition at line 1612 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_tgt_mask_name_()

void yac_cset_ext_couple_config_tgt_mask_name_	(	struct yac_ext_couple_config *	ext_couple_config,
		char const *	tgt_mask_name )

Definition at line 1604 of file yac.c.

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_use_raw_exchange()

void yac_cset_ext_couple_config_use_raw_exchange	(	int	ext_couple_config_id,
		int	use_raw_exchange )

Sets use of raw exchange

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	use_raw_exchange	use raw exchange

Examples: test_dummy_coupling_raw_c.c, and test_dynamic_config_c.c.

Definition at line 1654 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_use_raw_exchange_()

void yac_cset_ext_couple_config_use_raw_exchange_	(	struct yac_ext_couple_config *	ext_couple_config,
		int	use_raw_exchange )

Definition at line 1648 of file yac.c.

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_weight_file()

void yac_cset_ext_couple_config_weight_file	(	int	ext_couple_config_id,
		char const *	weight_file )

Sets the weight file name

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	weight_file	name of a weight file

Remarks: if (weight_file == NULL) no weight file will be written; YAC will write out the weight file in parallel. This parallel output can be configured as described here: Configuration of parallel IO in YAC

Examples: test_dynamic_config_c.c.

Definition at line 1454 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_weight_file_()

void yac_cset_ext_couple_config_weight_file_	(	struct yac_ext_couple_config *	ext_couple_config,
		char const *	weight_file )

Definition at line 1446 of file yac.c.

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_weight_file_on_existing()

void yac_cset_ext_couple_config_weight_file_on_existing	(	int	ext_couple_config_id,
		int	weight_file_on_existing )

Specify handling of already existing weight files

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	weight_file_on_existing	handling of existing weight files

Remarks

this only applies, if a weight file name was specified

Avaiable options:

YAC_WGT_ON_EXISTING_ERROR
YAC_WGT_ON_EXISTING_KEEP
YAC_WGT_ON_EXISTING_OVERWRITE

See also: yac_cset_ext_couple_config_weight_file

Examples: test_dynamic_config_c.c.

Definition at line 1485 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_weight_file_on_existing_()

void yac_cset_ext_couple_config_weight_file_on_existing_	(	struct yac_ext_couple_config *	ext_couple_config,
		int	weight_file_on_existing )

Definition at line 1468 of file yac.c.

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_yaxt_exchanger_name()

void yac_cset_ext_couple_config_yaxt_exchanger_name	(	int	ext_couple_config_id,
		char const *	yaxt_exchanger_name )

Sets yaxt exchanger name

Parameters

[in]	ext_couple_config_id	extended coupling configuration
[in]	yaxt_exchanger_name	yaxt exchange name

Examples: test_dynamic_config_c.c.

Definition at line 1634 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_ext_couple_config_yaxt_exchanger_name_()

void yac_cset_ext_couple_config_yaxt_exchanger_name_	(	struct yac_ext_couple_config *	ext_couple_config,
		char const *	yaxt_exchanger_name )

Definition at line 1626 of file yac.c.

Here is the caller graph for this function:

◆ yac_cset_global_index()

void yac_cset_global_index	(	int const *	global_index,
		int	location,
		int	grid_id )

Set global ids for a grid

Parameters

[in]	global_index	array of global indices
[in]	location	cell/vertex/edge
[in]	grid_id	grid id

Remarks: global indices are to be provided in the local order of their respective cells/vertices/edges

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, test_dummy_coupling_c.c, test_dummy_coupling_raw_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 4740 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_grid_output_file()

void yac_cset_grid_output_file	(	const char *	gridname,
		const char *	filename )

Activates writing out of the grid data

Parameters

[in]	gridname	name of the grid to be written
[in]	filename	name of the file to be written

Remarks: the writing is done in parallel (see Configuration of parallel IO in YAC)

Examples: test_dynamic_config_c.c.

Definition at line 571 of file yac.c.

Here is the call graph for this function:

◆ yac_cset_grid_output_file_instance()

void yac_cset_grid_output_file_instance	(	int	yac_instance_id,
		const char *	gridname,
		const char *	filename )

Activates writing out of the grid data

Parameters

[in]	yac_instance_id	YAC instance_id
[in]	gridname	name of the grid to be written
[in]	filename	name of the file to be written

Remarks: the writing is done in parallel (see Configuration of parallel IO in YAC)

Examples: test_dynamic_config_c.c.

Definition at line 554 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cset_mask()

void yac_cset_mask	(	int const *	is_valid,
		int	points_id )

Set the default mask for points

Parameters

[in]	is_valid	0 for points that are masked out, 1 for valid points
[in]	points_id	id of points/cells

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, test_dummy_coupling_c.c, and test_restart_c.c.

Definition at line 1182 of file yac.c.

Here is the call graph for this function:

◆ yac_csync_def()

void yac_csync_def ( void )

synchronize grids and fields of the default instance

Examples: test_dummy_coupling3_c.c, test_multithreading.c, test_query_routines_c.c, and test_restart_c.c.

Definition at line 4151 of file yac.c.

Here is the call graph for this function:

◆ yac_csync_def_instance()

void yac_csync_def_instance ( int yac_instance_id )

synchronize grids and fields

Parameters

[in] yac_instance_id id of the YAC instance

Examples: test_dummy_coupling3_c.c, test_dynamic_config_c.c, and test_query_routines_c.c.

Definition at line 4146 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_ctest()

void yac_ctest	(	int	field_id,
		int *	flag )

Determines whether there is an asynchronous communication associated with a field, which is not yet completed (for example by a previous put)

Parameters

[in]	field_id
[out]	flag	"0" if there is an uncompleted asynchronous communication associated with the field, "1" otherwise

Examples: test_dummy_coupling_c.c.

Definition at line 2984 of file yac.c.

Here is the call graph for this function:

◆ yac_cupdate()

void yac_cupdate ( int field_id )

If the action for the current timestep is YAC_ACTION_NONE, this routine will advance the internal clock to next timestep.

Parameters

[in] field_id field id returned by yac_cdef_field

Remarks: If this routine is called before yac_cenddef, the behaviour is undefined.; This routine can be called instead of yac_cput or yac_cget, if these routines would not have taken any action for the current timestep, in order to advance the internal clock.

Examples: test_dummy_coupling5_c.c.

Definition at line 2226 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cupdate_()

static void yac_cupdate_	(	struct coupling_field *	cpl_field,
		struct event *	event,
		int	is_source )

inlinestatic

Definition at line 2214 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_cwait()

void yac_cwait ( int field_id )

Waits until all previous asynchronous communication associated with a field is completed (for example by a previous put)

Parameters

[in] field_id

Examples: test_dummy_coupling9_c.c, test_dummy_coupling_c.c, and test_dummy_coupling_raw_c.c.

Definition at line 3008 of file yac.c.

Here is the call graph for this function:

◆ yac_cyaml_get_emitter_flag_default_c2f()

int yac_cyaml_get_emitter_flag_default_c2f ( )

Definition at line 470 of file yac.c.

◆ yac_cyaml_get_emitter_flag_json_c2f()

int yac_cyaml_get_emitter_flag_json_c2f ( )

Definition at line 474 of file yac.c.

◆ yac_free_components()

static void yac_free_components ( )

static

Definition at line 289 of file yac.c.

Here is the caller graph for this function:

◆ yac_free_grids()

static void yac_free_grids ( )

static

Definition at line 258 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_free_interp_stack_configs()

static void yac_free_interp_stack_configs ( )

static

Definition at line 302 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_free_masks()

static void yac_free_masks ( )

static

Definition at line 279 of file yac.c.

Here is the caller graph for this function:

◆ yac_free_pointer_unique_lookup()

static void yac_free_pointer_unique_lookup ( )

static

frees all memory used for the pointer/unique_id conversion

Remarks: this should only be called after the last call to yac_pointer_to_unique_id and yac_unique_id_to_pointer, because afterwards yac_unique_id_to_pointer will not be able to return the respective pointers for previously valid unique ids

Definition at line 229 of file yac.c.

Here is the caller graph for this function:

◆ yac_free_points()

static void yac_free_points ( )

static

Definition at line 269 of file yac.c.

Here is the caller graph for this function:

◆ yac_get()

static void yac_get	(	int const	field_id,
		int	collection_size,
		double **	recv_field,
		int	is_async,
		int *	info,
		int *	ierr )

static

Definition at line 2410 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_get_()

void yac_get_	(	int const	field_id,
		int const	collection_size,
		double *	recv_field,
		int	is_async,
		int *	info,
		int *	ierr )

Definition at line 2496 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_get_comp_comm_f2c()

void yac_get_comp_comm_f2c	(	int	comp_id,
		MPI_Fint *	comp_comm_f )

Definition at line 757 of file yac.c.

Here is the call graph for this function:

◆ yac_get_field_get_mask_c2f()

void * yac_get_field_get_mask_c2f ( int field_id )

Definition at line 3048 of file yac.c.

Here is the call graph for this function:

◆ yac_get_field_put_mask_c2f()

void * yac_get_field_put_mask_c2f ( int field_id )

Definition at line 3040 of file yac.c.

Here is the call graph for this function:

◆ yac_get_raw_frac()

void yac_get_raw_frac	(	int const	field_id,
		int const	collection_size,
		double ***	src_field_buffer,
		double ***	src_frac_mask_buffer,
		int	is_async,
		int *	info,
		int *	ierror )

Definition at line 2431 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_get_raw_frac_()

void yac_get_raw_frac_	(	int const	field_id,
		int const	collection_size,
		double *	src_field_buffer,
		double *	src_frac_mask_buffer,
		int	is_async,
		int *	info,
		int *	ierr )

Definition at line 2553 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_get_raw_frac_ptr_()

static void yac_get_raw_frac_ptr_	(	int const	field_id,
		int const	collection_size,
		double **	src_field_buffer,
		double **	src_frac_mask_buffer,
		int	is_async,
		int *	info,
		int *	ierr )

static

Definition at line 2588 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_init()

static int yac_init ( MPI_Comm comm )

static

Definition at line 376 of file yac.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yac_lookup_pointer()

static int yac_lookup_pointer ( void const * pointer )

static

gives the unique index associated with pointer

Parameters

[in] pointer

Returns: unique value associated to pointer

Remarks: the pointer has to have been registers using yac_pointer_to_unique_id, otherwise this routine returns INT_MAX

Definition at line 214 of file yac.c.

Here is the caller graph for this function:

◆ yac_pointer_to_unique_id()

static int yac_pointer_to_unique_id ( void * pointer )

static

gives a unique index for a given pointer

Parameters

[in] pointer

Returns: unique value associated to pointer

See also: unique_id_to_pointer

Definition at line 178 of file yac.c.

Here is the caller graph for this function:

◆ yac_unique_id_to_pointer()

static void * yac_unique_id_to_pointer	(	int	id,
		char const *	id_name )

static

gives the pointer that is associated to the given id

Parameters

[in]	id	unique index previously returned by pointer_to_unique_id
[in]	id_name	name of the id

Returns: pointer the is associated to the given id
NULL if the id is invalid

Definition at line 197 of file yac.c.

Variable Documentation

◆ components

struct user_input_data_component** components = NULL

static

Definition at line 147 of file yac.c.

◆ default_instance_id

int default_instance_id = INT_MAX

static

Examples: test_dummy_coupling6_c.c, and test_dummy_coupling7_c.c.

Definition at line 137 of file yac.c.

◆ grids

struct yac_basic_grid** grids = NULL

Examples: test_dist_grid_pair_parallel.c, test_interp_grid_parallel.c, test_interp_method_avg_parallel.c, test_interp_method_callback_parallel.c, test_interp_method_creep_parallel.c, test_interp_method_hcsbb_parallel.c, test_interp_method_ncc_parallel.c, test_interp_method_parallel.c, test_interp_method_rbf_parallel.c, test_interp_method_spmap_parallel.c, and test_interp_weights_parallel.c.

Definition at line 144 of file yac.c.

◆ interp_stack_configs

struct yac_interp_stack_config** interp_stack_configs = NULL

static

Definition at line 156 of file yac.c.

◆ masks

struct user_input_data_masks** masks = NULL

static

Examples: test_basic_grid.c.

Definition at line 153 of file yac.c.

◆ num_components

size_t num_components = 0

static

Definition at line 148 of file yac.c.

◆ num_grids

size_t num_grids = 0

Definition at line 145 of file yac.c.

◆ num_interp_stack_configs

size_t num_interp_stack_configs = 0

static

Definition at line 157 of file yac.c.

◆ num_masks

size_t num_masks = 0

static

Definition at line 154 of file yac.c.

◆ num_points

size_t num_points = 0

static

Examples: test_bnd_sphere_part.c, test_dist_grid_pair_parallel.c, test_dummy_coupling_raw_c.c, test_instance_parallel2.c, test_interp_method_hcsbb_parallel.c, and test_point_sphere_part.c.

Definition at line 151 of file yac.c.

◆ pointer_lookup_table

void** pointer_lookup_table = NULL

Definition at line 141 of file yac.c.

◆ pointer_lookup_table_size

int pointer_lookup_table_size = 0

static

Definition at line 142 of file yac.c.

◆ points

struct user_input_data_points** points = NULL

static

Examples: test_circle.c, test_dist_grid_pair_parallel.c, and test_lat_clipping.c.

Definition at line 150 of file yac.c.

◆ YAC_ACTION_COUPLING

int const YAC_ACTION_COUPLING = COUPLING

data exchange

Examples: test_dummy_coupling2_c.c, test_dummy_coupling4_c.c, test_dummy_coupling5_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, and test_dummy_coupling_raw_c.c.

Definition at line 39 of file yac.c.

◆ YAC_ACTION_GET_FOR_CHECKPOINT

int const YAC_ACTION_GET_FOR_CHECKPOINT = GET_FOR_CHECKPOINT

Definition at line 43 of file yac.c.

◆ YAC_ACTION_GET_FOR_RESTART

int const YAC_ACTION_GET_FOR_RESTART = GET_FOR_RESTART

last valid get

Examples: test_dummy_coupling5_c.c, test_dummy_coupling_raw_c.c, and test_dynamic_config_c.c.

Definition at line 41 of file yac.c.

◆ YAC_ACTION_NONE

int const YAC_ACTION_NONE = NONE

no data exchanges

Examples: test_dummy_coupling2_c.c, test_dummy_coupling4_c.c, test_dummy_coupling5_c.c, test_dummy_coupling8_c.c, test_dummy_coupling_raw_c.c, and test_dynamic_config_c.c.

Definition at line 37 of file yac.c.

◆ YAC_ACTION_OUT_OF_BOUND

int const YAC_ACTION_OUT_OF_BOUND = OUT_OF_BOUND

put/get is outside of the valid range

Examples: test_dummy_coupling5_c.c.

Definition at line 45 of file yac.c.

◆ YAC_ACTION_PUT_FOR_CHECKPOINT

int const YAC_ACTION_PUT_FOR_CHECKPOINT = PUT_FOR_CHECKPOINT

Definition at line 44 of file yac.c.

◆ YAC_ACTION_PUT_FOR_RESTART

int const YAC_ACTION_PUT_FOR_RESTART = PUT_FOR_RESTART

last valid put

Examples: test_dummy_coupling5_c.c, and test_dynamic_config_c.c.

Definition at line 42 of file yac.c.

◆ YAC_ACTION_REDUCTION

int const YAC_ACTION_REDUCTION = REDUCTION

data reduction, but data exchange

Examples: test_dummy_coupling4_c.c, test_dummy_coupling5_c.c, and test_dummy_coupling8_c.c.

Definition at line 38 of file yac.c.

◆ YAC_ACTION_RESTART

int const YAC_ACTION_RESTART = RESTART

Definition at line 40 of file yac.c.

◆ YAC_AVG_ARITHMETIC

int const YAC_AVG_ARITHMETIC = YAC_INTERP_AVG_ARITHMETIC

Examples: test_dynamic_config_c.c.

Definition at line 67 of file yac.c.

◆ YAC_AVG_BARY

int const YAC_AVG_BARY = YAC_INTERP_AVG_BARY

Definition at line 69 of file yac.c.

◆ YAC_AVG_DIST

int const YAC_AVG_DIST = YAC_INTERP_AVG_DIST

Definition at line 68 of file yac.c.

◆ YAC_CALENDAR_NOT_SET

int const YAC_CALENDAR_NOT_SET = CALENDAR_NOT_SET

Definition at line 62 of file yac.c.

◆ YAC_CONFIG_OUTPUT_FORMAT_JSON

int const YAC_CONFIG_OUTPUT_FORMAT_JSON = YAC_TEXT_FILETYPE_JSON

Examples: test_dummy_coupling3_c.c, and test_dynamic_config_c.c.

Definition at line 100 of file yac.c.

◆ YAC_CONFIG_OUTPUT_FORMAT_YAML

int const YAC_CONFIG_OUTPUT_FORMAT_YAML = YAC_TEXT_FILETYPE_YAML

Examples: test_dummy_coupling3_c.c, and test_dynamic_config_c.c.

Definition at line 99 of file yac.c.

◆ YAC_CONFIG_OUTPUT_SYNC_LOC_DEF_COMP

int const YAC_CONFIG_OUTPUT_SYNC_LOC_DEF_COMP

Initial value:

YAC_CONFIG_OUTPUT_SYNC_LOC_DEF_COMP_

@ YAC_CONFIG_OUTPUT_SYNC_LOC_DEF_COMP_

Definition yac.c:107

after component definition

Definition at line 112 of file yac.c.

◆ YAC_CONFIG_OUTPUT_SYNC_LOC_ENDDEF

int const YAC_CONFIG_OUTPUT_SYNC_LOC_ENDDEF

Initial value:

YAC_CONFIG_OUTPUT_SYNC_LOC_ENDDEF_

@ YAC_CONFIG_OUTPUT_SYNC_LOC_ENDDEF_

Definition yac.c:109

after end of definitions

Examples: test_dummy_coupling3_c.c, and test_dynamic_config_c.c.

Definition at line 116 of file yac.c.

◆ YAC_CONFIG_OUTPUT_SYNC_LOC_SYNC_DEF

int const YAC_CONFIG_OUTPUT_SYNC_LOC_SYNC_DEF

Initial value:

YAC_CONFIG_OUTPUT_SYNC_LOC_SYNC_DEF_

@ YAC_CONFIG_OUTPUT_SYNC_LOC_SYNC_DEF_

Definition yac.c:108

after synchronization of definition

Examples: test_dummy_coupling3_c.c, and test_dynamic_config_c.c.

Definition at line 114 of file yac.c.

◆ YAC_CONSERV_DESTAREA

int const YAC_CONSERV_DESTAREA = YAC_INTERP_CONSERV_DESTAREA

Examples: test_dummy_coupling_raw_c.c, and test_dynamic_config_c.c.

Definition at line 80 of file yac.c.

◆ YAC_CONSERV_FRACAREA

int const YAC_CONSERV_FRACAREA = YAC_INTERP_CONSERV_FRACAREA

Definition at line 81 of file yac.c.

◆ YAC_EXCHANGE_TYPE_NONE

int const YAC_EXCHANGE_TYPE_NONE = NOTHING

Examples: test_couple_config.c, and test_query_routines_c.c.

Definition at line 33 of file yac.c.

◆ YAC_EXCHANGE_TYPE_SOURCE

int const YAC_EXCHANGE_TYPE_SOURCE = SOURCE

Examples: test_couple_config.c.

Definition at line 34 of file yac.c.

◆ YAC_EXCHANGE_TYPE_TARGET

int const YAC_EXCHANGE_TYPE_TARGET = TARGET

Examples: test_couple_config.c.

Definition at line 35 of file yac.c.

◆ YAC_FILE_MISSING_CONT

int const YAC_FILE_MISSING_CONT = YAC_INTERP_FILE_MISSING_CONT

continue on missing file

Definition at line 92 of file yac.c.

◆ YAC_FILE_MISSING_ERROR

int const YAC_FILE_MISSING_ERROR = YAC_INTERP_FILE_MISSING_ERROR

abort on missing file

Definition at line 91 of file yac.c.

◆ YAC_FILE_SUCCESS_CONT

int const YAC_FILE_SUCCESS_CONT = YAC_INTERP_FILE_SUCCESS_CONT

continue weight computation with following interpolation methods

Definition at line 96 of file yac.c.

◆ YAC_FILE_SUCCESS_STOP

int const YAC_FILE_SUCCESS_STOP = YAC_INTERP_FILE_SUCCESS_STOP

prevents following interpolation method from computating further weights

Definition at line 94 of file yac.c.

◆ yac_instance_count

int yac_instance_count = 0

static

Definition at line 139 of file yac.c.

◆ YAC_LOCATION_CELL

int const YAC_LOCATION_CELL = YAC_LOC_CELL

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_query_routines_c.c, test_restart2.c, and test_restart_c.c.

Definition at line 29 of file yac.c.

◆ YAC_LOCATION_CORNER

int const YAC_LOCATION_CORNER = YAC_LOC_CORNER

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_raw_c.c, test_multithreading.c, and test_restart_c.c.

Definition at line 30 of file yac.c.

◆ YAC_LOCATION_EDGE

int const YAC_LOCATION_EDGE = YAC_LOC_EDGE

Examples: test_dummy_coupling5_c.c.

Definition at line 31 of file yac.c.

◆ YAC_NCC_AVG

int const YAC_NCC_AVG = YAC_INTERP_NCC_AVG

Examples: test_dynamic_config_c.c.

Definition at line 71 of file yac.c.

◆ YAC_NCC_DIST

int const YAC_NCC_DIST = YAC_INTERP_NCC_DIST

Definition at line 72 of file yac.c.

◆ YAC_NNN_AVG

int const YAC_NNN_AVG = YAC_INTERP_NNN_AVG

Examples: test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dynamic_config_c.c, test_multithreading.c, and test_restart2.c.

Definition at line 74 of file yac.c.

◆ YAC_NNN_DIST

int const YAC_NNN_DIST = YAC_INTERP_NNN_DIST

Definition at line 75 of file yac.c.

◆ YAC_NNN_GAUSS

int const YAC_NNN_GAUSS = YAC_INTERP_NNN_GAUSS

Definition at line 76 of file yac.c.

◆ YAC_NNN_RBF

int const YAC_NNN_RBF = YAC_INTERP_NNN_RBF

Definition at line 77 of file yac.c.

◆ YAC_NNN_ZERO

int const YAC_NNN_ZERO = YAC_INTERP_NNN_ZERO

Definition at line 78 of file yac.c.

◆ YAC_PROLEPTIC_GREGORIAN

int const YAC_PROLEPTIC_GREGORIAN = PROLEPTIC_GREGORIAN

◆ YAC_REDUCTION_TIME_ACCUMULATE

int const YAC_REDUCTION_TIME_ACCUMULATE = TIME_ACCUMULATE

Examples: test_dummy_coupling8_c.c, test_dynamic_config_c.c, and test_instance_parallel3.c.

Definition at line 48 of file yac.c.

◆ YAC_REDUCTION_TIME_AVERAGE

int const YAC_REDUCTION_TIME_AVERAGE = TIME_AVERAGE

Examples: test_dummy_coupling8_c.c, and test_dummy_coupling_raw_c.c.

Definition at line 49 of file yac.c.

◆ YAC_REDUCTION_TIME_MAXIMUM

int const YAC_REDUCTION_TIME_MAXIMUM = TIME_MAXIMUM

Examples: test_dummy_coupling8_c.c.

Definition at line 51 of file yac.c.

◆ YAC_REDUCTION_TIME_MINIMUM

int const YAC_REDUCTION_TIME_MINIMUM = TIME_MINIMUM

Examples: test_dummy_coupling8_c.c.

Definition at line 50 of file yac.c.

◆ YAC_REDUCTION_TIME_NONE

int const YAC_REDUCTION_TIME_NONE = TIME_NONE

Examples: test_couple_config.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dynamic_config_c.c, test_instance_parallel2.c, test_multithreading.c, test_restart2.c, and test_restart_c.c.

Definition at line 47 of file yac.c.

◆ YAC_SPMAP_AVG

int const YAC_SPMAP_AVG = YAC_INTERP_SPMAP_AVG

Examples: test_dynamic_config_c.c.

Definition at line 83 of file yac.c.

◆ YAC_SPMAP_DIST

int const YAC_SPMAP_DIST = YAC_INTERP_SPMAP_DIST

Definition at line 84 of file yac.c.

◆ YAC_SPMAP_FRACAREA

int const YAC_SPMAP_FRACAREA = YAC_INTERP_SPMAP_FRACAREA

Definition at line 89 of file yac.c.

◆ YAC_SPMAP_INVTGTAREA

int const YAC_SPMAP_INVTGTAREA = YAC_INTERP_SPMAP_INVTGTAREA

Definition at line 88 of file yac.c.

◆ YAC_SPMAP_NONE

int const YAC_SPMAP_NONE = YAC_INTERP_SPMAP_NONE

Examples: test_dynamic_config_c.c.

Definition at line 86 of file yac.c.

◆ YAC_SPMAP_SRCAREA

int const YAC_SPMAP_SRCAREA = YAC_INTERP_SPMAP_SRCAREA

Definition at line 87 of file yac.c.

◆ YAC_TIME_UNIT_DAY

int const YAC_TIME_UNIT_DAY = C_DAY

Definition at line 57 of file yac.c.

◆ YAC_TIME_UNIT_HOUR

int const YAC_TIME_UNIT_HOUR = C_HOUR

Definition at line 56 of file yac.c.

◆ YAC_TIME_UNIT_ISO_FORMAT

int const YAC_TIME_UNIT_ISO_FORMAT = C_ISO_FORMAT

Examples: test_dummy_coupling7_c.c, and test_query_routines_c.c.

Definition at line 60 of file yac.c.

◆ YAC_TIME_UNIT_MILLISECOND

int const YAC_TIME_UNIT_MILLISECOND = C_MILLISECOND

Definition at line 53 of file yac.c.

◆ YAC_TIME_UNIT_MINUTE

int const YAC_TIME_UNIT_MINUTE = C_MINUTE

Definition at line 55 of file yac.c.

◆ YAC_TIME_UNIT_MONTH

int const YAC_TIME_UNIT_MONTH = C_MONTH

Definition at line 58 of file yac.c.

◆ YAC_TIME_UNIT_SECOND

int const YAC_TIME_UNIT_SECOND = C_SECOND

Examples: test_dummy_coupling2_c.c, test_dummy_coupling3_c.c, test_dummy_coupling4_c.c, test_dummy_coupling5_c.c, test_dummy_coupling6_c.c, test_dummy_coupling7_c.c, test_dummy_coupling8_c.c, test_dummy_coupling9_c.c, test_dummy_coupling_c.c, test_dummy_coupling_raw_c.c, test_dynamic_config_c.c, test_multithreading.c, test_restart2.c, and test_restart_c.c.

Definition at line 54 of file yac.c.

◆ YAC_TIME_UNIT_YEAR

int const YAC_TIME_UNIT_YEAR = C_YEAR

Definition at line 59 of file yac.c.

◆ YAC_WGT_ON_EXISTING_ERROR

int const YAC_WGT_ON_EXISTING_ERROR = YAC_WEIGHT_FILE_ERROR

generate error and abort, if file with the same name already existis

Examples: test_dynamic_config_c.c.

Definition at line 102 of file yac.c.

◆ YAC_WGT_ON_EXISTING_KEEP

int const YAC_WGT_ON_EXISTING_KEEP = YAC_WEIGHT_FILE_KEEP

keep existing weight file

Definition at line 103 of file yac.c.

◆ YAC_WGT_ON_EXISTING_OVERWRITE

int const YAC_WGT_ON_EXISTING_OVERWRITE = YAC_WEIGHT_FILE_OVERWRITE

overwrite existing weight file

Definition at line 104 of file yac.c.

◆ YAC_YEAR_OF_360_DAYS

int const YAC_YEAR_OF_360_DAYS = YEAR_OF_360_DAYS

Definition at line 65 of file yac.c.

◆ YAC_YEAR_OF_365_DAYS

int const YAC_YEAR_OF_365_DAYS = YEAR_OF_365_DAYS

Definition at line 64 of file yac.c.

Data Structures

Macros

Enumerations

Functions

Variables

Macro Definition Documentation

◆ AGGREATE_NOFRAC

◆ AGGREGATE

◆ AGGREGATE_FRAC

◆ ASSIGN

◆ NO_CHECK [1/2]

◆ NO_CHECK [2/2]

◆ PUT_CHECK [1/2]

◆ PUT_CHECK [2/2]

◆ SUM

◆ WEIGHT_ACC

◆ WEIGHT_ACC_

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ check_cell_to_edge()

◆ check_cell_to_vertex()

◆ check_default_instance_id()

◆ check_mpi_initialised()

◆ check_x_vertices()

◆ check_y_vertices()

◆ cleanup()

◆ get_recv_field_pointers()

◆ get_send_field_pointers()

◆ get_send_field_pointers_ptr_()

◆ get_src_field_buffer_pointers()

◆ get_src_field_buffer_pointers_ptr()

◆ get_user_input_data_component()

◆ init_ext_couple_config()

◆ user_input_data_add_mask()

◆ user_input_data_add_points()

◆ yac_add_grid()

◆ yac_cadd_compute_weights_callback()

◆ yac_cadd_interp_stack_config_average()

◆ yac_cadd_interp_stack_config_check()

◆ yac_cadd_interp_stack_config_conservative()

◆ yac_cadd_interp_stack_config_creep()

◆ yac_cadd_interp_stack_config_fixed()

◆ yac_cadd_interp_stack_config_hcsbb()

◆ yac_cadd_interp_stack_config_ncc()

◆ yac_cadd_interp_stack_config_nnn()

◆ yac_cadd_interp_stack_config_rbf()

◆ yac_cadd_interp_stack_config_spmap()

◆ yac_cadd_interp_stack_config_spmap_f2c()

◆ yac_cadd_interp_stack_config_user_callback()

◆ yac_cadd_interp_stack_config_user_file()

◆ yac_cadd_interp_stack_config_user_file_2()

◆ yac_ccheck_field_dimensions()

◆ yac_ccheck_src_field_buffer_size()

◆ yac_ccheck_src_field_buffer_sizes()

◆ yac_ccleanup()

◆ yac_ccleanup_instance()

◆ yac_ccleanup_instance_()

◆ yac_ccompute_grid_cell_areas()

◆ yac_cdef_calendar()

◆ yac_cdef_comp()

◆ yac_cdef_comp_instance()

◆ yac_cdef_component_metadata()

◆ yac_cdef_component_metadata_instance()

◆ yac_cdef_comps()

◆ yac_cdef_comps_instance()

◆ yac_cdef_couple()

◆ yac_cdef_couple_()

◆ yac_cdef_couple_custom()

◆ yac_cdef_couple_custom_instance()

◆ yac_cdef_couple_custom_instance_()

◆ yac_cdef_couple_instance()

◆ yac_cdef_couple_instance_()

◆ yac_cdef_datetime()

◆ yac_cdef_datetime_instance()

◆ yac_cdef_field()

◆ yac_cdef_field_mask()

◆ yac_cdef_field_metadata()

◆ yac_cdef_field_metadata_instance()

◆ yac_cdef_grid_cloud()