instance.h

Go to the documentation of this file.

// Copyright (c) 2024 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef INSTANCE_H
#define INSTANCE_H
 
#include <mpi.h>
 
#include "component.h"
#include "couple_config/couple_config.h"
 
#define YAC_INSTANCE_CONFIG_OUTPUT_REF_COMP "comp"
#define YAC_INSTANCE_CONFIG_OUTPUT_REF_SYNC "sync"
#define YAC_INSTANCE_CONFIG_OUTPUT_REF_ENDDEF "enddef"
 
struct yac_collection_selection;
struct yac_instance;
struct yac_pak;
struct yac_instance * yac_instance_new(MPI_Comm comm);
 
void yac_instance_dummy_new(MPI_Comm comm);
 
 
void yac_instance_delete(struct yac_instance * instance);
 
MPI_Comm yac_instance_get_comm(struct yac_instance * instance);
 
void yac_instance_def_calendar(
  int calendar_type, char const * source);
 
void yac_instance_def_datetime(
  struct yac_instance * instance, const char * start_datetime,
  const char * end_datetime );
 
char * yac_instance_get_start_datetime(struct yac_instance * instance);
 
char * yac_instance_get_end_datetime(struct yac_instance * instance);
 
struct yac_couple_config * yac_instance_get_couple_config(
  struct yac_instance * instance);
 
void yac_instance_set_couple_config(
  struct yac_instance * instance,
    struct yac_couple_config * couple_config);
 
void yac_instance_def_components(
  struct yac_instance * instance, char const ** comp_names, size_t num_comps);
 
int yac_instance_components_are_defined(
  struct yac_instance * instance);
 
struct coupling_field * yac_instance_add_field(
  struct yac_instance * instance, char const * field_name,
  char const * comp_name, struct yac_basic_grid * grid,
  struct yac_interp_field * interp_fields, size_t num_interp_fields,
  int collection_size, char const * timestep);
 
void yac_instance_def_couple(
  struct yac_instance * instance,
  char const * src_comp_name, char const * src_grid_name, char const * src_field_name,
  char const * tgt_comp_name, char const * tgt_grid_name, char const * tgt_field_name,
  char const * coupling_period, int time_reduction,
  struct yac_interp_stack_config * interp_stack_config, int src_lag, int tgt_lag,
  const char* weight_file_name, int weight_file_on_existing,
  int mapping_on_source, double scale_factor, double scale_summand,
  size_t num_src_mask_names, char const * const * src_mask_names,
  char const * tgt_mask_name, char const * yaxt_exchanger_name,
  struct yac_collection_selection const * collection_selection,
  int use_raw_exchange);
 
void yac_instance_sync_def(struct yac_instance * instance);
 
void yac_instance_sync_def_comps(
  struct yac_instance * instance,
  char const ** comp_names, size_t num_comp_names);
 
void yac_instance_setup(
  struct yac_instance * instance, struct yac_basic_grid ** grids, size_t num_grids);
 
char * yac_instance_setup_and_emit_config(
  struct yac_instance * instance, struct yac_basic_grid ** grids,
  size_t num_grids, int emit_flags);
 
MPI_Comm yac_instance_get_comps_comm(
  struct yac_instance * instance,
  char const ** comp_names, size_t num_comp_names);
 
int yac_instance_get_nbr_comps(struct yac_instance * instance);
 
int yac_instance_get_comp_size(
  struct yac_instance * instance,
  const char* comp_name);
 
int yac_instance_get_comp_rank(
  struct yac_instance * instance,
  const char* comp_name);
 
struct coupling_field* yac_instance_get_field(struct yac_instance * instance,
  const char * comp_name, const char* grid_name, const char * field_name);
 
#endif // INSTANCE_H