crock.h

Go to the documentation of this file.

#ifndef ROCK_CROCK_H
#define ROCK_CROCK_H
 
#include "types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#if defined(_MSC_VER)
#ifdef BUILD_CROCK_DLL
#define CROCK_API __declspec(dllexport)
#else
#define CROCK_API __declspec(dllimport)
#endif
#elif defined(__GNUC__)
#define CROCK_API __attribute__((__visibility__("default")))
#endif
 
#ifdef CROCK_SUPPRESS_API
#undef CROCK_API
#endif
 
#ifndef CROCK_API
#define CROCK_API
#endif
#ifdef __GNUC__
#define ROCK_MALLOC __attribute__((__malloc__))
#define ROCK_PURE __attribute__((__pure__))
#define ROCK_CONST __attribute__((__const__))
#define ROCK_NODISCARD __attribute__((__warn_unused_result__))
#define ROCK_UNUSED __attribute__((__unused__))
#else
#define ROCK_MALLOC
#define ROCK_PURE
#define ROCK_CONST
#define ROCK_NODISCARD
#define ROCK_UNUSED
#endif

#define ROCK_MASK_BLT_VAR_UZ 0x00000001
#define ROCK_MASK_BLT_TAYLOR 0x00000002
#define ROCK_MASK_BLT_CALI_CYC_PHASE 0x00000004
#define ROCK_MASK_BLT_CALI_GC_AZI 0x00000008
#define ROCK_MASK_BLT_CALI_GC_R 0x00000010
#define ROCK_MASK_BLT_B_RF_PERP 0x00000020
#define ROCK_MASK_BLT_DOPPLER ROCK_MASK_BLT_B_RF_PERP
#define ROCK_MASK_BLT_TREAT_BEAM_INIT_AS_RAW_IMPORT 0x00010000
#define ROCK_MASK_BLT_SRC_MONOHARM 0x40000000
#define ROCK_MASK_BLT_MONOGC 0x80000000
#define ROCK_MASK_BLT_DEBUG ROCK_MASK_BLT_MONOGC

#define ROCK_MASK_BLT_ALL_FEATURES                                             \
    (ROCK_MASK_BLT_VAR_UZ | ROCK_MASK_BLT_TAYLOR                               \
     | ROCK_MASK_BLT_CALI_CYC_PHASE | ROCK_MASK_BLT_CALI_GC_AZI                \
     | ROCK_MASK_BLT_CALI_GC_R | ROCK_MASK_BLT_B_RF_PERP)

#define ROCK_FOREACH(X) for (size_t i##X = 0; i##X < (dim_##X); ++i##X)

#define ROCK_FOREACH_1(X) for (size_t i##X = 1; i##X < (dim_##X); ++i##X)

#define ROCK_IF_RETURN(IF_VAL, RET_VAL)                                        \
    do {                                                                       \
        if (IF_VAL)                                                            \
            return RET_VAL;                                                    \
    } while (0)

CROCK_API
int cr_numa_bless(
    void *restrict buf,
    size_t sizeof_type,
    size_t dim_shape,
    const size_t *restrict shape
);

#define CR_NUMA_BLESS(type, buf, ...)                                          \
    cr_numa_bless(                                                             \
        (buf), (size_t)sizeof(type),                                           \
        (size_t)(sizeof((size_t[]){__VA_ARGS__}) / sizeof(size_t)),            \
        (size_t[]){__VA_ARGS__}                                                \
    )

struct cr_cache {
    void (*free)(struct cr_cache *self);
};
 
CROCK_API
ROCK_CONST
ROCK_NODISCARD
int cr_version_major(void);
 
CROCK_API
ROCK_CONST
ROCK_NODISCARD
int cr_version_minor(void);
 
CROCK_API
ROCK_CONST
ROCK_NODISCARD
int cr_version_patch(void);

CROCK_API
ROCK_PURE
ROCK_NODISCARD
const char *cr_errmsg(int err);

CROCK_API
ROCK_PURE
ROCK_NODISCARD
size_t cr_stride_real(size_t dim);

CROCK_API
ROCK_PURE
ROCK_NODISCARD
size_t cr_stride_cplx(size_t dim);

CROCK_API
int cr_make_mode_holl(
    size_t dim_m,
    const int16_t *restrict vm_num,
    size_t dim_z,
    const real *restrict vn_geo_rout,
    real *restrict mvn_mod
);

CROCK_API
int cr_make_mode_coax(
    size_t dim_m,
    const int16_t *restrict vm_num,
    size_t dim_z,
    const real *restrict vn_geo_rout,
    const real *restrict vn_geo_rin,
    real *restrict mvn_mod
);

