CHarm (C API)#
This chapter documents the C interface.
CHarm is divided into several modules, comprising functions
with conceptually similar tasks, such as spherical harmonic analysis or
spherical harmonic synthesis. Each module has its own subdirectory inside the
src
directory, where the source files are stored.
Next follows the documentation of the CHarm modules in double precision. There are only a few easy-to-remember systematic differences in CHarm’s API when working in single or quadruple precision, so separate documentations are omitted. The list of the differences is given in CHarm in single and quadruple precision.
- charm_shc
CHARM_SHC_NMAX_MODEL
CHARM_SHC_NMAX_ERROR
charm_shc_malloc()
charm_shc_calloc()
charm_shc_init()
charm_shc_free()
charm_shc_read_bin()
charm_shc_read_gfc()
charm_shc_read_tbl()
charm_shc_read_dov()
charm_shc_read_mtx()
charm_shc_write_bin()
charm_shc_write_tbl()
charm_shc_write_dov()
charm_shc_write_mtx()
charm_shc_dv()
charm_shc_da()
charm_shc_ddv()
charm_shc_dda()
charm_shc_rescale()
@4
charm_shc
- charm_crd
charm_crd_point_malloc()
charm_crd_point_calloc()
charm_crd_point_init()
charm_crd_point_free()
charm_crd_point_gl()
charm_crd_point_gl_shape()
charm_crd_point_dh1()
charm_crd_point_dh1_shape()
charm_crd_point_dh2()
charm_crd_point_dh2_shape()
charm_crd_cell_malloc()
charm_crd_cell_calloc()
charm_crd_cell_init()
charm_crd_cell_free()
@0
charm_point
charm_cell
- charm_shs
- charm_sha
- charm_gfm
CHARM_GFM_Q00
CHARM_GFM_Q10
CHARM_GFM_Q11
CHARM_GFM_Q20
CHARM_GFM_Q21
CHARM_GFM_Q22
CHARM_GFM_NEAR_ZONE
CHARM_GFM_FAR_ZONE
charm_gfm_global_density_3d()
charm_gfm_global_density_lateral()
charm_gfm_global_density_const()
charm_gfm_cap_density_3d()
charm_gfm_cap_density_lateral()
charm_gfm_cap_density_const()
charm_gfm_cap_q()
charm_gfm_cap_nq()
charm_gfm_cap_q_check_prec()
- charm_leg
- charm_integ
- charm_misc
CHARM_VERSION_MAJOR
CHARM_VERSION_MINOR
CHARM_VERSION_PATCH
CHARM_VERSION_STRING
CHARM_MIN
CHARM_MAX
charm_misc_get_version()
charm_misc_print_info()
charm_misc_buildopt_precision()
charm_misc_buildopt_simd()
charm_misc_buildopt_simd_vector_size()
charm_misc_buildopt_omp_charm()
charm_misc_buildopt_omp_fftw()
charm_misc_buildopt_mpi()
charm_misc_buildopt_mpfr()
charm_misc_buildopt_version_fftw()
charm_misc_buildopt_version_mpi()
charm_misc_buildopt_version_mpfr()
charm_misc_buildopt_version_gmp()
charm_misc_buildopt_isfinite()
- charm_err
- charm_mpi
- charm_glob
- charm