vswf.h

Go to the documentation of this file.

 
#ifndef QPMS_VSWF_H
#define QPMS_VSWF_H
#include <unistd.h> // ssize_t 
#include "qpms_types.h"
#include <gsl/gsl_sf_legendre.h>
 
// -------------- Typedefs (function prototypes) for qpms_vswf_spec_t ----------------------
 
typedef qpms_errno_t (*qpms_incfield_t)(
        complex double *target,
        const qpms_vswf_set_spec_t *bspec,
        const cart3_t evalpoint, 
        const void *args, 
        bool add 
);
 
// ---------------Methods for qpms_vswf_set_spec_t-----------------------
//
qpms_vswf_set_spec_t *qpms_vswf_set_spec_init(void);
qpms_errno_t qpms_vswf_set_spec_append(qpms_vswf_set_spec_t *self, qpms_uvswfi_t u);
void qpms_vswf_set_spec_free(qpms_vswf_set_spec_t *);
 
bool qpms_vswf_set_spec_isidentical(const qpms_vswf_set_spec_t *a,
        const qpms_vswf_set_spec_t *b);
qpms_vswf_set_spec_t *qpms_vswf_set_spec_copy(const qpms_vswf_set_spec_t *orig);
qpms_vswf_set_spec_t *qpms_vswf_set_spec_from_lMax(qpms_l_t lMax,
        qpms_normalisation_t norm);
 
 
// TODO more consistency in types (here size_t vs. ptrdiff_t).
static inline ssize_t qpms_vswf_set_spec_find_uvswfi(const qpms_vswf_set_spec_t *bspec,
        const qpms_uvswfi_t index) {
    for(size_t i = 0; i < bspec->n; ++i) 
        if (bspec->ilist[i] == index)
            return i;
    return -1;
}
 
 
size_t *qpms_vswf_set_reindex(const qpms_vswf_set_spec_t *small, const qpms_vswf_set_spec_t *big);
 
 
 
qpms_errno_t qpms_uvswf_fill(
        csphvec_t *const target, 
        const qpms_vswf_set_spec_t *setspec,
        csph_t kr, 
            qpms_bessel_t btyp);
 
 
csphvec_t qpms_eval_uvswf(const qpms_vswf_set_spec_t *setspec,
        const complex double *coeffs, 
        csph_t kr, 
        qpms_bessel_t btyp);
 
 
// --- qpms_incfield_t instances and their arguments
 
typedef struct qpms_incfield_planewave_params_t {
    bool use_cartesian; 
    union {
        ccart3_t cart;
        csph_t sph;
    } k; 
    union {
        ccart3_t cart;
        csphvec_t sph;
    } E; 
} qpms_incfield_planewave_params_t;
    
 
 
qpms_errno_t qpms_incfield_planewave(
        complex double *target,
        const qpms_vswf_set_spec_t *bspec,
        const cart3_t evalpoint, 
        const void *args, 
        bool add 
);
 
// -----------------------------------------------------------------------
 
csphvec_t qpms_vswf_single_el(qpms_m_t m, qpms_l_t n, sph_t kdlj,
        qpms_bessel_t btyp, qpms_normalisation_t norm);
csphvec_t qpms_vswf_single_mg(qpms_m_t m, qpms_l_t n, sph_t kdlj,
        qpms_bessel_t btyp, qpms_normalisation_t norm);
csphvec_t qpms_vswf_single_el_csph(qpms_m_t m, qpms_l_t n, csph_t kdlj,
        qpms_bessel_t btyp, qpms_normalisation_t norm);
csphvec_t qpms_vswf_single_mg_csph(qpms_m_t m, qpms_l_t n, csph_t kdlj,
        qpms_bessel_t btyp, qpms_normalisation_t norm);
 
 
typedef struct qpms_vswfset_sph_t {
    //qpms_normalisation_t norm;
    qpms_l_t lMax;
    //qpms_y_t nelem;
    //sph_t kdlj
    csphvec_t *el, *mg;
} qpms_vswfset_sph_t;
 
