curvature.h

Go to the documentation of this file.

#ifndef _LOSC_INCLUDE_C_LOSC_CURVATURE_H_
#define _LOSC_INCLUDE_C_LOSC_CURVATURE_H_

#include <c_losc/matrix.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

//**********************************************
// ==> Interface for `losc::DFAInfo`
//**********************************************

typedef struct LoscDFAInfo LoscDFAInfo;

LoscDFAInfo *losc_dfa_info_create(double gga_x, double hf_x, const char *name);

#define losc_dfa_info_free(ptr) _losc_DFAInfo_free(&(ptr))
void _losc_dfa_info_free(LoscDFAInfo **pptr_m);

//**********************************************
// ==> Interface for `losc::CurvatureBase`
//**********************************************

// The incomplete struct in C-side that is `losc::CurvatureBase` in C++ side.
typedef struct _LoscCurvatureBase _LoscCurvatureBase;

typedef struct LoscCurvatureBase {
    // points to a real `losc::CurvatureBase` object.
    _LoscCurvatureBase *_p_base;

    // List interface of methods exposed to C users bellow.

    size_t (*nlo)(const LoscCurvatureBase *self);

    size_t (*nfitbasis)(const LoscCurvatureBase *self);

    size_t (*npts)(const LoscCurvatureBase *self);

    void (*kappa)(const LoscCurvatureBase *self, losc_matrix *K);
} LoscCurvatureBase;

//**********************************************
// ==> Interface for `losc::CurvatureV1`
//**********************************************

// The incomplete struct in C-side that is `losc::CurvatureV1` in C++-side.
typedef struct _LoscCurvatureV1 _LoscCurvatureV1;

typedef struct LoscCurvatureV1 {
    // points to a real `losc::CurvatureV1` object.
    _LoscCurvatureV1 *_p_v1;

    LoscCurvatureBase *p_base;

    // Note:
    // If `losc::CurvatureV1` has new public functions (new functions added in
    // `losc::CurvatureV1` not in its base class) in the future, add the
    // corresponding C interface with new function pointers below.

    void (*set_tau)(const LoscCurvatureV1 *self, double tau);
} LoscCurvatureV1;

LoscCurvatureV1 *losc_curvature_v1_create(const LoscDFAInfo *dfa,
                                          const losc_matrix *df_pii,
                                          const losc_matrix *df_Vpq_inv,
                                          const losc_matrix *grid_lo,
                                          const double *grid_weight);

#define losc_curvature_v1_free(ptr) _losc_curvature_v1_free(&(ptr))
void *_losc_curvature_v1_free(LoscCurvatureV1 **pptr_self);

//**********************************************
// ==> Interface for `losc::CurvatureV1`
//**********************************************

// The incomplete struct in C-side that is `losc::CurvatureV2` in C++-side.
typedef struct _LoscCurvatureV2 _LoscCurvatureV2;

typedef struct LoscCurvatureV2 {
    // points to a real `losc::CurvatureV2` object.
    _LoscCurvatureV2 *_p_v2;

    LoscCurvatureBase *p_base;

    // Note
    // If `losc::CurvatureV2` has new public functions (new functions added in
    // `losc::CurvatureV2` not in its base class) in the future, add the
    // corresponding C interface with new function pointers below.

    void (*set_tau)(const LoscCurvatureV2 *self, double tau);

    void (*set_zeta)(const LoscCurvatureV2 *self, double zeta);
} LoscCurvatureV2;

LoscCurvatureV2 *losc_curvature_v2_create(const LoscDFAInfo *dfa,
                                          const losc_matrix *df_pii,
                                          const losc_matrix *df_Vpq_inv,
                                          const losc_matrix *grid_lo,
                                          const double *grid_weight);

#define losc_curvature_v2_free(ptr) _losc_curvature_v2_free(&(ptr))
void *_losc_curvature_v2_free(LoscCurvatureV2 **pptr_self);

#ifdef __cplusplus
}
#endif

#endif