CROCK_API
int cr_make_mode_corr_ins(
    size_t dim_m,
    const int16_t *restrict vm_num,
    size_t dim_z,
    const real *restrict vn_geo_rout,
    const real *restrict vn_geo_rin,
    const real *restrict vn_geo_rel_w,
    const real *restrict vn_geo_depth,
    real *restrict mvn_mod
);

CROCK_API
int cr_make_mode_corr_holl_imp(
    size_t dim_m,
    const int16_t *restrict vm_num,
    size_t dim_z,
    const real *restrict vn_geo_rout,
    const real *restrict vn_geo_rel_w,
    const real *restrict vn_geo_depth,
    real *restrict mvn_mod
);

CROCK_API
int cr_deprecated_search_cold_resonance(
    const real *restrict opt_ptr_ref_z,
    size_t dim_m,
    size_t dim_z,
    const real *restrict vn_z,
    const real *restrict mvn_mod,
    cplx *restrict vm_freq
);

CROCK_API
int cr_find_cold_resonance(
    size_t dim_m,
    const real *restrict opt_vm_freq_init,
    size_t dim_z,
    size_t opt_iz_min_fcut,
    const real *restrict vn_z,
    const real *restrict mvn_mod,
    const real *restrict tdm_c,
    const real *restrict mv_tdm_zk,
    cplx *restrict vm_cfreq
);

CROCK_API
int cr_find_all_cold_resonances(
    size_t dim_z,
    size_t opt_iz_min_fcut,
    const real *restrict vn_z,
    const real *restrict vn_mod,
    const real *restrict tdm_c,
    const real *restrict tdm_zk,
    size_t dim_freq,
    size_t *restrict out_dim_freq,
    cplx *restrict out_cfreq
);

CROCK_API
int cr_make_cold_envelope(
    size_t dim_m,
    const cplx *restrict vm_rfc,
    size_t dim_z,
    const real *restrict vn_z,
    const real *restrict mvn_mod,
    cplx *restrict mvn_env
);

CROCK_API
ROCK_PURE
ROCK_NODISCARD
size_t cr_guess_dim_cold_spectrum(
    size_t dim_z, const real *restrict vn_z, const real *restrict vn_mod
);

CROCK_API
int cr_deprecated_make_cold_spectrum(
    size_t dim_z,
    const real *restrict vn_z,
    const real *restrict vn_mod,
    size_t dim_freq,
    real *restrict freq,
    real *restrict ampl
);

CROCK_API
int cr_make_cold_spectrum(
    int max_iter,
    size_t dim_z,
    const real *restrict vn_z,
    const real *restrict vn_mod,
    const real *restrict tdm_c,
    const real *restrict tdm_zk,
    size_t dim_freq,
    real *restrict freq,
    real *restrict ampl
);

CROCK_API
int cr_make_fem(
    size_t dim_m,
    size_t dim_z,
    const real *restrict vn_z,
    const real *restrict mvn_mod,
    real *restrict tdm_c,
    real *restrict mv_tdm_zk
);

CROCK_API
int cr_step_field(
    real dt,
    size_t dim_m,
    const real *restrict vm_cf,
    const cplx *restrict vm_bc,
    size_t dim_z,
    const real *restrict tdm_c,
    const real *restrict mv_tdm_zk,
    const cplx *restrict mvn_src,
    cplx *restrict vm_bd,
    cplx *restrict mvn_env,
    real *restrict opt_vm_cp,
    real *restrict opt_vm_df,
    struct cr_cache *restrict *restrict opt_pp_cache
);

CROCK_API
void cr_make_bc_simple(
    size_t dim_m,
    const real *restrict vm_freq,
    size_t dim_z,
    const real *restrict mvn_mod,
    cplx *restrict vm_bc
);

CROCK_API
void cr_init_bp(
    size_t dim_m,
    size_t dim_z,
    const cplx *restrict mvn_env,
    real *restrict vm_bp
);

CROCK_API
void cr_update_bc_simple(
    real dt,
    size_t dim_m,
    const real *restrict vm_cf,
    size_t dim_z,
    const real *restrict mvn_mod,
    const cplx *restrict mvn_env,
    real *restrict vm_bp,
    cplx *restrict vm_bc
);

CROCK_API
void cr_init_bd(
    size_t dim_m,
    const cplx *restrict vm_bc,
    size_t dim_z,
    const cplx *restrict mvn_env,
    cplx *restrict vm_bd
);
 
CROCK_API ROCK_MALLOC void *cr_malloc(size_t size);
CROCK_API void cr_free(void *ptr);

