fields.h

Go to the documentation of this file.

// Copyright (c) 2024 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef FIELDS_H
#define FIELDS_H
 
#include "component.h"
 
// general coupling field struct
 
enum yac_field_exchange_type {
  INVALID = -1,
  NOTHING = 0,
  SOURCE  = 1,
  TARGET  = 2,
};
 
// forward declaration
 
struct coupling_field;
struct yac_interpolation;
struct yac_pak;
 
// generation of a field
 
struct coupling_field *
yac_coupling_field_new(char const * field_name, char const * component_name,
  struct yac_basic_grid * grid, struct yac_interp_field * interp_fields,
  unsigned num_interp_fields, size_t collection_size, const char* timestep);
 
unsigned yac_get_coupling_field_collection_size(
  struct coupling_field * field);
 
const char* yac_get_coupling_field_timestep(
  struct coupling_field * field);
 
const char * yac_get_coupling_field_name(struct coupling_field * field);
 
char const * yac_get_coupling_field_comp_name(struct coupling_field * field);
 
struct yac_basic_grid * yac_coupling_field_get_basic_grid(
  struct coupling_field * field);
 
enum yac_location
yac_get_coupling_field_get_interp_field_location(
  struct coupling_field * field, size_t interp_field_idx);
 
struct yac_interp_field const * yac_coupling_field_get_interp_fields(
  struct coupling_field * field);
 
size_t yac_coupling_field_get_num_interp_fields(struct coupling_field * field);
 
size_t yac_coupling_field_get_data_size(
  struct coupling_field * field, enum yac_location location);
 
enum yac_field_exchange_type
yac_get_coupling_field_exchange_type(struct coupling_field * field);
 
unsigned yac_get_coupling_field_num_puts(struct coupling_field * field);
 
struct event * yac_get_coupling_field_put_op_event(
  struct coupling_field * field, unsigned put_idx);
 
struct yac_interpolation *
yac_get_coupling_field_put_op_interpolation(struct coupling_field * field,
                                            unsigned put_idx);
 
struct yac_interpolation_exchange *
  yac_get_coupling_field_put_op_interpolation_exchange(
    struct coupling_field * field, unsigned put_idx);
 
double ***
yac_get_coupling_field_put_op_send_field_acc(struct coupling_field * field,
                                             unsigned put_idx);
 
double ***
yac_get_coupling_field_put_op_send_frac_mask_acc(struct coupling_field * field,
                                                 unsigned put_idx);
 
void
yac_init_coupling_field_put_op_send_field_acc(struct coupling_field * field,
                                              unsigned put_idx,
                                              double init_value);
 
void
yac_init_coupling_field_put_op_send_frac_mask_acc(struct coupling_field * field,
                                                  unsigned put_idx,
                                                  double init_value);
 
int
yac_get_coupling_field_put_op_time_accumulation_count(struct coupling_field * field,
                                                      unsigned put_idx);
 
void
yac_set_coupling_field_put_op_time_accumulation_count(struct coupling_field * field,
                                                      unsigned put_idx,
                                                      int count);
 
int
yac_get_coupling_field_put_op_use_raw_exchange(struct coupling_field * field,
                                               unsigned put_idx);
 
int yac_get_coupling_field_get_op_use_raw_exchange(
  struct coupling_field * field);
 
int ** yac_get_coupling_field_put_mask(struct coupling_field * field);
 
int * yac_get_coupling_field_get_mask(struct coupling_field * field);
 
struct event * yac_get_coupling_field_get_op_event(
  struct coupling_field * field);
 
struct yac_interpolation *
yac_get_coupling_field_get_op_interpolation(struct coupling_field * field);
 
int yac_get_coupling_field_get_op_use_raw_exchange(
  struct coupling_field * field);
 
int yac_get_coupling_field_get_op_with_frac_mask(
  struct coupling_field * cpl_field);
 
struct yac_interpolation_exchange *
  yac_get_coupling_field_get_op_interpolation_exchange(
    struct coupling_field * field);
 
struct yac_interp_weights_data
  yac_get_coupling_field_get_op_interp_weights_data(
    struct coupling_field * field);
 
void yac_coupling_field_get_src_field_buffer_sizes(
  struct coupling_field * field, size_t * num_src_fields,
  size_t const ** src_field_buffer_sizes);
 
void yac_set_coupling_field_put_op(
  struct coupling_field * field, struct event * event,
  struct yac_interpolation * interpolation);
 
void yac_set_coupling_field_put_op_raw(
  struct coupling_field * field, struct event * event,
  struct yac_interpolation_exchange * interpolation_exchange);
 
void yac_set_coupling_field_get_op(
  struct coupling_field * field, struct event * event,
  struct yac_interpolation * interpolation);
 
void yac_set_coupling_field_get_op_raw(
  struct coupling_field * field, struct event * event,
  struct yac_interpolation_exchange * interpolation_exchange,
  struct yac_interp_weights_data interp_weights_data);
 
char* yac_coupling_field_get_datetime(
  struct coupling_field * cpl_field);
 
int yac_coupling_field_get_action(struct coupling_field * cpl_field);
 
char* yac_coupling_field_get_prev_datetime(
  struct coupling_field * cpl_field);
 
// destruction of fields
void yac_coupling_field_delete(struct coupling_field * cpl_field);
 
struct yac_pak * yac_coupling_field_get_pak(
  struct coupling_field * cpl_field);
 
void yac_coupling_field_set_pak(
  struct coupling_field * cpl_field, struct yac_pak * pak);
 
#endif // FIELDS_H