interp_weights.h

Go to the documentation of this file.

// Copyright (c) 2024 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef INTERP_WEIGHTS_H
#define INTERP_WEIGHTS_H
 
#include "yac_types.h"
#include "location.h"
#include "interpolation.h"
 
// YAC PUBLIC HEADER START
 
struct yac_interp_weights_data {
 
  double frac_mask_fallback_value; // user-defined fractional mask fallback value
  double scaling_factor;           // user-defined scaling factor
  double scaling_summand;          // user-defined scaling summand
 
  size_t num_fixed_values;          // number of fixed values
  double * fixed_values;            // fixed values
  size_t * num_tgt_per_fixed_value; // number of target points per fixed value
  size_t * tgt_idx_fixed;           // local ids of fixed target points
 
  size_t num_wgt_tgt;             // number of target points that receive a
                                  // weighted sum of source points
  size_t * wgt_tgt_idx;           // local ids of weighted target points
  size_t * num_src_per_tgt;       // number of source points per target
  double * weights;               // weights
  size_t * src_field_idx;         // source field index for each source point
  size_t * src_idx;               // index of source points in source field
                                  // buffer
  size_t num_src_fields;          // number of source fields
  size_t * src_field_buffer_size; // buffer sizes required for receiving all
                                  // required source data
                                  // (array size is num_src_fields)
};
 
struct yac_interpolation_exchange;
 
enum yac_interp_weights_reorder_type {
  YAC_MAPPING_ON_SRC, 
  YAC_MAPPING_ON_TGT, 
};
 
enum yac_weight_file_on_existing {
  YAC_WEIGHT_FILE_ERROR     = 0, 
  YAC_WEIGHT_FILE_KEEP      = 1, 
  YAC_WEIGHT_FILE_OVERWRITE = 2, 
  YAC_WEIGHT_FILE_UNDEFINED = 3,
};
 
#define YAC_WEIGHT_FILE_ON_EXISTING_DEFAULT_VALUE (YAC_WEIGHT_FILE_OVERWRITE)
 
struct yac_interp_weights;
 
struct yac_interp_weights * yac_interp_weights_new(
  MPI_Comm comm, enum yac_location tgt_location,
  enum yac_location * src_locations, size_t num_src_fields);
 
void yac_interp_weights_write_to_file(
  struct yac_interp_weights * weights, char const * filename,
  char const * src_grid_name, char const * tgt_grid_name,
  size_t src_grid_size, size_t tgt_grid_size,
  enum yac_weight_file_on_existing on_existing);
 
struct yac_interpolation * yac_interp_weights_get_interpolation(
  struct yac_interp_weights * weights,
  enum yac_interp_weights_reorder_type reorder,
  size_t collection_size, double frac_mask_fallback_value,
  double scaling_factor, double scaling_summand,
  char const * yaxt_exchanger_name, int is_source, int is_target);
 
void yac_interp_weights_get_interpolation_raw(
  struct yac_interp_weights * weights,
  size_t collection_size, double frac_mask_fallback_value,
  double scaling_factor, double scaling_summand,
  char const * yaxt_exchanger_name,
  struct yac_interpolation_exchange ** interpolation_exchange,
  struct yac_interp_weights_data * interp_weights_data,
  int is_source, int is_target);
 
size_t yac_interp_weights_get_interp_count(
  struct yac_interp_weights * weights);
 
yac_int * yac_interp_weights_get_interp_tgt(
  struct yac_interp_weights * weights);
 
void yac_interp_weights_delete(struct yac_interp_weights * weights);
 
void yac_interp_weights_data_init(
  struct yac_interp_weights_data * interp_weights_data);
 
struct yac_interp_weights_data yac_interp_weights_data_copy(
  struct yac_interp_weights_data interp_weights_data);
 
void yac_interp_weights_data_free(
  struct yac_interp_weights_data interp_weights_data);
 
// YAC PUBLIC HEADER STOP
 
#endif // INTERP_WEIGHTS_H