interp_method_spmap.h

Go to the documentation of this file.

// Copyright (c) 2024 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef INTERP_METHOD_SPMAP_H
#define INTERP_METHOD_SPMAP_H
 
#include "interp_method.h"
 
// YAC PUBLIC HEADER START
 
enum yac_interp_spmap_weight_type {
  YAC_INTERP_SPMAP_AVG  = 0, // simple average
  YAC_INTERP_SPMAP_DIST = 1, // distance weighted
};
 
enum yac_interp_spmap_scale_type {
  YAC_INTERP_SPMAP_NONE       = 0, 
  YAC_INTERP_SPMAP_SRCAREA    = 1, 
  YAC_INTERP_SPMAP_INVTGTAREA = 2, 
  YAC_INTERP_SPMAP_FRACAREA  = 3,  
};
 
enum yac_interp_spmap_cell_area_provider {
  YAC_INTERP_SPMAP_CELL_AREA_FILE = 0, // read cell areas from file
  YAC_INTERP_SPMAP_CELL_AREA_YAC  = 1, // YAC computes the cell areas
};
 
struct yac_spmap_scale_config {
  enum yac_interp_spmap_scale_type type;
  struct yac_spmap_cell_area_config {
    enum yac_interp_spmap_cell_area_provider cell_area_provider;
    double sphere_radius; // used for computing the cell areas
    struct yac_spmap_cell_area_file_config {
      char const * filename;
      char const * varname;
      yac_int min_global_id;
    } file_config;        // used for read the cell areas from file
  } src, tgt;
};
 
#define YAC_INTERP_SPMAP_SPREAD_DISTANCE_DEFAULT (0.0)
#define YAC_INTERP_SPMAP_MAX_SEARCH_DISTANCE_DEFAULT (0.0)
#define YAC_INTERP_SPMAP_WEIGHTED_DEFAULT (YAC_INTERP_SPMAP_AVG)
#define YAC_INTERP_SPMAP_SCALE_TYPE_DEFAULT (YAC_INTERP_SPMAP_NONE)
#define YAC_INTERP_SPMAP_SPHERE_RADIUS_DEFAULT (1.0)
#define YAC_INTERP_SPMAP_FILENAME_DEFAULT (NULL)
#define YAC_INTERP_SPMAP_VARNAME_DEFAULT (NULL)
#define YAC_INTERP_SPMAP_MIN_GLOBAL_ID_DEFAULT (0)
#define YAC_INTERP_SPMAP_CELL_AREA_CONFIG_DEFAULT \
  ((struct yac_spmap_cell_area_config) { \
     .cell_area_provider = YAC_INTERP_SPMAP_CELL_AREA_YAC, \
     .sphere_radius = YAC_INTERP_SPMAP_SPHERE_RADIUS_DEFAULT, \
     .file_config.filename = YAC_INTERP_SPMAP_FILENAME_DEFAULT, \
     .file_config.varname = YAC_INTERP_SPMAP_VARNAME_DEFAULT, \
     .file_config.min_global_id = YAC_INTERP_SPMAP_MIN_GLOBAL_ID_DEFAULT})
#define YAC_INTERP_SPMAP_SCALE_CONFIG_DEFAULT \
  ((struct yac_spmap_scale_config){ \
     .type = YAC_INTERP_SPMAP_SCALE_TYPE_DEFAULT, \
     .src = YAC_INTERP_SPMAP_CELL_AREA_CONFIG_DEFAULT, \
     .tgt = YAC_INTERP_SPMAP_CELL_AREA_CONFIG_DEFAULT})
 
struct interp_method * yac_interp_method_spmap_new(
  double spread_distance, double max_search_distance,
  enum yac_interp_spmap_weight_type weight_type,
  struct yac_spmap_scale_config scale_config);
 
// YAC PUBLIC HEADER STOP
 
#endif // INTERP_METHOD_SPMAP_H