interp_method_utils.h

Go to the documentation of this file.

// Copyright (c) 2026 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef INTERP_METHOD_UTILS_H
#define INTERP_METHOD_UTILS_H
 
#include "yac_types.h"
#include "interpolation/interp_grid_internal.h"
#include "interpolation/interpolation_utils.h"
 
typedef void (*yac_interp_compute_weights_func)(
  double tgt_coord[3], yac_const_coordinate_pointer src_coords,
  size_t const n, double * weights, double const scale);
 
void yac_interp_compute_weights_avg(
  double tgt_coord[3], yac_const_coordinate_pointer src_coords, size_t const n,
  double * weights, double const dummy);
 
void yac_interp_compute_weights_dist(
  double tgt_coord[3], yac_const_coordinate_pointer src_coords, size_t const n,
  double * weights, double const dummy);
 
void yac_interp_compute_weights_gauss(
  double tgt_coord[3], yac_const_coordinate_pointer src_coords, size_t const n,
  double * weights, double const gauss_scale);
 
void yac_interp_compute_weights_rbf(
  double tgt_coord[3], yac_const_coordinate_pointer src_coords, size_t const n,
  double * weights, double const rbf_scale);
 
// Validation macros for interpolation methods
 
// Helper macro to check if source fields exist
#define CHECK_INTERP_GRID_HAS_SRC_FIELDS(INTERP_GRID) \
  YAC_INTERP_GRID_ASSERT( \
    INTERP_GRID, yac_interp_grid_get_num_src_fields(INTERP_GRID) != 0, \
    "Number of source fields is 0.")
 
#define CHECK_SRC_FIELD_COUNT_SINGLE(INTERP_GRID) \
  CHECK_INTERP_GRID_HAS_SRC_FIELDS(INTERP_GRID) \
  YAC_INTERP_GRID_FIELD_ASSERT_F( \
    INTERP_GRID, yac_interp_grid_get_num_src_fields(INTERP_GRID) == 1, \
    "Invalid number of source fields. Got %zu, expected 1.", \
    yac_interp_grid_get_num_src_fields(INTERP_GRID))
 
#define CHECK_SRC_FIELD_LOCATION_CORNER_OR_CELL(INTERP_GRID) \
  CHECK_INTERP_GRID_HAS_SRC_FIELDS(INTERP_GRID) \
  YAC_INTERP_GRID_FIELD_ASSERT( \
    INTERP_GRID, \
    (yac_interp_grid_get_src_field_location(INTERP_GRID, 0) == YAC_LOC_CORNER) || \
    (yac_interp_grid_get_src_field_location(INTERP_GRID, 0) == YAC_LOC_CELL), \
    "This interpolation method only supports source fields defined as CORNER or CELL")
 
#define CHECK_SRC_FIELD_LOCATION_CELL(INTERP_GRID) \
  CHECK_INTERP_GRID_HAS_SRC_FIELDS(INTERP_GRID) \
  YAC_INTERP_GRID_FIELD_ASSERT( \
    INTERP_GRID, \
    yac_interp_grid_get_src_field_location(INTERP_GRID, 0) == YAC_LOC_CELL, \
    "This interpolation method only supports source fields defined as CELL")
 
#define CHECK_TGT_FIELD_LOCATION_CELL(INTERP_GRID) \
  YAC_INTERP_GRID_FIELD_ASSERT( \
    INTERP_GRID, \
    yac_interp_grid_get_tgt_field_location(INTERP_GRID) == YAC_LOC_CELL, \
    "This interpolation method only supports target fields defined as CELL")
 
#endif // INTERP_METHOD_UTILS_H