couple_config_component.h

Go to the documentation of this file.

// Copyright (c) 2026 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef COUPLE_CONFIG_COMPONENT_H
#define COUPLE_CONFIG_COMPONENT_H
 
#include <stddef.h>
 
#include "yac_mpi_common.h"
 
struct yac_couple_config_component {
  char const * name;
  char * metadata;
  struct yac_couple_config_field * fields;
  size_t num_fields;
};
 
struct yac_couple_config_couple;
 
size_t yac_couple_config_component_append(
  struct yac_couple_config_component ** components, size_t * num_components,
  char const * name);
 
void yac_couple_config_components_free(
  struct yac_couple_config_component ** components,
  size_t * num_components);
 
void yac_couple_config_set_component_metadata_value(
  struct yac_couple_config_component * component, char const * metadata);
 
void yac_couple_config_components_merge(
  struct yac_couple_config_component ** components, size_t * num_components,
  struct yac_couple_config_couple * couples, size_t num_couples,
  MPI_Comm comm);
 
char const * yac_couple_config_component_get_name(
  struct yac_couple_config_component const * component);
 
char const * yac_couple_config_component_get_field_metadata(
  struct yac_couple_config_component const * component,
  size_t grid_idx, char const * field_name);
 
double yac_couple_config_component_get_field_frac_mask_fallback_value(
  struct yac_couple_config_component const * component,
  size_t grid_idx, char const * field_name);
 
void yac_couple_config_component_set_field_frac_mask_fallback_value(
  struct yac_couple_config_component * component,
  size_t grid_idx, char const * field_name, double value);
 
size_t yac_couple_config_component_get_field_collection_size(
  struct yac_couple_config_component const * component,
  size_t grid_idx, char const * field_name);
 
struct yac_couple_config_field * yac_couple_config_component_find_field(
  struct yac_couple_config_component const * component,
  size_t grid_idx, char const * field_name);
 
void yac_couple_config_component_set_field_metadata(
  struct yac_couple_config_component * component,
  size_t grid_idx, char const * field_name, char const * metadata);
 
size_t yac_couple_config_component_update_or_append_field(
  struct yac_couple_config_component * component,
  char const * field_name, size_t grid_idx,
  char const * timestep, size_t collection_size);
 
char const * yac_couple_config_component_get_field_name(
  struct yac_couple_config_component const * component,
  size_t field_idx);
 
size_t yac_couple_config_component_get_field_grid_idx(
  struct yac_couple_config_component const * component,
  size_t field_idx);
 
void yac_couple_config_component_update_all_grid_idx(
  struct yac_couple_config_component * component,
  size_t const * old_to_new_idx);
 
char const * yac_couple_config_component_get_field_timestep(
  struct yac_couple_config_component const * component,
  size_t grid_idx, char const * field_name);
 
char const * yac_couple_config_component_get_field_timestep_by_idx(
  struct yac_couple_config_component const * component,
  size_t field_idx);
 
int yac_couple_config_component_field_is_valid(
  struct yac_couple_config_component const * component,
  size_t field_idx);
 
size_t yac_couple_config_component_get_field_collection_size_by_idx(
  struct yac_couple_config_component const * component,
  size_t field_idx);
 
double
  yac_couple_config_component_get_field_frac_mask_fallback_value_by_idx(
    struct yac_couple_config_component const * component,
    size_t field_idx);
 
#endif // COUPLE_CONFIG_COMPONENT_H