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 "interpolation/methods/interp_method.h"
#include "point_selection.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_interp_spmap_config;
struct yac_spmap_overwrite_config;
struct yac_spmap_scale_config;
struct yac_spmap_cell_area_config;
 
#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 (NULL)
#define YAC_INTERP_SPMAP_SCALE_CONFIG_DEFAULT (NULL)
#define YAC_INTERP_SPMAP_DEFAULT_CONFIG (NULL)
#define YAC_INTERP_SPMAP_OVERWRITE_DEFAULT (NULL)
 
struct interp_method * yac_interp_method_spmap_new(
  struct yac_interp_spmap_config const * default_config,
  struct yac_spmap_overwrite_config const * const * overwrite_configs);
 
struct yac_interp_spmap_config * yac_interp_spmap_config_new(
  double spread_distance, double max_search_distance,
  enum yac_interp_spmap_weight_type weight_type,
  struct yac_spmap_scale_config const * scale_config);
 
void yac_interp_spmap_config_delete(
  struct yac_interp_spmap_config * spmap_config);
 
double yac_interp_spmap_config_get_spread_distance(
  struct yac_interp_spmap_config const * spmap_config);
 
double yac_interp_spmap_config_get_max_search_distance(
  struct yac_interp_spmap_config const * spmap_config);
 
enum yac_interp_spmap_weight_type yac_interp_spmap_config_get_weight_type(
  struct yac_interp_spmap_config const * spmap_config);
 
struct yac_spmap_scale_config const * yac_interp_spmap_config_get_scale_config(
  struct yac_interp_spmap_config const * spmap_config);
 
struct yac_spmap_scale_config * yac_spmap_scale_config_new(
  enum yac_interp_spmap_scale_type scale_type,
  struct yac_spmap_cell_area_config const * source_cell_area_config,
  struct yac_spmap_cell_area_config const * target_cell_area_config);
 
void yac_spmap_scale_config_delete(
  struct yac_spmap_scale_config * scale_config);
 
enum yac_interp_spmap_scale_type yac_spmap_scale_config_get_type(
  struct yac_spmap_scale_config const * scale_config);
 
struct yac_spmap_cell_area_config const *
  yac_spmap_scale_config_get_src_cell_area_config(
    struct yac_spmap_scale_config const * scale_config);
 
struct yac_spmap_cell_area_config const *
  yac_spmap_scale_config_get_tgt_cell_area_config(
    struct yac_spmap_scale_config const * scale_config);
 
struct yac_spmap_cell_area_config * yac_spmap_cell_area_config_yac_new(
  double sphere_radius);
 
struct yac_spmap_cell_area_config * yac_spmap_cell_area_config_file_new(
  char const * filename, char const * varname, yac_int min_global_id);
 
void yac_spmap_cell_area_config_delete(
  struct yac_spmap_cell_area_config * cell_area_config);
 
enum yac_interp_spmap_cell_area_provider yac_spmap_cell_area_config_get_type(
  struct yac_spmap_cell_area_config const * cell_area_config);
 
double yac_spmap_cell_area_config_get_sphere_radius(
  struct yac_spmap_cell_area_config const * cell_area_config);
 
char const * yac_spmap_cell_area_config_get_filename(
  struct yac_spmap_cell_area_config const * cell_area_config);
 
char const * yac_spmap_cell_area_config_get_varname(
  struct yac_spmap_cell_area_config const * cell_area_config);
 
yac_int yac_spmap_cell_area_config_get_min_global_id(
  struct yac_spmap_cell_area_config const * cell_area_config);
 
struct yac_spmap_overwrite_config * yac_spmap_overwrite_config_new(
  struct yac_point_selection const * src_point_selection,
  struct yac_interp_spmap_config const * config);
 
void yac_spmap_overwrite_config_delete(
  struct yac_spmap_overwrite_config * overwrite_config);
 
void yac_spmap_overwrite_configs_delete(
  struct yac_spmap_overwrite_config ** overwrite_configs);
 
struct yac_point_selection const *
  yac_spmap_overwrite_config_get_src_point_selection(
    struct yac_spmap_overwrite_config const * overwrite_config);
 
struct yac_interp_spmap_config const *
  yac_spmap_overwrite_config_get_spmap_config(
    struct yac_spmap_overwrite_config const * overwrite_config);
 
// YAC PUBLIC HEADER STOP
 
//------------------------------------------------------------------------------
// some utility rouines for datatypes associated with spmap
//------------------------------------------------------------------------------
 
struct yac_interp_spmap_config * yac_interp_spmap_config_copy(
  struct yac_interp_spmap_config const * spmap_config);
struct yac_spmap_overwrite_config ** yac_spmap_overwrite_configs_copy(
  struct yac_spmap_overwrite_config const * const * overwrite_configs);
 
int yac_interp_spmap_config_compare(
  struct yac_interp_spmap_config const * a,
  struct yac_interp_spmap_config const * b);
int yac_spmap_overwrite_config_compare(
  struct yac_spmap_overwrite_config const * a,
  struct yac_spmap_overwrite_config const * b);
size_t yac_interp_spmap_config_get_pack_size(
  struct yac_interp_spmap_config const * spmap_config, MPI_Comm comm);
size_t  yac_spmap_overwrite_configs_get_pack_size(
  struct yac_spmap_overwrite_config const * const * overwrite_configs,
  MPI_Comm comm);
void yac_interp_spmap_config_pack(
  struct yac_interp_spmap_config const * spmap_config,
  void * buffer, int buffer_size, int * position, MPI_Comm comm);
void yac_spmap_overwrite_configs_pack(
  struct yac_spmap_overwrite_config const * const * overwrite_configs,
  void * buffer, int buffer_size, int * position, MPI_Comm comm);
void yac_interp_spmap_config_unpack(
  void * buffer, int buffer_size, int * position,
  struct yac_interp_spmap_config ** spmap_config, MPI_Comm comm);
void yac_spmap_overwrite_configs_unpack(
  void * buffer, int buffer_size, int * position,
  struct yac_spmap_overwrite_config *** overwrite_configs, MPI_Comm comm);
 
#endif // INTERP_METHOD_SPMAP_H