File: nec_radiation_pattern.i

package info (click to toggle)
necpp 1.2.6%2Bcvs20070816-1.3
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 3,772 kB
  • ctags: 5,989
  • sloc: cpp: 30,761; ansic: 10,162; fortran: 8,339; python: 2,948; makefile: 189; sh: 1
file content (116 lines) | stat: -rw-r--r-- 3,323 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
%nodefault;
class nec_radiation_pattern
{
public:
	
	/*! Returns the frequency in Herz. */
	nec_float get_frequency();
	
	
	/*! Returns the associated ground object. */
	nec_ground get_ground();
	
	
	/*! Returns the radial distance in meters ( or the rho cylindrical coordinate in meters if the calculation mode chosen is mode 1 ). */
	nec_float get_range();
		
	
	/*! Returns the array of gains in dB used in the normalization process. */
	real_array get_gain();
	
	
	/*! Returns the array of vertical (or major axis, depending on the output format chosen) gains in dB. */
	real_array get_gain_vert();
	
	
	/*! Returns the array of horizontal (or minor axis, depending on the output format chosen) gains in dB*/
	real_array get_gain_horiz();
	
	
	/*! Returns the array of total gains in dB*/
	real_array get_gain_tot();
	
	
	/*! Returns the array of polarization axial ratios (no units). */
	real_array get_pol_axial_ratio();
	
	
	/*! Returns the array of polarization tilts in degrees. */
	real_array get_pol_tilt();
	
	
	/*! Returns the array of polarization sense indexes (no units). The relationship between the index and the actual sense is the following :
		0 : linear
		1 : right 
		2 : left
	*/
	int_array get_pol_sense_index();
	
	
	/*! Returns the array of complex theta-components of electric field E in Volt/meter. */
	complex_array get_e_theta();
	
	
	/*! Returns the array of complex phi-components of electric field E in Volt/meter. */
	complex_array get_e_phi();
	
	
	/*! Returns the array of complex radial-components of electric field E in Volt/meter - only available for the calculation mode 1. */
	complex_array get_e_r();
	
	
	/*! Returns the normalization factors in dB provided a normalization has been requested. */
	nec_float get_normalization_factor();
	
	
	/*! Returns the increment for theta in degrees (or for z in meters if the calculation mode chosen is mode 1 ). */
	nec_float get_delta_theta();
	
	
	/*! Returns the first value of theta in degrees (or of z in meters if the calculation mode chosen is mode 1 ). */
	nec_float get_theta_start();
	
	
	/*! Returns the increment for phi in degrees. */
	nec_float get_delta_phi();
	
	
	/*! Returns the first value of phi in degrees. */
	nec_float get_phi_start();
	
	
	/*! Returns the number of theta angles. */
	int get_ntheta() const;
	
	
	/*! Returns the number of phi angles. */
	int get_nphi() const;
	
	
	/*! Returns the array of average power gains in dB, provided its computation has been requested. */
	nec_float get_average_power_gain();
	
	
	/*! Returns the solid angle in steradians used in the averaging process, provided the computation of an average gain has been requested. */ 
	nec_float get_average_power_solid_angle();
	
	
	/*! Returns the flag (no units) which indicates the calculation mode chosen. */
	int get_ifar();
	
	
	/*! Returns the flag (no units) which indicates the target of the normalization process. */ 
	int get_rp_normalization();
	
	
	/*! Returns the flag (no units) which indicates the output format chosen. */
	int get_rp_output_format();
	
	
	/*! Returns the flag (no units) which indicates whether the average gain will be computed or not. */
	int get_rp_power_average();
	
	
	/*! Returns the flag (no units) which indicates the type of gain computed : power or directive gain. */
	int get_rp_ipd();
};