qpms_errno_t qpms_legendre_deriv_y_get(double **result, double **result_deriv, double x, qpms_l_t lMax, 
        gsl_sf_legendre_t lnorm, double csphase); // free() result and result_deriv yourself!
qpms_errno_t qpms_legendre_deriv_y_fill(double *where, double *where_deriv, double x, 
        qpms_l_t lMax, gsl_sf_legendre_t lnorm, double csphase); 
 
 
 
csphvec_t qpms_vswf_L00(
        csph_t kdrj, //< VSWF evaluation point.
        qpms_bessel_t btyp,
        qpms_normalisation_t norm //< Ignored!
        );
 
 
qpms_errno_t qpms_vswf_fill(
    csphvec_t *resultL, //< Target array for longitudinal VSWFs.
        csphvec_t *resultM, //< Target array for magnetic VSWFs.
        csphvec_t *resultN, //< Target array for electric VSWFs.
    qpms_l_t lMax, //< Maximum multipole degree to be calculated.
    sph_t kdrj, //< VSWF evaluation point.
    qpms_bessel_t btyp, qpms_normalisation_t norm);
 
// Should give the same results: for consistency checks
qpms_errno_t qpms_vswf_fill_alternative(csphvec_t *resultL, csphvec_t *resultM, csphvec_t *resultN, qpms_l_t lMax, sph_t kdrj,
        qpms_bessel_t btyp, qpms_normalisation_t norm);
 
 
qpms_errno_t qpms_vswf_fill_csph(
    csphvec_t *resultL, //< Target array for longitudinal VSWFs.
        csphvec_t *resultM, //< Target array for magnetic VSWFs.
        csphvec_t *resultN, //< Target array for electric VSWFs.
    qpms_l_t lMax, //< Maximum multipole degree to be calculated.
    csph_t kdrj, //< VSWF evaluation point.
    qpms_bessel_t btyp, qpms_normalisation_t norm);
 
 
qpms_errno_t qpms_vecspharm_fill(
        csphvec_t *const a1target, 
            csphvec_t *const a2target, 
            csphvec_t *const a3target, 
        qpms_l_t lMax, sph_t dir, qpms_normalisation_t norm);
qpms_errno_t qpms_vecspharm_dual_fill(csphvec_t *const a1target, csphvec_t *const a2target, csphvec_t *const a3target,
        qpms_l_t lMax, sph_t dir, qpms_normalisation_t norm);
 
qpms_errno_t qpms_planewave2vswf_fill_cart(cart3_t wavedir, ccart3_t amplitude,
        complex double *targt_longcoeff, complex double *target_mgcoeff, complex double *target_elcoeff,
        qpms_l_t lMax, qpms_normalisation_t norm);
qpms_errno_t qpms_planewave2vswf_fill_sph(sph_t wavedir, csphvec_t amplitude,
        complex double *targt_longcoeff, complex double *target_mgcoeff, complex double *target_elcoeff,
        qpms_l_t lMax, qpms_normalisation_t norm);
 
 
csphvec_t qpms_eval_vswf(sph_t where,
        complex double *longcoeffs, complex double *mgcoeffs, complex double *elcoeffs,
        qpms_l_t lMax, qpms_bessel_t btyp, qpms_normalisation_t norm);
 
csphvec_t qpms_eval_vswf_csph(csph_t where,
        complex double *longcoeffs, complex double *mgcoeffs, complex double *elcoeffs,
        qpms_l_t lMax, qpms_bessel_t btyp, qpms_normalisation_t norm);
 
qpms_vswfset_sph_t *qpms_vswfset_make(qpms_l_t lMax, sph_t kdlj,
        qpms_bessel_t btyp, qpms_normalisation_t norm);//NI
void qpms_vswfset_sph_pfree(qpms_vswfset_sph_t *);//NI
 
#endif // QPMS_VSWF_H