libnecpp.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004-2008,2015 by Tim Molteno                           *
 *   tim@molteno.net                                                       *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef __libnecpp__
#define __libnecpp__

#ifdef __cplusplus
class nec_context;
#else
struct nec_context;
typedef struct nec_context nec_context;
#endif


#ifdef __cplusplus
extern "C" {
#endif


nec_context* nec_create(void);

long nec_delete(nec_context* in_context);




long nec_wire(nec_context* in_context, int tag_id, int segment_count,
              double xw1, double yw1, double zw1,
              double xw2, double yw2, double zw2, 
              double rad, double rdel, double rrad);


long nec_sp_card(nec_context* in_context, int ns,
    double x1, double y1, double z1,
    double x2, double y2, double z2);

long nec_sc_card(nec_context* in_context, int i2,
    double x3, double y3, double z3,
    double x4, double y4, double z4);

long nec_gm_card(nec_context* in_context, int itsi, int nrpt,
                 double rox, double roy, double roz, double xs,
                 double ys, double zs, int its );

long nec_gx_card(nec_context* in_context, int i1, int i2);


long nec_geometry_complete(nec_context* in_context, int gpflag);




long nec_benchmark(void);

const char* nec_error_message(void);





long nec_medium_parameters(nec_context* in_context, double permittivity, double permeability);
  

long nec_gn_card(nec_context* in_context, int iperf, int nradl, double epse, double sig, double tmp3, double tmp4, double tmp5, double tmp6);

long nec_fr_card(nec_context* in_context, int in_ifrq, int in_nfrq, double in_freq_mhz, double in_del_freq);

long nec_ek_card(nec_context* in_context, int itmp1);


long nec_ld_card(nec_context* in_context, int ldtyp, int ldtag, int ldtagf, int ldtagt, double tmp1, double tmp2, double tmp3);


  long nec_ex_card(nec_context* in_context, int extype, int i2, int i3, int i4, double tmp1, double tmp2, double tmp3, double tmp4, double tmp5, double tmp6);

long nec_excitation_voltage(nec_context* in_context, int tag, int segment, double v_real, double v_imag);

long nec_excitation_current(nec_context* in_context, double x, double y, double z, double a, double beta, double moment);

long nec_excitation_planewave(nec_context* in_context, int n_theta, int n_phi, 
                              double theta, double phi, double eta, double dtheta, double dphi, double pol_ratio);

long nec_tl_card(nec_context* in_context, int itmp1, int itmp2, int itmp3, int itmp4, double tmp1, double tmp2, double tmp3, double tmp4, double tmp5, double tmp6);
long nec_nt_card(nec_context* in_context, int itmp1, int itmp2, int itmp3, int itmp4, double tmp1, double tmp2, double tmp3, double tmp4, double tmp5, double tmp6);

long nec_xq_card(nec_context* in_context, int itmp1);

long nec_gd_card(nec_context* in_context, double tmp1, double tmp2, double tmp3, double tmp4);





long nec_rp_card(nec_context* in_context,
    int calc_mode, int n_theta, int n_phi,
    int output_format, int normalization, int D, int A, 
    double theta0, double phi0, double delta_theta, double delta_phi,
    double radial_distance, double gain_norm);

long nec_pt_card(nec_context* in_context, int itmp1, int itmp2, int itmp3, int itmp4);

long nec_pq_card(nec_context* in_context, int itmp1, int itmp2, int itmp3, int itmp4);

long nec_kh_card(nec_context* in_context, double tmp1);
long nec_ne_card(nec_context* in_context, int itmp1, int itmp2, int itmp3, int itmp4, double tmp1, double tmp2, double tmp3, double tmp4, double tmp5, double tmp6);
long nec_nh_card(nec_context* in_context, int itmp1, int itmp2, int itmp3, int itmp4, double tmp1, double tmp2, double tmp3, double tmp4, double tmp5, double tmp6);


long nec_cp_card(nec_context* in_context, int itmp1, int itmp2, int itmp3, int itmp4);
long nec_pl_card(nec_context* in_context, char* ploutput_filename, int itmp1, int itmp2, int itmp3, int itmp4);





double nec_gain(nec_context* in_context, int freq_index, int theta_index, int phi_index);

double nec_gain_max(nec_context* in_context, int freq_index);

double nec_gain_min(nec_context* in_context, int freq_index);

double nec_gain_mean(nec_context* in_context, int freq_index);

double nec_gain_sd(nec_context* in_context, int freq_index);

double nec_gain_rhcp_max(nec_context* in_context, int freq_index);
double nec_gain_rhcp_min(nec_context* in_context, int freq_index);
double nec_gain_rhcp_mean(nec_context* in_context, int freq_index);
double nec_gain_rhcp_sd(nec_context* in_context, int freq_index);

double nec_gain_lhcp_max(nec_context* in_context, int freq_index);
double nec_gain_lhcp_min(nec_context* in_context, int freq_index);
double nec_gain_lhcp_mean(nec_context* in_context, int freq_index);
double nec_gain_lhcp_sd(nec_context* in_context, int freq_index);

double nec_impedance_real(nec_context* in_context, int freq_index);

double nec_impedance_imag(nec_context* in_context, int freq_index);


#ifdef __cplusplus
}
#endif


#endif /* __libnecpp__ */