electrode.h

Go to the documentation of this file.

/* High Performance implementation of the Hybrid Electromagnetic Model
Released under the General Public License 3 (GPLv3).
All parameters' units are in the SI base if omitted.

Routines to manipulate the Electrode struct and do the base calculations, i.e.,
numerical integration and impedances calculation. It also includes any routines
to build the linear system to be solved that do not depend on linear algebra
libraries.
*/
#ifndef ELECTRODE_H_
#define ELECTRODE_H_

#include <complex.h>
#include <stdlib.h>
#include <stdbool.h>

enum
Integration_type {
    INTG_NONE = 1,
    INTG_DOUBLE = 2,
    INTG_SINGLE = 3,
    INTG_MHEM = 4
};

typedef struct {
    double start_point[3];
    double end_point[3];
    double middle_point[3];
    double length;
    double radius;
} Electrode;

typedef struct {
    const Electrode* sender;
    const Electrode* receiver;
    _Complex double gamma;
} Integration_data;

typedef struct {
    const double* point1;
    const double* point2;
    const Electrode* electrodes;
    size_t num_electrodes;
    const _Complex double* il;
    const _Complex double* it;
    _Complex double gamma;
    _Complex double s;
    double mur;
    _Complex double kappa;
    size_t max_eval;
    double req_abs_error;
    double req_rel_error;
} Field_integrand_data;


int
populate_electrode (Electrode *electrode, const double start_point[3],
                    const double end_point[3], double radius);

bool
equal_electrodes (const Electrode *sender, const Electrode *receiver);

int
electrodes_file (const char file_name[], Electrode *electrodes, size_t num_electrodes);

int
nodes_file (const char file_name[], double *nodes, size_t num_nodes);

int
segment_electrode (Electrode *electrodes, double *nodes, size_t num_segments,
                   const double *start_point, const double *end_point, double radius);

size_t
nodes_from_elecs (double *nodes, Electrode *electrodes, size_t num_electrodes);

int
integrand_double (unsigned ndim, const double *t, void *auxdata, unsigned fdim,
                  double *fval);

int
integrand_single (unsigned ndim, const double *t, void *auxdata, unsigned fdim,
                  double *fval);

int
logNf (unsigned ndim, const double *t, void *auxdata, unsigned fdim, double *fval);

_Complex double
self_integral (const Electrode *sender);

int
integral (const Electrode *sender, const Electrode *receiver, _Complex double gamma,
          size_t max_eval, double req_abs_error, double req_rel_error,
          int integration_type, double result[2], double error[2]);

int
calculate_impedances (_Complex double *zl, _Complex double *zt,
                      const Electrode *electrodes, size_t num_electrodes,
                      _Complex double gamma, _Complex double s, double mur,
                      _Complex double kappa, size_t max_eval, double req_abs_error,
                      double req_rel_error, int integration_type);

int
impedances_images (_Complex double *zl, _Complex double *zt,
                   const Electrode *electrodes, const Electrode *images,
                   size_t num_electrodes, _Complex double gamma,
                   _Complex double s, double mur, _Complex double kappa,
                   _Complex double ref_l, _Complex double ref_t,
                   size_t max_eval, double req_abs_error, double req_rel_error,
                   int integration_type);

_Complex double
electric_potential (const double *point, const Electrode *electrodes,
                    size_t num_electrodes, const _Complex double *it,
                    _Complex double gamma, _Complex double kappa,
                    size_t max_eval, double req_abs_error, double req_rel_error);

int
magnetic_potential (const double *point, const Electrode *electrodes,
                    size_t num_electrodes, const _Complex double *il,
                    _Complex double gamma, double mur, size_t max_eval,
                    double req_abs_error, double req_rel_error,
                    _Complex double *va);

int
elec_field_integrand (unsigned ndim, const double *t, void *auxdata,
                      unsigned fdim, double *fval);

int
electric_field (const double *point, const Electrode *electrodes,
                size_t num_electrodes, const _Complex double *il,
                const _Complex double *it, _Complex double gamma,
                _Complex double s, double mur, _Complex double kappa,
                size_t max_eval, double req_abs_error, double req_rel_error,
                _Complex double *ve);

int
v_mag_pot_integrand (unsigned ndim, const double *t, void *auxdata, unsigned fdim,
                     double *fval);

_Complex double
voltage (const double *point1, const double *point2,
         const Electrode *electrodes, size_t num_electrodes,
         const _Complex double *il, const _Complex double *it,
         _Complex double gamma, _Complex double s, double mur,
         _Complex double kappa, size_t max_eval, double req_abs_error,
         double req_rel_error);

#endif /* ELECTRODE_H_ */