CROCK_API
void cr_make_potential(
    real pot_outer,
    real opt_pot_inner,
    const real *restrict beam_init,
    size_t dim_z,
    const real *restrict vn_mag_axis,
    const real *restrict vn_rhocd,
    const real *restrict vn_r_outer,
    const real *restrict opt_vn_r_inner,
    real *restrict vn_pot
);

CROCK_API
int cr_make_bcc(
    real r_center,
    real r_span,
    size_t dim_m,
    const int16_t *restrict vm_num,
    size_t dim_z,
    const real *restrict vn_mag_axis,
    const real *restrict mvn_mod,
    size_t dim_bcc,
    real *restrict nvmh_bcc
);

CROCK_API
int cr_shoot_beamlet(
    uint32_t options,
    const real *restrict beam_init,
    size_t dim_m,
    const int16_t *restrict vm_num,
    const real *restrict vm_cf,
    const real *restrict vm_cp,
    size_t dim_z,
    const real *restrict vn_z,
    const real *restrict vn_pot,
    const real *restrict vn_mag_axis,
    const real *restrict mvn_mod,
    const cplx *restrict mvn_env,
    size_t dim_b,
    size_t dim_bcc,
    real bcc_r_center,
    real bcc_r_span,
    const real *restrict nvmh_bcc,
    uint32_t *seed,
    real *restrict vn_rhocd,
    cplx *restrict mvn_src,
    real *restrict opt_vn_mrs,
    real *restrict opt_vn_blt_avg,
    real *restrict opt_bvn_blt_trj,
    struct cr_cache *restrict *restrict opt_pp_cache
);

CROCK_API
void cr_make_power_out(
    size_t dim_m,
    const real *restrict vm_cf,
    size_t dim_z,
    const real *restrict mvn_mod,
    const cplx *restrict mvn_env,
    real *restrict opt_vm_pout_left,
    real *restrict opt_vm_pout_right
);

CROCK_API
real cr_make_chi_TE_corr_ins(
    real r,
    real d,
    real w,
    int16_t num_azi,
    int16_t num_rad,
    real *restrict opt_array_chi
);

CROCK_API
real cr_make_chi_TE_corr_holl_imp(
    real d,
    real w,
    int16_t num_azi,
    int16_t num_rad,
    real *restrict opt_array_chi
);

CROCK_API
void cr_make_uload(
    size_t dim_m,
    size_t dim_z,
    const cplx *restrict mvn_env,
    const real *restrict mvn_uuload,
    real *restrict vn_uload
);

CROCK_API
void cr_make_uuload(
    size_t dim_m,
    const int16_t *restrict vm_num,
    const real *restrict vm_freq,
    size_t dim_z,
    const real *restrict vn_radius,
    const real *restrict mvn_mod,
    real *restrict mvn_uuload
);

CROCK_API
int cr_tdm_solve(
    size_t systems,
    size_t rows,
    const cplx *restrict multi_mat,
    const cplx *restrict multi_vec,
    cplx *restrict multi_x
);

CROCK_API
void cr_make_df(
    real elapsed_time,
    size_t dim_m,
    size_t dim_z,
    const cplx *restrict mvn_new_env,
    real *restrict mvn_old_env_phase,
    real *restrict vm_df
);

CROCK_API
int cr_refine_z(
    real weight,
    size_t dim_z,
    const real *restrict vn_z,
    const real *restrict vn_mrs,
    size_t dim_z_new,
    real *restrict vn_z_new
);

CROCK_API
int cr_tdm_solve_offload(
    size_t systems,
    size_t rows,
    const cplx *restrict multi_mat,
    const cplx *restrict multi_vec,
    cplx *restrict multi_x
);

CROCK_API
int cr_step_field_gpu(
    real dt,
    size_t dim_m,
    const real *restrict vm_cf,
    const cplx *restrict vm_bc,
    size_t dim_z,
    const real *restrict tdm_c,
    const real *restrict mv_tdm_zk,
    const cplx *restrict mvn_src,
    cplx *restrict vm_bd,
    cplx *restrict mvn_env,
    real *restrict opt_vm_cp,
    real *restrict opt_vm_df,
    struct cr_cache *restrict *restrict opt_pp_cache
);

CROCK_API
int cr_step_field_offload(
    real dt,
    size_t dim_m,
    const real *restrict vm_cf,
    const cplx *restrict vm_bc,
    size_t dim_z,
    const real *restrict tdm_c,
    const real *restrict mv_tdm_zk,
    const cplx *restrict mvn_src,
    cplx *restrict vm_bd,
    cplx *restrict mvn_env,
    real *restrict opt_vm_cp,
    real *restrict opt_vm_df,
    struct cr_cache *restrict *restrict opt_pp_cache
);
 
#ifdef __cplusplus
}
#endif
 
#endif